From 7980bcc791a5bd34e7c68a48f41cca2c2478e1f9 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Sat, 29 Aug 2026 08:47:28 +0000 Subject: [PATCH 1/2] Update swagger.json --- yaml/server-api.json | 159230 +++++++++++++++------------------------- 1 file changed, 59617 insertions(+), 99613 deletions(-) diff --git a/yaml/server-api.json b/yaml/server-api.json index 15892717..1a9a9d83 100644 --- a/yaml/server-api.json +++ b/yaml/server-api.json @@ -1,272 +1,57 @@ { - "openapi": "3.0.4", + "openapi": "3.0.1", "info": { "title": "MI Server API", "version": "v1" }, "paths": { - "/v1alpha/accessControl": { - "get": { - "tags": [ - "Access Control" - ], - "summary": "Gets information about current access control.", - "operationId": "GetSlimAccessControlInfo", - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimAccessControlInfo" - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/accessControl/{database-key}": { - "get": { - "tags": [ - "Access Control" - ], - "summary": "Gets information about current access control for the given database.", - "operationId": "GetSlimDatabaseAccessControlInfo", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimDatabaseAccessControlInfo" - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/accessControl/user-capabilities": { - "get": { - "tags": [ - "Access Control" - ], - "summary": "Gets user capabilities for access control.", - "operationId": "GetAccessControlUserCapabilities", - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlUserCapabilities" - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/accessControl/{database-key}/user-capabilities": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-identity}:aggregations": { + "post": { "tags": [ - "Access Control" + "Aggregation" ], - "summary": "Gets user capabilities for access control for the given database.", - "operationId": "GetAccessControlDatabaseUserCapabilities", + "summary": "Runs an aggregation against the table.", + "operationId": "DatabaseAggregationForTableWithIdentity", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlDatabaseUserCapabilities" - } - } + "type": "string" } }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/databases/{database-key}/access-control-categories": { - "get": { - "tags": [ - "Access Control - Attribute-Based Categories" - ], - "summary": "Get all access control categories for the specified database.", - "operationId": "GetCategories", - "parameters": [ { - "name": "database-key", + "name": "table-identity", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "integer", + "format": "int32" } }, { - "name": "include", + "name": "mode", "in": "query", - "description": "Optionally include related data e.g. tableMappings in the response.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryInclude" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategoriesInfo" - }, - "examples": { - "Example 1": { - "summary": "Get all categories", - "description": "An example response for all access control categories without including tableMappings.", - "value": { - "categories": [ - { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" - }, - "name": "Ownership", - "guid": "830376aa-3e23-43c2-8b89-cee806d6c4d0" - }, - { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - ] - } - }, - "Example 2": { - "summary": "Include tableMappings", - "description": "An example response for all access control categories including tableMappings.", - "value": { - "categories": [ - { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" - } - } - ], - "name": "Ownership", - "guid": "830376aa-3e23-43c2-8b89-cee806d6c4d0" - }, - { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - ] - } - } - } - } + "enum": [ + "read", + "write" + ], + "type": "string" } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - }, - "post": { - "tags": [ - "Access Control - Attribute-Based Categories" - ], - "summary": "Create an attribute-based access control category in the specified database.", - "operationId": "CreateCategory", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -274,966 +59,878 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category for the discrete type 'Data Ownership'. The category maps the 'Tensile Test Data' table to the 'Data Ownership' discrete attribute, and sets the table-level discrete value to 'Public'.", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "innerCriterion": { + "type": "integer" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } - ], - "name": "Ownership" + ] } }, "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category for the discrete type 'Project Status'.", + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "name": "Status" + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category for the discrete type 'Data Ownership'. The category maps the 'Tensile Test Data' table to the 'Data Ownership' discrete attribute, and sets the table-level discrete value to 'Public'.", + }, + "Example 3": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 4": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 5": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "366badb7-2eff-47be-82b4-c70756bb1b88", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "localColumns": { + "filterOn": "all" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "type": "text" } - ], - "name": "Ownership" + ] } }, - "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category for the discrete type 'Project Status'.", + "Example 6": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "name": "Status" + "aggregationCriteria": [ + { + "criterionGuid": "2ebbe8ec-dd24-441a-b697-efeaec041036", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category for the discrete type 'Data Ownership'. The category maps the 'Tensile Test Data' table to the 'Data Ownership' discrete attribute, and sets the table-level discrete value to 'Public'.", + }, + "Example 7": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "b4cf4753-dbee-45c2-8bc2-d2f196fd8a08", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "type": "text" } - ], - "name": "Ownership" + ] } }, - "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category for the discrete type 'Project Status'.", + "Example 8": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "name": "Status" + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category for the discrete type 'Data Ownership'. The category maps the 'Tensile Test Data' table to the 'Data Ownership' discrete attribute, and sets the table-level discrete value to 'Public'.", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "innerCriterion": { + "type": "integer" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } - ], - "name": "Ownership" + ] } }, "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category for the discrete type 'Project Status'.", + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "name": "Status" + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategory" }, - "examples": { - "Example 3": { - "summary": "Get a single category", - "description": "An example response for a single access control category without including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - }, - "Example 4": { - "summary": "Include tableMappings", - "description": "An example response for a single access control category including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } + "Example 3": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategoryCreationException" }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with name 'Ownership', but an access control category with that name already exists.", - "value": { - "message": "Cannot create Access Control Category 'Ownership'.", - "code": "accessControlCategoryCreation", - "name": "Ownership", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Access Control Category with name 'Ownership' already exists in this Database.", - "reason": "nameAlreadyExists", - "name": "Ownership", - "parentEntityType": "database", - "entityType": "accessControlCategory" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "No such discrete type", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with a discrete type GUID that could not be found.", - "value": { - "message": "Cannot create Access Control Category 'Status'.", - "code": "accessControlCategoryCreation", - "name": "Status", - "errors": [ - { - "message": "Could not find Discrete Type with GUID '9a5428ab-03ee-4a21-9902-1d70e1a4954a'.", - "reason": "noSuchEntity", - "guid": "9a5428ab-03ee-4a21-9902-1d70e1a4954a", - "entityType": "discreteType" - } - ] - } - }, - "Example 3": { - "summary": "No such table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with a table mapping containing a table GUID that could not be found.", - "value": { - "message": "Cannot create Access Control Category 'Ownership'.", - "code": "accessControlCategoryCreation", - "name": "Ownership", - "errors": [ - { - "message": "Could not find Table with GUID 'e50562c5-cdaa-4d41-99f9-570e9db9281d'.", - "reason": "noSuchEntity", - "guid": "e50562c5-cdaa-4d41-99f9-570e9db9281d", - "entityType": "table" - } - ] - } - }, - "Example 4": { - "summary": "Attribute not on table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with a table mapping where the attribute does not belong to the specified table.", - "value": { - "message": "Cannot create Access Control Category 'Ownership'.", - "code": "accessControlCategoryCreation", - "name": "Ownership", - "errors": [ - { - "message": "The Attribute GUID 'a0e3403a-2f05-47bf-b5b2-ddd210df661e' does not belong to Table '7aefebf1-1809-4a20-9a33-b376499bada5'.", - "reason": "attributeNotOnTable", - "attributeGuid": "a0e3403a-2f05-47bf-b5b2-ddd210df661e", - "tableGuid": "7aefebf1-1809-4a20-9a33-b376499bada5" - } - ] - } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateAttributeBasedCategory: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}": { - "get": { - "tags": [ - "Access Control - Attribute-Based Categories" - ], - "summary": "Get the access control category with the specified guid in the specified database.", - "operationId": "GetCategoryByGuid", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "description": "Optionally include related data e.g. tableMappings in the response.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryInclude" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Get a single category", - "description": "An example response for a single access control category without including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - }, - "Example 2": { - "summary": "Include tableMappings", - "description": "An example response for a single access control category including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - }, - "patch": { - "tags": [ - "Access Control - Attribute-Based Categories" - ], - "summary": "Update an attribute-based access control category in the specified database.", - "operationId": "UpdateCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", - "value": { - "name": "Ownership (Updated)" - } - }, - "Example 2": { - "summary": "Replace table mappings", - "description": "This example demonstrates how to specify which discrete attribute an access control category should use for a table. This request maps the table 'Tensile Test Data' (GUID = '0dd5348e-72f3-4bcb-bb38-621e5953a333') to the discrete attribute 'Test status' for this category. The existing table mapping for table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') will be unchanged. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", + "Example 4": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - }, - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Replace table mappings and table values", - "description": "This example demonstrates how to update table mappings, including table values. This request maps the table 'Tensile Test Data' to the discrete attribute 'Test status' for this category, and sets the table discrete value to 'Requested'. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", + "Example 5": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "366badb7-2eff-47be-82b4-c70756bb1b88", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" + "localColumns": { + "filterOn": "all" }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] + "type": "text" } ] } }, - "Example 4": { - "summary": "Update table values", - "description": "This request updates the table discrete value to 'Completed' in an existing table mapping for the table 'Tensile Test Data'. The attribute does not need to be specified, because the mapping already exists and so must have an attribute. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855') with a table mapping for the table 'Tensile Test Data' (GUID = 0dd5348e-72f3-4bcb-bb38-621e5953a333).", + "Example 6": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "2ebbe8ec-dd24-441a-b697-efeaec041036", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - "tableDiscreteValues": [ - { - "guid": "4e40ea8c-792f-496f-9852-f2d2e152463a" - } - ] - } - ] - } - }, - "Example 5": { - "summary": "Delete a table mapping", - "description": "This example demonstrates how to delete a table mapping for the table 'Tensile Test Data', by setting the attribute to null. The mapping could also be deleted by not including it.", - "value": { - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "localColumns": { + "filterOn": "none" }, - "attribute": null + "type": "text" } ] } }, - "Example 6": { - "summary": "Delete all table mappings", - "description": "This example demonstrates how to delete all table mappings for the access control category, by setting the tableMappings to null.", - "value": { - "tableMappings": null - } - }, "Example 7": { - "summary": "Delete all table mappings by replacing with empty", - "description": "This example demonstrates how to delete all table mappings for the access control category, by replacing the tableMappings with an empty array.", - "value": { - "tableMappings": [] - } - }, - "Example 8": { - "summary": "Delete table mapping's table discrete values", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to null.", + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "b4cf4753-dbee-45c2-8bc2-d2f196fd8a08", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" }, - "tableDiscreteValues": null + "type": "text" } ] } }, - "Example 9": { - "summary": "Delete table mapping's table discrete values by replacing with empty", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to an empty array.", + "Example 8": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "tableMappings": [ + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" }, - "tableDiscreteValues": [] + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "name": "Ownership (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, "Example 2": { - "summary": "Replace table mappings", - "description": "This example demonstrates how to specify which discrete attribute an access control category should use for a table. This request maps the table 'Tensile Test Data' (GUID = '0dd5348e-72f3-4bcb-bb38-621e5953a333') to the discrete attribute 'Test status' for this category. The existing table mapping for table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') will be unchanged. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "type": "integer" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - }, - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, "Example 3": { - "summary": "Replace table mappings and table values", - "description": "This example demonstrates how to update table mappings, including table values. This request maps the table 'Tensile Test Data' to the discrete attribute 'Test status' for this category, and sets the table discrete value to 'Requested'. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, "Example 4": { - "summary": "Update table values", - "description": "This request updates the table discrete value to 'Completed' in an existing table mapping for the table 'Tensile Test Data'. The attribute does not need to be specified, because the mapping already exists and so must have an attribute. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855') with a table mapping for the table 'Tensile Test Data' (GUID = 0dd5348e-72f3-4bcb-bb38-621e5953a333).", + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - "tableDiscreteValues": [ - { - "guid": "4e40ea8c-792f-496f-9852-f2d2e152463a" - } - ] + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, "Example 5": { - "summary": "Delete a table mapping", - "description": "This example demonstrates how to delete a table mapping for the table 'Tensile Test Data', by setting the attribute to null. The mapping could also be deleted by not including it.", + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "366badb7-2eff-47be-82b4-c70756bb1b88", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" }, - "attribute": null + "type": "text" } ] } }, "Example 6": { - "summary": "Delete all table mappings", - "description": "This example demonstrates how to delete all table mappings for the access control category, by setting the tableMappings to null.", + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "2ebbe8ec-dd24-441a-b697-efeaec041036", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } }, "Example 7": { - "summary": "Delete all table mappings by replacing with empty", - "description": "This example demonstrates how to delete all table mappings for the access control category, by replacing the tableMappings with an empty array.", - "value": { - "tableMappings": [] - } - }, - "Example 8": { - "summary": "Delete table mapping's table discrete values", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to null.", + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "b4cf4753-dbee-45c2-8bc2-d2f196fd8a08", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" }, - "tableDiscreteValues": null + "type": "text" } ] } }, - "Example 9": { - "summary": "Delete table mapping's table discrete values by replacing with empty", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to an empty array.", + "Example 8": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "tableMappings": [ + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" }, - "tableDiscreteValues": [] + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", - "value": { - "name": "Ownership (Updated)" - } - }, - "Example 2": { - "summary": "Replace table mappings", - "description": "This example demonstrates how to specify which discrete attribute an access control category should use for a table. This request maps the table 'Tensile Test Data' (GUID = '0dd5348e-72f3-4bcb-bb38-621e5953a333') to the discrete attribute 'Test status' for this category. The existing table mapping for table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') will be unchanged. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "type": "integer" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - }, - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Replace table mappings and table values", - "description": "This example demonstrates how to update table mappings, including table values. This request maps the table 'Tensile Test Data' to the discrete attribute 'Test status' for this category, and sets the table discrete value to 'Requested'. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", + "Example 2": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Update table values", - "description": "This request updates the table discrete value to 'Completed' in an existing table mapping for the table 'Tensile Test Data'. The attribute does not need to be specified, because the mapping already exists and so must have an attribute. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855') with a table mapping for the table 'Tensile Test Data' (GUID = 0dd5348e-72f3-4bcb-bb38-621e5953a333).", - "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "type": "integer" }, - "tableDiscreteValues": [ - { - "guid": "4e40ea8c-792f-496f-9852-f2d2e152463a" - } - ] + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 5": { - "summary": "Delete a table mapping", - "description": "This example demonstrates how to delete a table mapping for the table 'Tensile Test Data', by setting the attribute to null. The mapping could also be deleted by not including it.", + "Example 3": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - "attribute": null + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 6": { - "summary": "Delete all table mappings", - "description": "This example demonstrates how to delete all table mappings for the access control category, by setting the tableMappings to null.", - "value": { - "tableMappings": null - } - }, - "Example 7": { - "summary": "Delete all table mappings by replacing with empty", - "description": "This example demonstrates how to delete all table mappings for the access control category, by replacing the tableMappings with an empty array.", - "value": { - "tableMappings": [] - } - }, - "Example 8": { - "summary": "Delete table mapping's table discrete values", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to null.", + "Example 4": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - "tableDiscreteValues": null + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 9": { - "summary": "Delete table mapping's table discrete values by replacing with empty", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to an empty array.", + "Example 5": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "366badb7-2eff-47be-82b4-c70756bb1b88", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - "tableDiscreteValues": [] - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", - "value": { - "name": "Ownership (Updated)" - } - }, - "Example 2": { - "summary": "Replace table mappings", - "description": "This example demonstrates how to specify which discrete attribute an access control category should use for a table. This request maps the table 'Tensile Test Data' (GUID = '0dd5348e-72f3-4bcb-bb38-621e5953a333') to the discrete attribute 'Test status' for this category. The existing table mapping for table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') will be unchanged. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", - "value": { - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "localColumns": { + "filterOn": "all" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - }, - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "type": "text" } ] } }, - "Example 3": { - "summary": "Replace table mappings and table values", - "description": "This example demonstrates how to update table mappings, including table values. This request maps the table 'Tensile Test Data' to the discrete attribute 'Test status' for this category, and sets the table discrete value to 'Requested'. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855').", + "Example 6": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "2ebbe8ec-dd24-441a-b697-efeaec041036", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" + "localColumns": { + "filterOn": "none" }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] + "type": "text" } ] } }, - "Example 4": { - "summary": "Update table values", - "description": "This request updates the table discrete value to 'Completed' in an existing table mapping for the table 'Tensile Test Data'. The attribute does not need to be specified, because the mapping already exists and so must have an attribute. Any other existing table mappings will be deleted. To use this request, the access control category must have the discrete type 'Project Status' (GUID = '683db97e-b985-42a2-9dd8-4b77f48b1855') with a table mapping for the table 'Tensile Test Data' (GUID = 0dd5348e-72f3-4bcb-bb38-621e5953a333).", + "Example 7": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "b4cf4753-dbee-45c2-8bc2-d2f196fd8a08", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" }, - "tableDiscreteValues": [ - { - "guid": "4e40ea8c-792f-496f-9852-f2d2e152463a" - } - ] - } - ] - } - }, - "Example 5": { - "summary": "Delete a table mapping", - "description": "This example demonstrates how to delete a table mapping for the table 'Tensile Test Data', by setting the attribute to null. The mapping could also be deleted by not including it.", - "value": { - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" }, - "attribute": null + "type": "text" } ] } }, - "Example 6": { - "summary": "Delete all table mappings", - "description": "This example demonstrates how to delete all table mappings for the access control category, by setting the tableMappings to null.", - "value": { - "tableMappings": null - } - }, - "Example 7": { - "summary": "Delete all table mappings by replacing with empty", - "description": "This example demonstrates how to delete all table mappings for the access control category, by replacing the tableMappings with an empty array.", - "value": { - "tableMappings": [] - } - }, "Example 8": { - "summary": "Delete table mapping's table discrete values", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to null.", - "value": { - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "tableDiscreteValues": null - } - ] - } - }, - "Example 9": { - "summary": "Delete table mapping's table discrete values by replacing with empty", - "description": "This example demonstrates how to delete the table discrete values for an existing table mapping for table 'Tensile Test Data', by setting the tableDiscreteValues to an empty array.", + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "tableMappings": [ + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" }, - "tableDiscreteValues": [] + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } @@ -1244,209 +941,78 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategory" - }, - "examples": { - "Example 7": { - "summary": "Get a single category", - "description": "An example response for a single access control category without including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - }, - "Example 8": { - "summary": "Include tableMappings", - "description": "An example response for a single access control category including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - } + "$ref": "#/components/schemas/GsaAggregationsResponse" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategoryUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with a name that already exists.", - "value": { - "message": "Cannot update Access Control Category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Access Control Category with name 'Status' already exists in this Database.", - "reason": "nameAlreadyExists", - "name": "Status", - "parentEntityType": "database", - "entityType": "accessControlCategory" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "No such table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with a table mapping containing a table GUID that could not be found.", - "value": { - "message": "Cannot update Access Control Category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "Could not find Table with GUID '7b2d8ffb-4c6d-43bd-a1a2-c251930cd338'.", - "reason": "noSuchEntity", - "guid": "7b2d8ffb-4c6d-43bd-a1a2-c251930cd338", - "entityType": "table" - } - ] - } - }, - "Example 3": { - "summary": "Attribute not on table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with a table mapping where the attribute does not belong to the specified table.", - "value": { - "message": "Cannot update Access Control Category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "The Attribute GUID '6ec57077-004c-4aea-ac47-eb0c5981057d' does not belong to Table '03650968-45ac-481f-be4f-359ea0779f64'.", - "reason": "attributeNotOnTable", - "attributeGuid": "6ec57077-004c-4aea-ac47-eb0c5981057d", - "tableGuid": "03650968-45ac-481f-be4f-359ea0779f64" - } - ] - } - }, - "Example 4": { - "summary": "Attribute discrete type mismatch", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with an attribute that uses a different discrete type.", - "value": { - "message": "Cannot update Access Control Category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "The Attribute GUID '92b8af4d-3694-4d97-914a-12258b81aad3' uses Discrete Type 'a010b073-dbbe-45e5-8d69-8ff29c92dfb0' but expected '823c30ff-affc-489d-9b8c-05f84c433c9a'.", - "reason": "attributeDiscreteTypeMismatch", - "attributeGuid": "92b8af4d-3694-4d97-914a-12258b81aad3", - "expectedDiscreteTypeGuid": "823c30ff-affc-489d-9b8c-05f84c433c9a", - "actualDiscreteTypeGuid": "a010b073-dbbe-45e5-8d69-8ff29c92dfb0" - } - ] - } - } + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" + "description": "Database or table not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}:aggregations": { + "post": { "tags": [ - "Access Control - Attribute-Based Categories" + "Aggregation" ], - "summary": "Delete an attribute-based access control category in the specified database.", - "operationId": "DeleteCategory", + "summary": "Runs an aggregation against the table.", + "operationId": "DatabaseAggregationForTableWithGuid", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "category-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Database not found" + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-based-access-control/aggregate": { - "post": { - "tags": [ - "Access Control - Permission-Based" - ], - "summary": "Gets the aggregated permission-based access control settings for entities.\r\nReturns whether all, some, or none of the provided entities have read or write access for each permission.", - "operationId": "AggregatePermissionAccessControls", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -1454,822 +1020,658 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaAggregatePermissionAccessControlsRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Attributes", - "description": "This example demonstrates how to aggregate permission-based access control over several attributes - 'Melting Point', 'Metals' and 'Grain Size'.The response will include how many of these attributes have read or write access for each permission.", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000b-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "000000aa-0001-4fff-8fff-dd92ffff0000", + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, "isMetaAttribute": false, - "entityType": "attribute" + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Folder descendants", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Glasses' folder in the 'All bulk materials' subset.The response will include the total number of descendants, and counts of how many of these descendants have read or write access for each permission.", + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "entities": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Descendants with version filter", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be considered in the aggregate.", + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "entities": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregatePermissionAccessControlsRequest" - }, - "examples": { - "Example 1": { - "summary": "Attributes", - "description": "This example demonstrates how to aggregate permission-based access control over several attributes - 'Melting Point', 'Metals' and 'Grain Size'.The response will include how many of these attributes have read or write access for each permission.", + }, + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000b-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "000000aa-0001-4fff-8fff-dd92ffff0000", + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, "isMetaAttribute": false, - "entityType": "attribute" + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Folder descendants", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Glasses' folder in the 'All bulk materials' subset.The response will include the total number of descendants, and counts of how many of these descendants have read or write access for each permission.", + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "entities": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "criterionGuid": "e4cd107e-164d-4470-881a-8698bceea954", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Descendants with version filter", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be considered in the aggregate.", + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "entities": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "criterionGuid": "cb372ce4-9fa8-41e6-9110-28645f53951b", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregatePermissionAccessControlsRequest" - }, - "examples": { - "Example 1": { - "summary": "Attributes", - "description": "This example demonstrates how to aggregate permission-based access control over several attributes - 'Melting Point', 'Metals' and 'Grain Size'.The response will include how many of these attributes have read or write access for each permission.", + }, + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000b-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "000000aa-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - } - ] - } - }, - "Example 2": { - "summary": "Folder descendants", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Glasses' folder in the 'All bulk materials' subset.The response will include the total number of descendants, and counts of how many of these descendants have read or write access for each permission.", - "value": { - "entities": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "criterionGuid": "719a2182-9f90-4d06-9c17-8a5aef028bf4", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Descendants with version filter", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be considered in the aggregate.", + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "entities": [ + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAggregatePermissionAccessControlsRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Attributes", - "description": "This example demonstrates how to aggregate permission-based access control over several attributes - 'Melting Point', 'Metals' and 'Grain Size'.The response will include how many of these attributes have read or write access for each permission.", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000b-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "000000aa-0001-4fff-8fff-dd92ffff0000", + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, "isMetaAttribute": false, - "entityType": "attribute" + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Folder descendants", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Glasses' folder in the 'All bulk materials' subset.The response will include the total number of descendants, and counts of how many of these descendants have read or write access for each permission.", + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "entities": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Descendants with version filter", - "description": "This example demonstrates how to aggregate permission-based access control over the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be considered in the aggregate.", + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "entities": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlAggregateInfo" }, - "example": { - "entityCount": 100, - "categoryAggregates": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAggregates": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canReadCount": 100, - "canWriteCount": 100 - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canReadCount": 100, - "canWriteCount": 50 - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canReadCount": 20, - "canWriteCount": 5 - } - ] + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAggregates": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canReadCount": 100, - "canWriteCount": 0 + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canReadCount": 0, - "canWriteCount": 0 - } - ] - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlAggregationException" - }, - "examples": { - "Example 1": { - "summary": "Entity not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to aggregate access controls for a record version with GUID '37b99cd4-d4ca-485f-9b65-b2d7293898cf', but the record version does not exist.", - "value": { - "message": "Cannot aggregate access control.", - "code": "permissionBasedAccessControlAggregation", - "errors": [ - { - "message": "The access control entities are not valid.", - "reason": "accessControlEntities", - "errors": [ - { - "message": "The entities specified could not be found.", - "reason": "noSuchEntities", - "entities": [ - { - "tableGuid": "e4ed6641-db8f-4901-a656-ce4e37a7bb40", - "recordHistoryGuid": "fa434e7a-42f1-47cb-b8f2-e6aaf22bfa95", - "recordVersionGuid": "37b99cd4-d4ca-485f-9b65-b2d7293898cf", - "entityType": "recordVersion" - } - ] - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Descendants subset not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to aggregate access controls for a descendants of a table in subset with GUID '4cf52349-b834-473a-9395-dd801c128bcc', but the subset does not exist.", - "value": { - "message": "Cannot aggregate access control.", - "code": "permissionBasedAccessControlAggregation", - "errors": [ - { - "message": "The access control entities are not valid.", - "reason": "accessControlEntities", - "errors": [ - { - "message": "The subset specified could not be found for these entities.", - "reason": "noSuchSubset", - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "4cf52349-b834-473a-9395-dd801c128bcc", - "entityType": "tableDescendants" - } - ] - } - ] - } - ] - } + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations": { - "post": { - "tags": [ - "Access Control - Permission-Based" - ], - "summary": "Update permission-based access control settings for entities.\r\nSets the access control for the given permissions on each entity.\r\nIf setting access control on a record, its data will also be updated, but constrained by the attribute.\r\nIf setting access control on an attribute, its data will also be updated, but constrained by the latest relevant recordVersion.\r\nThis runs as a long-running operation.", - "operationId": "UpdatePermissionCategoryAccessControlsOperation", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlsOperationRequest" - }, - "examples": { - "Example 1": { - "summary": "Update write access for multiple record versions", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for multiple record versions: 'Alumino Silicate 1720', 'Maraging Steel' and the folder 'Glasses'.", + }, + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "e4cd107e-164d-4470-881a-8698bceea954", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "recordVersionGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } }, - "Example 2": { - "summary": "Update write access for an attribute", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for attribute 'Melting Point'.", + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "cb372ce4-9fa8-41e6-9110-28645f53951b", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update folder descendants", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Glasses' folder in the 'All bulk materials' subset.", + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "719a2182-9f90-4d06-9c17-8a5aef028bf4", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update descendants with version filter", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be updated.", + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "categoryAccessControls": [ + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlsOperationRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Update write access for multiple record versions", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for multiple record versions: 'Alumino Silicate 1720', 'Maraging Steel' and the folder 'Glasses'.", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "type": "integer" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "recordVersionGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Update write access for an attribute", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for attribute 'Melting Point'.", + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "type": "integer" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", + "identity": 8965, "isMetaAttribute": false, - "entityType": "attribute" + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Update folder descendants", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Glasses' folder in the 'All bulk materials' subset.", + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 4": { - "summary": "Update descendants with version filter", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be updated.", + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlsOperationRequest" - }, - "examples": { - "Example 1": { - "summary": "Update write access for multiple record versions", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for multiple record versions: 'Alumino Silicate 1720', 'Maraging Steel' and the folder 'Glasses'.", + }, + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "e4cd107e-164d-4470-881a-8698bceea954", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "recordVersionGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } }, - "Example 2": { - "summary": "Update write access for an attribute", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for attribute 'Melting Point'.", + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "cb372ce4-9fa8-41e6-9110-28645f53951b", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "entityType": "attribute" + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update folder descendants", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Glasses' folder in the 'All bulk materials' subset.", + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "719a2182-9f90-4d06-9c17-8a5aef028bf4", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update descendants with version filter", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be updated.", + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "categoryAccessControls": [ + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } @@ -2278,134 +1680,218 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlsOperationRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Update write access for multiple record versions", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for multiple record versions: 'Alumino Silicate 1720', 'Maraging Steel' and the folder 'Glasses'.", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "type": "integer" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } - ], - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" - }, + ] + } + }, + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "recordVersionGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "entityType": "recordVersion" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Update write access for an attribute", - "description": "This example demonstrates how to give write access for the US permission in the Geo category for attribute 'Melting Point'.", + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "entities": [ + ] + } + }, + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, "isMetaAttribute": false, - "entityType": "attribute" + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Update folder descendants", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Glasses' folder in the 'All bulk materials' subset.", + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "e4cd107e-164d-4470-881a-8698bceea954", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "localColumns": { + "filterOn": "all" + }, + "type": "text" } - ], - "entities": [ + ] + } + }, + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "recordHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "0000b1c5-0010-4fff-8fff-dd92ffff0000", - "entityType": "recordHistoryDescendants" + "criterionGuid": "cb372ce4-9fa8-41e6-9110-28645f53951b", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update descendants with version filter", - "description": "This example demonstrates how to give write access for the US permission in the Geo category to all the descendants of the 'Material Universe' table using a latest version filter. If the table is version-controlled, for each descendant record history, only the latest record version available in write mode will be updated.", + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "categoryAccessControls": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "719a2182-9f90-4d06-9c17-8a5aef028bf4", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } - ], - "entities": [ + ] + } + }, + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "latestVersionFilter": [ - "write" - ], - "entityType": "tableDescendants" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } @@ -2415,1319 +1901,729 @@ } }, "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "OK", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "b3ee54cd-9d0e-4064-be44-bd2877708bd3", - "status": "pending" + "$ref": "#/components/schemas/GsaAggregationsResponse" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlUpdateOperationException" - }, - "examples": { - "Example 1": { - "summary": "Entity not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to bulk update access controls for a record version with GUID 'c65ef51f-eceb-4a7d-8f7a-9d342d7f275e', but the record version does not exist.", - "value": { - "message": "Cannot update access control.", - "code": "permissionBasedAccessControlUpdateOperation", - "errors": [ - { - "message": "The access control entities are not valid.", - "reason": "accessControlEntities", - "errors": [ - { - "message": "The entities specified could not be found.", - "reason": "noSuchEntities", - "entities": [ - { - "tableGuid": "73f9077e-be0b-40fb-9cf3-9bd59737c0c8", - "recordHistoryGuid": "8ce22dd6-fd24-441d-83b7-c83a20b524ac", - "recordVersionGuid": "c65ef51f-eceb-4a7d-8f7a-9d342d7f275e", - "entityType": "recordVersion" - } - ] - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to bulk update access controls for a permission category with GUID '2dcb174c-dc23-48a1-a2a9-04a991fa9126', but the permission category does not exist.", - "value": { - "message": "Cannot update access control.", - "code": "permissionBasedAccessControlUpdateOperation", - "errors": [ - { - "message": "The permission categories are not valid.", - "reason": "permissionCategories", - "errors": [ - { - "message": "The permission category with GUID '2dcb174c-dc23-48a1-a2a9-04a991fa9126' does not exist.", - "reason": "noSuchCategory", - "categoryGuid": "2dcb174c-dc23-48a1-a2a9-04a991fa9126" - } - ] - } - ] - } - }, - "Example 3": { - "summary": "Descendants subset not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to bulk update access controls for a descendants of a table in subset with GUID '3a88992f-46c9-40c4-899f-07c15b6c7c83', but the subset does not exist.", - "value": { - "message": "Cannot update access control.", - "code": "permissionBasedAccessControlUpdateOperation", - "errors": [ - { - "message": "The access control entities are not valid.", - "reason": "accessControlEntities", - "errors": [ - { - "message": "The subset specified could not be found for these entities.", - "reason": "noSuchSubset", - "entities": [ - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "subsetGuid": "3a88992f-46c9-40c4-899f-07c15b6c7c83", - "entityType": "tableDescendants" - } - ] - } - ] - } - ] - } - } + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or table not found" } } - }, - "get": { + } + }, + "/v1alpha/databases/{database-key}:aggregations": { + "post": { "tags": [ - "Access Control - Permission-Based" + "Aggregation" ], - "summary": "Gets all long-running operations for updating permission-based access control settings in the specified database.", - "operationId": "GetPermissionCategoryAccessControlsOperations", + "summary": "Runs an aggregation against the database.", + "operationId": "DatabaseAggregation", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "include", + "name": "mode", "in": "query", - "description": "Optionally include more detailed information in the response.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLongRunningOperationInclude" - } + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "status", - "in": "query", - "description": "Optional filter for the status of the long-running operations.", + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLongRunningStatus" - } + "enum": [ + "read", + "write" + ], + "type": "string" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLongRunningOperation" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsRequest" + }, + "examples": { + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "example": [ - { - "identifier": "5bac0119-c741-4627-a090-a06e3c1b346c", - "status": "failed", - "numberOfCompletedTasks": 25.0, - "numberOfTasks": 100, - "httpStatusCode": 500 - }, - { - "identifier": "5d8638ad-b278-4d5d-a849-f35955185ff0", - "status": "inProgress", - "numberOfCompletedTasks": 50.0, - "numberOfTasks": 100 - }, - { - "identifier": "333fc3d0-fb8a-46b6-9555-4e66cd4bdbff", - "status": "pending" + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - ] - } - } - }, - "403": { - "description": "Forbidden" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations/{operation-identifier}": { - "get": { - "tags": [ - "Access Control - Permission-Based" - ], - "summary": "Gets the long-running operation for updating permission-based access control settings in the specified database.", - "operationId": "GetPermissionCategoryAccessControlsOperation", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "operation-identifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLongRunningOperationInclude" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" }, - "examples": { - "Example 1": { - "summary": "A pending long-running operation", - "description": "This example demonstrates a newly created long-running operation in the 'pending' state.", - "value": { - "identifier": "356d2aae-2307-4563-9d03-b0b4d79f2da2", - "status": "pending" - } - }, - "Example 2": { - "summary": "An in-progress long-running operation", - "description": "This example demonstrates a long-running operation in progress.", - "value": { - "identifier": "356d2aae-2307-4563-9d03-b0b4d79f2da2", - "status": "inProgress", - "numberOfCompletedTasks": 50.0, - "numberOfTasks": 100 - } - }, - "Example 3": { - "summary": "A succeeded long-running operation", - "description": "This example demonstrates a long-running operation that has completed successfully.", - "value": { - "identifier": "356d2aae-2307-4563-9d03-b0b4d79f2da2", - "status": "succeeded", - "numberOfCompletedTasks": 100.0, - "numberOfTasks": 100, - "httpStatusCode": 204 - } - }, - "Example 4": { - "summary": "A failed long-running operation", - "description": "This example demonstrates a long-running operation that has completed with an error.", - "value": { - "identifier": "356d2aae-2307-4563-9d03-b0b4d79f2da2", - "status": "failed", - "numberOfCompletedTasks": 25.0, - "numberOfTasks": 100, - "httpStatusCode": 500 - } - }, - "Example 5": { - "summary": "A failed long-running operation with response", - "description": "This example demonstrates a long-running operation that has completed with an error, and includes the response. The input was validated before the long-running operation started, so any errors here are unlikely to be input validation errors.", - "value": { - "identifier": "356d2aae-2307-4563-9d03-b0b4d79f2da2", - "status": "failed", - "numberOfCompletedTasks": 25.0, - "numberOfTasks": 100, - "httpStatusCode": 500, - "response": { - "code": "internalServerError", - "message": "An unexpected error occurred. " + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - } + ] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Long-running operation not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "delete": { - "tags": [ - "Access Control - Permission-Based" - ], - "summary": "Requests cancellation of a long-running operation for updating permission-based access control settings.\r\nCancellation will only happen when the operation is pending or in progress, and is not guaranteed - it is a best-effort attempt to stop the operation early.\r\nThe long-running operation status will be set to awaitingCancellation; then to cancelled if cancellation is successful.\r\nIf the long-running operation has already completed (succeeded or failed), an error will be returned.\r\nIf the long-running operation has already been cancelled, the status will remain as is (awaitingCancellation or cancelled).", - "operationId": "CancelPermissionCategoryAccessControlsOperation", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "operation-identifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "c5ffa123-fb07-468e-a040-fea1a5cb3726", - "status": "awaitingCancellation" - } - } - } - }, - "422": { - "description": "MI not in permission-based access control mode, or invalid status for long-running operation - operation must not be complete (succeeded or failed)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperationInvalidStatusException" - }, - "example": { - "message": "Invalid status Succeeded for long-running operation.", - "code": "longRunningOperationInvalidStatus", - "status": "succeeded" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Long-running operation not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations/{operation-identifier}/result": { - "get": { - "tags": [ - "Access Control - Permission-Based" - ], - "summary": "Gets the result of a long-running operation for updating permission-based access control settings in the specified database.\r\nA successful response would return a 204 No Content response.\r\nA failed response would return an error response.", - "operationId": "GetPermissionCategoryAccessControlsOperationResult", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "operation-identifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Long-running operation not found" - }, - "422": { - "description": "MI not in permission-based access control mode, or invalid status for long-running operation - operation must be complete (succeeded or failed)" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories/permissionsInUse": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Gets the number of permissions that have been used and the number remaining that are available to be used.\r\nA schema for a database may have up to 128 permissions, this is the total number of permissions that have ever existed in the schema.", - "operationId": "GetPermissionsInUse", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionsInUseInfo" }, - "example": { - "permissionsUsed": 12, - "maxPermissionsAvailable": 128, - "permissionsAvailableForUse": 116 - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get all permission-based access control categories for the specified database.", - "operationId": "GetPermissionCategories", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesInfo" + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } }, - "example": { - "categories": [ - { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "1b149bd8-6aa6-4f33-90c4-c058c625eca7", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "localColumns": { + "filterOn": "all" }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "type": "text" + } + ] + } + }, + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "permissions": [ - { - "role": "DOMAIN\\Public", - "name": "Public", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" + "aggregationCriteria": [ + { + "criterionGuid": "91e78265-41af-4df7-8f19-e338db16e887", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - { - "role": "DOMAIN\\Internal", - "name": "Internal", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - } - ], - "name": "Sensitivity", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - } - ] - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "post": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Create a new permission-based access control category.", - "operationId": "CreatePermissionCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] + } + }, + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "permissions": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Design", - "name": "Design" + "criterionGuid": "a741ab7d-7c5a-47f9-9f8d-c428a1bc8a52", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "name": "Division" + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } - ], - "name": "Division" + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + }, + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "name": "Division" + ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + }, + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "name": "Division" + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategory" }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryCreationException" - }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category with name 'Geo', but a permission category with that name already exists.", - "value": { - "message": "Cannot create permission category 'Geo'.", - "code": "permissionCategoryCreation", - "name": "Geo", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Permission Category with name 'Geo' already exists in this Database.", - "reason": "nameAlreadyExists", - "name": "Geo", - "parentEntityType": "database", - "entityType": "permissionCategory" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "No permissions provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category without providing any permissions. PermissionCategories must always have at least one permission.", - "value": { - "message": "Cannot create permission category 'Division'.", - "code": "permissionCategoryCreation", - "name": "Division", - "errors": [ - { - "message": "Permission categories must have at least one permission.", - "reason": "noPermissions" - } - ] - } - }, - "Example 3": { - "summary": "Invalid permissions provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category with a permission 'Design', but the 'Design' permission did not have a role.", - "value": { - "message": "Cannot create permission category 'Division'.", - "code": "permissionCategoryCreation", - "name": "Division", - "errors": [ - { - "message": "The permission 'Design' is not valid.", - "reason": "permission", - "name": "Design", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Maximum permissions reached", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category with 5 new permissions, but this would exceed the maximum number of permissions available in the database schema.", - "value": { - "message": "Cannot create permission category 'Design'.", - "code": "permissionCategoryCreation", - "name": "Design", - "errors": [ - { - "message": "The 5 new permissions cannot be added, there are not enough permissions available.", - "reason": "tooManyPermissions", - "numberOfNewPermissions": 5, - "maxNumberOfPermissions": 128 - } - ] - } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreatePermissionCategory: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "put": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Replace all permission-based access control categories.\r\nThis can result in adding, modifying and deleting permission categories.", - "operationId": "ReplacePermissionCategories", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" - }, - "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", + }, + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] + "criterionGuid": "1b149bd8-6aa6-4f33-90c4-c058c625eca7", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "91e78265-41af-4df7-8f19-e338db16e887", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] + "criterionGuid": "a741ab7d-7c5a-47f9-9f8d-c428a1bc8a52", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] + "criterion": { + "innerCriterion": { + "type": "dateTime" }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "categories": [ - { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "categories": [ - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" - }, - "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", + }, + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] + "criterionGuid": "1b149bd8-6aa6-4f33-90c4-c058c625eca7", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "91e78265-41af-4df7-8f19-e338db16e887", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] + "criterionGuid": "a741ab7d-7c5a-47f9-9f8d-c428a1bc8a52", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] + "criterion": { + "innerCriterion": { + "type": "dateTime" }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } @@ -3736,151 +2632,218 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", - "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "categories": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "categories": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] + "criterionGuid": "1b149bd8-6aa6-4f33-90c4-c058c625eca7", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] + "criterionGuid": "91e78265-41af-4df7-8f19-e338db16e887", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] + } + }, + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "a741ab7d-7c5a-47f9-9f8d-c428a1bc8a52", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } @@ -3891,287 +2854,45 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesInfo" - }, - "example": { - "categories": [ - { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - { - "permissions": [ - { - "role": "DOMAIN\\Public", - "name": "Public", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - { - "role": "DOMAIN\\Internal", - "name": "Internal", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - } - ], - "name": "Sensitivity", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - } - ] + "$ref": "#/components/schemas/GsaAggregationsResponse" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryReplaceException" - }, - "examples": { - "Example 1": { - "summary": "Permission Category to Update not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, but two of the permission categories to be updated could not be found.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "The following GUIDs do not correspond to existing categories: '1a0729c0-c9c0-41ea-b6a1-f649cda897a6', 'a583a0a8-1ab4-428d-b65a-e4f132fc11f8'.", - "reason": "noSuchCategories", - "missingGuids": [ - "1a0729c0-c9c0-41ea-b6a1-f649cda897a6", - "a583a0a8-1ab4-428d-b65a-e4f132fc11f8" - ] - } - ] - } - }, - "Example 2": { - "summary": "Duplicate Permission Categories", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, but the replacement would result in two permission categories with the same name 'Division'.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "Duplicate categories were specified. Duplicate names: 'Division'; Duplicate GUIDs: ''.", - "reason": "duplicateCategories", - "duplicateNames": [ - "Division" - ], - "duplicateGuids": [] - } - ] - } - }, - "Example 3": { - "summary": "Invalid permissions provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, and insert a new permission category 'Division' with a permission 'Design', but the 'Design' permission did not have a role.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "The category 'Division' is not valid.", - "reason": "category", - "name": "Division", - "errors": [ - { - "message": "The permission 'Design' is not valid.", - "reason": "permission", - "name": "Design", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Maximum permissions reached", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, and insert 5 new permission categories, either by creating new categories or adding permissions to existing categories, but this would exceed the maximum number of permissions available in the database schema.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "The 5 new permissions cannot be added, there are not enough permissions available.", - "reason": "tooManyPermissions", - "numberOfNewPermissions": 5, - "maxNumberOfPermissions": 128 - } - ] - } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The required property 'categories' was not provided.", - "value": { - "message": "ReplacePermissionCategoriesRequest: Required property 'categories' not found in JSON", - "code": "jsonSerialization" - } - }, - "Example 6": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided on a category.", - "value": { - "message": "CreatePutPermissionCategory: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" } } } }, - "403": { - "description": "Forbidden" - }, "404": { "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" } } } }, - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get a permission-based access control category with a specified guid.", - "operationId": "GetPermissionCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategory" - }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "patch": { + "/v1alpha/integration-schemas/{schema}:aggregations": { + "post": { "tags": [ - "Access Control - Permission-Based Schema" + "Aggregation" ], - "summary": "Update a permission-based access control category.", - "operationId": "UpdatePermissionCategory", + "summary": "Runs an aggregation against the integration schema.", + "operationId": "IntegrationAggregation", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", + "name": "schema", "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", "required": true, "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" + "type": "string" } } ], @@ -4179,1859 +2900,1133 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", - "value": { - "name": "Geo (Updated)" - } - }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 25": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", - "value": { - "name": "Geo (Updated)" - } }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 26": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", - "value": { - "name": "Geo (Updated)" - } }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 27": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", - "value": { - "name": "Geo (Updated)" - } }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 28": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategory" }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "Example 29": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Duplicate permission category name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but a permission category with the new name already exists.", - "value": { - "message": "Cannot update permission category 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "code": "permissionCategoryUpdate", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Permission Category with name 'Sensitivity' already exists in this Database.", - "reason": "nameAlreadyExists", - "name": "Sensitivity", - "parentEntityType": "database", - "entityType": "permissionCategory" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Permission role not provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', and add a new permission 'LATAM' but the role was empty.", - "value": { - "message": "Cannot update permission category 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "code": "permissionCategoryUpdate", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "errors": [ - { - "message": "The permission 'LATAM' is not valid.", - "reason": "permission", - "name": "LATAM", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } - ] - } + "aggregationCriteria": [ + { + "criterionGuid": "ae0e7e0b-1fbc-4ce5-9415-f228ec214d49", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "delete": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Delete a permission-based access control category.", - "operationId": "DeletePermissionCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get all permission-based access control permissions for the specified category.", - "operationId": "GetPermissionsInCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionsInfo" }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "Example 30": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ] - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "post": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Create a new permission-based access control permission.", - "operationId": "CreatePermission", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + "aggregationCriteria": [ + { + "criterionGuid": "8f580cd8-b371-438e-bc39-0c403889c9bb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] + } + }, + "Example 31": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "80d9e958-ebd7-4f9b-a123-d4b87d43b252", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 32": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "c55528f0-4f57-4942-8a98-f4bffc0b18a9" + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + "Example 25": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 26": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "c55528f0-4f57-4942-8a98-f4bffc0b18a9" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + }, + "Example 27": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 28": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "c55528f0-4f57-4942-8a98-f4bffc0b18a9" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + }, + "Example 29": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "ae0e7e0b-1fbc-4ce5-9415-f228ec214d49", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 30": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "c55528f0-4f57-4942-8a98-f4bffc0b18a9" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "8f580cd8-b371-438e-bc39-0c403889c9bb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermission" - }, - "example": { - "role": "DOMAIN\\LATAM", - "name": "LATAM", - "guid": "9cf4709d-05ad-4b59-92c6-b7b7953ea9ed" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCreationException" }, - "examples": { - "Example 1": { - "summary": "Name already exists and role was empty", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission with name 'US', but the role was not provided, and a permission with that name already exists in the category.", - "value": { - "message": "Cannot create permission 'US'.", - "code": "permissionCreation", - "name": "US", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Permission with name 'US' already exists in this Permission Category.", - "reason": "nameAlreadyExists", - "name": "US", - "parentEntityType": "permissionCategory", - "entityType": "permission" - } - ] - }, - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } - }, - "Example 2": { - "summary": "Maximum permissions reached", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission, but the maximum number of permissions has already been reached in the database schema.", - "value": { - "message": "Cannot create permission 'LATAM'.", - "code": "permissionCreation", - "name": "LATAM", - "errors": [ - { - "message": "There are no more permissions available, the maximum number 128 has been reached.", - "reason": "maxPermissionsReached", - "maxNumberOfPermissions": 128 - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreatePermission: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "Example 31": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "80d9e958-ebd7-4f9b-a123-d4b87d43b252", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] } - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get a permission-based access control permission with a given guid in the specified category.", - "operationId": "GetPermissionInCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - }, - { - "name": "permission-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermission" }, - "example": { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "Example 32": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } } } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, category or permission not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "patch": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Update a permission-based access control permission.", - "operationId": "UpdatePermission", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - }, - { - "name": "permission-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { + }, + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + "Example 25": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 26": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", - "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "93b85dc2-9e7e-40d6-b966-e751f5908a8c" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + "Example 27": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 28": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", + "Example 29": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "93b85dc2-9e7e-40d6-b966-e751f5908a8c" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "ae0e7e0b-1fbc-4ce5-9415-f228ec214d49", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + }, + "Example 30": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "8f580cd8-b371-438e-bc39-0c403889c9bb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 31": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "80d9e958-ebd7-4f9b-a123-d4b87d43b252", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", + "Example 32": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "93b85dc2-9e7e-40d6-b966-e751f5908a8c" + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + "Example 25": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 26": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", + "Example 27": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "93b85dc2-9e7e-40d6-b966-e751f5908a8c" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermission" }, - "example": { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US (Updated)", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionUpdateException" + "Example 28": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } }, - "examples": { - "Example 1": { - "summary": "Duplicate permission name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7', but a permission with the new name already exists in the category.", - "value": { - "message": "Cannot update permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionUpdate", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Permission with name 'EMEA' already exists in this Permission Category.", - "reason": "nameAlreadyExists", - "name": "EMEA", - "parentEntityType": "permissionCategory", - "entityType": "permission" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Role not provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7', but the role was set to an empty string. A role must be provided and cannot be empty or whitespace.", - "value": { - "message": "Cannot update permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionUpdate", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } - }, - "Example 3": { - "summary": "Multiple validation errors", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7'. The role was not provided and the name already exists in the category.", - "value": { - "message": "Cannot update permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionUpdate", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Permission with name 'EMEA' already exists in this Permission Category.", - "reason": "nameAlreadyExists", - "name": "EMEA", - "parentEntityType": "permissionCategory", - "entityType": "permission" - } - ] + "Example 29": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "ae0e7e0b-1fbc-4ce5-9415-f228ec214d49", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] + } + }, + "Example 30": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "8f580cd8-b371-438e-bc39-0c403889c9bb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] + } + }, + "Example 31": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "80d9e958-ebd7-4f9b-a123-d4b87d43b252", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 32": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, category or permission not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "delete": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Delete a permission-based access control permission.", - "operationId": "DeletePermission", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - }, - { - "name": "permission-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "format": "uuid" - } } - ], + }, "responses": { - "400": { - "description": "Bad Request", + "200": { + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Category must have permissions", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7', but there were no more permissions in that category, and a category must have at least one permission.", - "value": { - "message": "Cannot delete permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionDeletion", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "Permission categories must have at least one permission.", - "reason": "categoryMustHavePermissions" - } - ] - } - } + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" } } } }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or category or permission not found" + "description": "Schema not found" }, "422": { - "description": "MI not in permission-based access control mode" + "description": "MI not in attribute-based access control mode" } } } }, - "/v1alpha/activity-log/entries": { + "/v1alpha/bulk": { "post": { "tags": [ - "ActivityLog" - ], - "summary": "Get filtered activity log entries, ordered from newest to oldest.", - "operationId": "GetEntries", - "parameters": [ - { - "name": "pageSize", - "in": "query", - "description": "Page size. Defaults to 1 000. The limit is 10 000.", - "schema": { - "type": "integer", - "format": "int32", - "default": 1000 - } - }, - { - "name": "page", - "in": "query", - "description": "Page number. Defaults to 1.", - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } + "Bulk" ], + "summary": "Handles multiple requests.\r\nThe requests should be independent - they could be executed in any order.\r\nThe response will contain a response item for each request item, in the same order as the request items.\r\nRequests that return file or image responses cannot be sent via the bulk endpoint.", + "operationId": "Bulk", "requestBody": { - "description": "Filter object used to narrow down the entries to return.", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" + "$ref": "#/components/schemas/GsaBulkRequest" }, "examples": { "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } + } + ] } }, "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } - } - }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": false - } - } - }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } - } - }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } - } - }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } - } - }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - }, - "usageModeFilter": { - "usageModeToMatch": "view" - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + } + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" + "$ref": "#/components/schemas/GsaBulkRequest" }, "examples": { "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } + } + ] } }, "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } - } - }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": false - } - } - }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } - } - }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } - } - }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } - } - }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - }, - "usageModeFilter": { - "usageModeToMatch": "view" - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + } + ] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" + "$ref": "#/components/schemas/GsaBulkRequest" }, "examples": { "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } + } + ] } }, "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } - } - }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": false - } - } - }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } - } - }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } - } - }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } - } - }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - }, - "usageModeFilter": { - "usageModeToMatch": "view" - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + } + ] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" + "$ref": "#/components/schemas/GsaBulkRequest" }, "examples": { "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } + } + ] } }, "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } - } - }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": false - } - } - }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-08-23T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } - } - }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } - } - }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } - } - }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "dateFilter": { - "dateFrom": "2026-08-21T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - }, - "usageModeFilter": { - "usageModeToMatch": "view" - } + "requests": [ + { + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + } + ] } } } @@ -6040,37 +4035,69 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesInfo" + "$ref": "#/components/schemas/GsaBulkInfo" }, "examples": { "Example 1": { - "summary": "Example response for getting activity log entries.", - "description": "Example response for getting activity log entries.", + "summary": "Bulk response for editing two attributes.", + "description": "The bulk response includes a response item for each request sent.", "value": { - "itemType": "activityLog", - "entries": [ + "data": [ { - "date": "2026-08-28T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Viewer" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "edit" + "status": 201, + "body": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + }, + "headers": { + "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } }, { - "date": "2026-08-27T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Explore", - "Server API" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "view" + "status": 200, + "body": { + "isMultiValued": false, + "defaultThresholdType": "exists", + "info": { + "typeCode": "DISC", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Metals (updated)", + "isMetaAttribute": false + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals (updated)", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + }, + "headers": {} } ] } @@ -6079,33 +4106,65 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesInfo" + "$ref": "#/components/schemas/GsaBulkInfo" }, "examples": { "Example 1": { - "summary": "Example response for getting activity log entries.", - "description": "Example response for getting activity log entries.", + "summary": "Bulk response for editing two attributes.", + "description": "The bulk response includes a response item for each request sent.", "value": { - "itemType": "activityLog", - "entries": [ + "data": [ { - "date": "2026-08-28T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Viewer" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "edit" + "status": 201, + "body": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + }, + "headers": { + "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } }, { - "date": "2026-08-27T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Explore", - "Server API" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "view" + "status": 200, + "body": { + "isMultiValued": false, + "defaultThresholdType": "exists", + "info": { + "typeCode": "DISC", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Metals (updated)", + "isMetaAttribute": false + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals (updated)", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + }, + "headers": {} } ] } @@ -6114,33 +4173,65 @@ }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesInfo" + "$ref": "#/components/schemas/GsaBulkInfo" }, "examples": { "Example 1": { - "summary": "Example response for getting activity log entries.", - "description": "Example response for getting activity log entries.", + "summary": "Bulk response for editing two attributes.", + "description": "The bulk response includes a response item for each request sent.", "value": { - "itemType": "activityLog", - "entries": [ + "data": [ { - "date": "2026-08-28T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Viewer" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "edit" + "status": 201, + "body": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + }, + "headers": { + "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } }, { - "date": "2026-08-27T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Explore", - "Server API" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "view" + "status": 200, + "body": { + "isMultiValued": false, + "defaultThresholdType": "exists", + "info": { + "typeCode": "DISC", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Metals (updated)", + "isMetaAttribute": false + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals (updated)", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + }, + "headers": {} } ] } @@ -6151,45 +4242,66 @@ }, "400": { "description": "Bad request" - }, - "403": { - "description": "Forbidden" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-identity}:aggregations": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { + "get": { "tags": [ - "Aggregation" + "Data" ], - "summary": "Runs an aggregation against the table.", - "operationId": "DatabaseAggregationForTableWithIdentity", + "summary": "Get a datum for a given database, table, record history, record version and attribute.", + "operationId": "GetDatumForVersionFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-identity", + "name": "record-history-guid", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -6201,7 +4313,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -6209,985 +4321,581 @@ ], "type": "string" } + }, + { + "name": "filterEmptyCells", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "filterEmptyRows", + "in": "query", + "schema": { + "type": "boolean" + } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 1": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 4": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "d4702209-f040-443b-a931-2d4dbefc8330", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "bfdcd8a9-9cef-4ab9-9673-0b5d4cd9ce4f", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "194070b6-6209-4be9-b7dc-1bab3953756b", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "examples": { + "Example 1": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 2": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 3": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 4": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" + "notApplicable": "applicable" + } + }, + "Example 5": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 6": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 7": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 8": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 9": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 10": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 1": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + } + }, + "404": { + "description": "Database, table, record history, record version, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get a datum for a given attribute and the latest version of a record history in given database and table.", + "operationId": "GetDatumForLatestFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "filterEmptyCells", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "filterEmptyRows", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 5": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "d4702209-f040-443b-a931-2d4dbefc8330", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "bfdcd8a9-9cef-4ab9-9673-0b5d4cd9ce4f", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "194070b6-6209-4be9-b7dc-1bab3953756b", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "examples": { + "Example 11": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 12": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 13": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 14": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 1": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "d4702209-f040-443b-a931-2d4dbefc8330", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "bfdcd8a9-9cef-4ab9-9673-0b5d4cd9ce4f", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "194070b6-6209-4be9-b7dc-1bab3953756b", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "notApplicable": "applicable" + } + }, + "Example 15": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 16": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 17": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" + "notApplicable": "applicable" + } + }, + "Example 18": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 19": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 20": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 1": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "d4702209-f040-443b-a931-2d4dbefc8330", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "bfdcd8a9-9cef-4ab9-9673-0b5d4cd9ce4f", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "194070b6-6209-4be9-b7dc-1bab3953756b", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - } } }, "404": { - "description": "Database or table not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:aggregations": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { + "get": { "tags": [ - "Aggregation" + "Data" ], - "summary": "Runs an aggregation against the table.", - "operationId": "DatabaseAggregationForTableWithGuid", + "summary": "Get a datum for a given database, record history, record version and attribute.", + "operationId": "GetDatumForVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -7199,7 +4907,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -7207,974 +4915,905 @@ ], "type": "string" } + }, + { + "name": "filterEmptyCells", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "filterEmptyRows", + "in": "query", + "schema": { + "type": "boolean" + } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "2a3b9d01-14e5-46e8-996e-c98de08d1826", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "6fa7182e-111e-4c9b-a6b5-36927f4acec1", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "fcddad54-43a6-4d00-9196-dab1d1d81148", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "examples": { + "Example 21": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 22": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 23": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 24": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" + "notApplicable": "applicable" + } + }, + "Example 25": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 26": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 27": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 28": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 29": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 30": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + } + }, + "404": { + "description": "Database, record history, record version, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get a datum for a given attribute and the latest version of a record history in given database.", + "operationId": "GetDatumForLatest", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "filterEmptyCells", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "filterEmptyRows", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" + "examples": { + "Example 31": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 32": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 33": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 34": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" + } + }, + "Example 35": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 36": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 37": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 38": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 39": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 40": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "2a3b9d01-14e5-46e8-996e-c98de08d1826", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "6fa7182e-111e-4c9b-a6b5-36927f4acec1", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "fcddad54-43a6-4d00-9196-dab1d1d81148", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + } + }, + "404": { + "description": "Database, record history, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get the binary data for a given database, table, record history, record version and attribute. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForVersionFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "2a3b9d01-14e5-46e8-996e-c98de08d1826", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "6fa7182e-111e-4c9b-a6b5-36927f4acec1", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "fcddad54-43a6-4d00-9196-dab1d1d81148", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "2a3b9d01-14e5-46e8-996e-c98de08d1826", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "6fa7182e-111e-4c9b-a6b5-36927f4acec1", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "fcddad54-43a6-4d00-9196-dab1d1d81148", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + "application/json": { + "schema": { + "type": "string", + "format": "binary" } } } + }, + "400": { + "description": "Attribute is not an exportable type" + }, + "404": { + "description": "Database, table, record history, record version, attribute or datum not found" } - }, + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get the binary data for a given attribute and the latest version of a record history in given database and table. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForLatestFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "Attribute is not an exportable type" + }, + "404": { + "description": "Database, table, record history, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get the binary data for a given database, record history, record version and attribute. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForVersion", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" } }, - "text/json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" + "type": "string", + "format": "binary" } } } }, + "400": { + "description": "Attribute is not an exportable type" + }, "404": { - "description": "Database or table not found" + "description": "Database, record history, record version, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}:aggregations": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { + "get": { "tags": [ - "Aggregation" + "Data" ], - "summary": "Runs an aggregation against the database.", - "operationId": "DatabaseAggregation", + "summary": "Get the binary data for a given attribute and the latest version of a record history in given database. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForLatest", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -8186,7 +5825,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -8194,2807 +5833,3209 @@ ], "type": "string" } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + "responses": { + "200": { + "description": "Ok", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "9c3cf2e3-3e05-425d-89c0-d11d97b90172", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "Attribute is not an exportable type" + }, + "404": { + "description": "Database, record history, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get a datum for a given database, table, record history, record version, tabular attribute, row and column.", + "operationId": "GetCellDatumForVersionFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "11e8bf26-1d8f-482b-be63-1f3afdb69684", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "examples": { + "Example 1": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 2": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } } + } + } + } + }, + "404": { + "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database and table.", + "operationId": "GetCellDatumForLatestFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "ca55423e-f595-43df-b7e3-26c2d227d237", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "examples": { + "Example 3": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 4": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } } + } + } + } + }, + "404": { + "description": "Database, table, record history, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get a datum for a given database, record history, record version, tabular attribute, row and column.", + "operationId": "GetCellDatumForVersion", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "examples": { + "Example 5": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 6": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } } } } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "9c3cf2e3-3e05-425d-89c0-d11d97b90172", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "11e8bf26-1d8f-482b-be63-1f3afdb69684", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "ca55423e-f595-43df-b7e3-26c2d227d237", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + } + }, + "404": { + "description": "Database, record history, record version, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database.", + "operationId": "GetCellDatumForLatest", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "examples": { + "Example 7": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 8": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } } } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + } + }, + "404": { + "description": "Database, record history, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get the binary data for a given database, table, record history, record version, tabular attribute, row and column. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForVersionFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "9c3cf2e3-3e05-425d-89c0-d11d97b90172", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "11e8bf26-1d8f-482b-be63-1f3afdb69684", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "ca55423e-f595-43df-b7e3-26c2d227d237", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "9c3cf2e3-3e05-425d-89c0-d11d97b90172", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "11e8bf26-1d8f-482b-be63-1f3afdb69684", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "ca55423e-f595-43df-b7e3-26c2d227d237", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + "application/json": { + "schema": { + "type": "string", + "format": "binary" } } } + }, + "400": { + "description": "Column is not an exportable type" + }, + "404": { + "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" } - }, + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database and table. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForLatestFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" + "type": "string", + "format": "binary" } } } }, + "400": { + "description": "Column is not an exportable type" + }, "404": { - "description": "Database not found" + "description": "Database, table, record history, tabular attribute, row, column or datum not found" } } } }, - "/v1alpha/integration-schemas/{schema}:aggregations": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { "tags": [ - "Aggregation" + "Data" ], - "summary": "Runs an aggregation against the integration schema.", - "operationId": "IntegrationAggregation", + "summary": "Get the binary data for a given database, record history, record version, tabular attribute, row and column. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForVersion", "parameters": [ { - "name": "schema", + "name": "database-key", "in": "path", "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "Column is not an exportable type" + }, + "404": { + "description": "Database, record history, record version, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForLatest", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "Column is not an exportable type" + }, + "404": { + "description": "Database, record history, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { + "put": { + "tags": [ + "Data" + ], + "summary": "Create or edit a datum for a given attribute and record history in a given database and table.", + "operationId": "SetDatumForAttributeFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "integer", + "value": 34 } }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "logical", + "value": true } }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "shortText", + "value": "TResistant to strong acid" } }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "discrete", + "discreteValues": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "guid": "00000583-0007-4fff-8fff-0083ffff0000" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "discrete", + "discreteValues": [ { - "criterionGuid": "7990b3a1-3a3a-43fa-a6d2-360bcaa2dbc3", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "443f8cbb-a753-4144-acd1-ffc8d74f9d3a", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false } }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "58796e02-0c74-40a3-9847-7243c18b33d4", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false } }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ + "setDatumType": "point", + "estimated": false, + "values": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "pointValue": 12.7 } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "point", + "estimated": false, + "values": [ { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8590536+00:00" } }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "7990b3a1-3a3a-43fa-a6d2-360bcaa2dbc3", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" } }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "443f8cbb-a753-4144-acd1-ffc8d74f9d3a", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } } }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "tabular", + "rows": [ { - "criterionGuid": "58796e02-0c74-40a3-9847-7243c18b33d4", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } } } }, - "text/json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "integer", + "value": 34 } }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "logical", + "value": true } }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "shortText", + "value": "TResistant to strong acid" } }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "discrete", + "discreteValues": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "guid": "00000583-0007-4fff-8fff-0083ffff0000" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "discrete", + "discreteValues": [ { - "criterionGuid": "7990b3a1-3a3a-43fa-a6d2-360bcaa2dbc3", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "443f8cbb-a753-4144-acd1-ffc8d74f9d3a", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false } }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ { - "criterionGuid": "58796e02-0c74-40a3-9847-7243c18b33d4", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" + "pointValue": 12.7 } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ + "setDatumType": "point", + "estimated": false, + "values": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] + } + }, + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8590536+00:00" + } + }, + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + }, + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] } } } }, - "application/*+json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "integer", + "value": 34 } }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "setDatumType": "logical", + "value": true } }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "guid": "00000583-0007-4fff-8fff-0083ffff0000" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "discrete", + "discreteValues": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ { - "criterionGuid": "7990b3a1-3a3a-43fa-a6d2-360bcaa2dbc3", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" + "pointValue": 12.7 } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "point", + "estimated": false, + "values": [ { - "criterionGuid": "443f8cbb-a753-4144-acd1-ffc8d74f9d3a", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8590536+00:00" + } + }, + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + }, + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ { - "criterionGuid": "58796e02-0c74-40a3-9847-7243c18b33d4", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } } } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - } - } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/blob-infos/dataupdater": { - "get": { - "tags": [ - "BlobInfos" - ], - "summary": "Get a list of all blob descriptors for databases that the user is admin of.", - "operationId": "GetAllDataUpdaterBlobInfos", + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] + } + }, + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8590536+00:00" + } + }, + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + }, + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } + } + } + } + } + }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 2": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 3": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 4": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" + } + }, + "Example 5": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 6": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 7": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 8": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 9": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 10": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history or attribute not found" + }, + "422": { + "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." } } - } - }, - "/v1alpha/blob-infos/dataupdater/{database-key}/{blob-path}": { - "get": { + }, + "delete": { "tags": [ - "BlobInfos" + "Data" ], - "summary": "Get a list of blob descriptors for a specific database, optionally limited by their relative path.", - "operationId": "GetDataUpdaterBlobInfos", + "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database and table.", + "operationId": "DeleteDatumForAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database key.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "blob-path", + "name": "table-guid", "in": "path", - "description": "Path to look under (without the blob name). Can be empty", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "recursive", - "in": "query", - "description": "Whether to look under sub-paths as well.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - } - } - } - } - } - }, - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}": { - "get": { - "tags": [ - "Blobs" - ], - "summary": "Retrieve DataUpdater blob contents by its path.", - "operationId": "DownloadDataUpdaterBlob", - "parameters": [ - { - "name": "database-key", + "name": "record-history-guid", "in": "path", - "description": "Database key", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "blobPath", + "name": "attribute-guid", "in": "path", - "description": "Blob path to a single blob (including its name).", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Blob not found" + "description": "Database, table, record history, attribute or datum not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { "put": { "tags": [ - "Blobs" + "Data" ], - "summary": "Store DataUpdater blob contents.", - "operationId": "UploadDataUpdaterBlob", + "summary": "Create or edit a datum for a given attribute and record history in a given database.", + "operationId": "SetDatumForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database key", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "blobPath", - "in": "path", - "description": "Blob path to a single blob (including its name).", "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Blobs" - ], - "summary": "Delete DataUpdater blob.", - "operationId": "DeleteDataUpdaterBlob", - "parameters": [ + }, { - "name": "database-key", + "name": "record-history-guid", "in": "path", - "description": "Database key", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "blobPath", + "name": "attribute-guid", "in": "path", - "description": "Blob path to a single blob (including its name).", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/v1alpha/bulk": { - "post": { - "tags": [ - "Bulk" - ], - "summary": "Handles multiple requests.\r\nThe requests should be independent - they could be executed in any order.\r\nThe response will contain a response item for each request item, in the same order as the request items.\r\nRequests that return file or image responses cannot be sent via the bulk endpoint.", - "operationId": "Bulk", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } - }, + "setDatumType": "integer", + "value": 34 + } + }, + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } + "guid": "00000583-0007-4fff-8fff-0083ffff0000" } ] } }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "requests": [ + "setDatumType": "discrete", + "discreteValues": [ { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" - }, - "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", + }, + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } - }, + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } + "pointValue": 12.7 } ] } }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" - }, + "setDatumType": "point", + "estimated": false, + "values": [ { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" - }, - "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", + }, + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", "value": { - "requests": [ + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.885855+00:00" + } + }, + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } + "linkingValue": "85535-84-8" }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } + "linkingValue": "1327-53-3" } ] } }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "requests": [ + "setDatumType": "tabular", + "rows": [ { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" } ] } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } - }, + "setDatumType": "integer", + "value": 34 + } + }, + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } + "guid": "00000583-0007-4fff-8fff-0083ffff0000" } ] } }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "requests": [ + "setDatumType": "discrete", + "discreteValues": [ { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" }, { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaBulkInfo" }, - "examples": { - "Example 1": { - "summary": "Bulk response for editing two attributes.", - "description": "The bulk response includes a response item for each request sent.", - "value": { - "data": [ - { - "status": 201, - "body": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } }, - "headers": { - "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - { - "status": 200, - "body": { - "isMultiValued": false, - "defaultThresholdType": "exists", - "info": { - "typeCode": "DISC", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Metals (updated)", - "isMetaAttribute": false + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" }, - "name": "Metals (updated)", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } }, - "headers": {} - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkInfo" - }, - "examples": { - "Example 1": { - "summary": "Bulk response for editing two attributes.", - "description": "The bulk response includes a response item for each request sent.", - "value": { - "data": [ - { - "status": 201, - "body": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - }, - "headers": { - "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } } - }, - { - "status": 200, - "body": { - "isMultiValued": false, - "defaultThresholdType": "exists", - "info": { - "typeCode": "DISC", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Metals (updated)", - "isMetaAttribute": false - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Metals (updated)", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - }, - "headers": {} - } - ] + ] + } + ] + } + }, + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.885855+00:00" + } + }, + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkInfo" + "examples": { + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } }, - "examples": { - "Example 1": { - "summary": "Bulk response for editing two attributes.", - "description": "The bulk response includes a response item for each request sent.", - "value": { - "data": [ - { - "status": 201, - "body": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } }, - "headers": { - "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - { - "status": 200, - "body": { - "isMultiValued": false, - "defaultThresholdType": "exists", - "info": { - "typeCode": "DISC", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Metals (updated)", - "isMetaAttribute": false + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" }, - "name": "Metals (updated)", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } }, - "headers": {} - } - ] - } + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] } - } - } - } - }, - "400": { - "description": "Bad request" - } - } - } - }, - "/v1alpha/currencies": { - "get": { - "tags": [ - "Currencies" - ], - "summary": "All the currencies configured on the server.", - "operationId": "GetCurrencies", - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrenciesInfo" }, - "examples": { - "Example 1": { - "summary": "Currencies", - "description": "Example of currencies", - "value": { - "currencies": [ - { - "code": "GBP", - "name": "Pound Sterling", - "factor": 0.754 - }, - { - "code": "USD", - "name": "US Dollar", - "factor": 1.0 - }, - { - "code": "CHF", - "name": "Swiss Franc", - "factor": 0.814 - } - ] - } + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.885855+00:00" } - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/currencies/{currencyCode}": { - "get": { - "tags": [ - "Currencies" - ], - "summary": "Gets the currency with the specified code.", - "operationId": "GetCurrency", - "parameters": [ - { - "name": "currencyCode", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrency" }, - "examples": { - "Example 1": { - "summary": "US Dollar", - "description": "Example of US Dollar currency", - "value": { - "code": "USD", - "name": "US Dollar", - "factor": 1.0 - } - }, - "Example 2": { - "summary": "Pound Sterling", - "description": "Example of Pound Sterling currency", - "value": { - "code": "GBP", - "name": "Pound Sterling", - "factor": 0.754 + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] + } + }, + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.885855+00:00" + } + }, + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } } } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Currency not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given database, table, record history, record version and attribute.", - "operationId": "GetDatumForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "filterEmptyCells", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "filterEmptyRows", - "in": "query", - "schema": { - "type": "boolean" } } - ], + }, "responses": { "200": { "description": "Ok", @@ -11004,7 +9045,7 @@ "$ref": "#/components/schemas/GsaDatum" }, "examples": { - "Example 1": { + "Example 11": { "summary": "Integer datum.", "description": "Example response for an integer datum with a value of 7.", "value": { @@ -11013,7 +9054,7 @@ "notApplicable": "applicable" } }, - "Example 2": { + "Example 12": { "summary": "Logical datum.", "description": "Example response for a logical datum with a value of 'true'", "value": { @@ -11022,7 +9063,7 @@ "notApplicable": "applicable" } }, - "Example 3": { + "Example 13": { "summary": "Short Text datum.", "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", "value": { @@ -11031,7 +9072,7 @@ "notApplicable": "applicable" } }, - "Example 4": { + "Example 14": { "summary": "Long Text datum.", "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", "value": { @@ -11043,7 +9084,7 @@ "notApplicable": "applicable" } }, - "Example 5": { + "Example 15": { "summary": "Hyperlink datum.", "description": "Example response for a hyperlink datum with a value of localhost", "value": { @@ -11054,7 +9095,7 @@ "notApplicable": "applicable" } }, - "Example 6": { + "Example 16": { "summary": "DateTime datum.", "description": "Example response for a DateTime datum with a value of January 1st, 2000", "value": { @@ -11063,19 +9104,15 @@ "notApplicable": "applicable" } }, - "Example 7": { + "Example 17": { "summary": "Range datum.", "description": "Example response for a range datum with both low and high range values set", "value": { "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, "estimated": false, "unit": { "symbol": "MPa", @@ -11084,15 +9121,15 @@ "notApplicable": "applicable" } }, - "Example 8": { + "Example 18": { "summary": "Range datum - low bound only.", "description": "Example response for a range datum with only the low range value set", "value": { "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, "estimated": false, "unit": { "symbol": "MPa", @@ -11101,7 +9138,7 @@ "notApplicable": "applicable" } }, - "Example 9": { + "Example 19": { "summary": "Point datum - single valued.", "description": "Example response for a single valued point datum", "value": { @@ -11119,7 +9156,7 @@ "notApplicable": "applicable" } }, - "Example 10": { + "Example 20": { "summary": "Point datum - multi valued with parameters.", "description": "Example response for a multi valued point datum with parameters", "value": { @@ -11157,7 +9194,6 @@ "parameterValue": { "type": "discrete", "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" } } @@ -11195,7 +9231,6 @@ "parameterValue": { "type": "discrete", "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" } } @@ -11210,129 +9245,549 @@ } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table, record history, record version, attribute or datum not found" + "description": "Database, record history or attribute not found" + }, + "422": { + "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { - "get": { + }, + "delete": { "tags": [ "Data" ], - "summary": "Get a datum for a given attribute and the latest version of a record history in given database and table.", - "operationId": "GetDatumForLatestFromTable", + "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database.", + "operationId": "DeleteDatumForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, record history, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "put": { + "tags": [ + "Data" + ], + "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "SetCellDatumForTabularAttributeFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "attribute-guid", + "name": "table-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "record-history-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "filterEmptyCells", - "in": "query", + "name": "row-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } }, { - "name": "filterEmptyRows", - "in": "query", + "name": "column-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } }, - "examples": { - "Example 11": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 12": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8913663+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8913663+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8913663+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8913663+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 21": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" } }, - "Example 13": { + "Example 22": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 23": { "summary": "Short Text datum.", "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", "value": { @@ -11341,7 +9796,7 @@ "notApplicable": "applicable" } }, - "Example 14": { + "Example 24": { "summary": "Long Text datum.", "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", "value": { @@ -11353,7 +9808,7 @@ "notApplicable": "applicable" } }, - "Example 15": { + "Example 25": { "summary": "Hyperlink datum.", "description": "Example response for a hyperlink datum with a value of localhost", "value": { @@ -11364,7 +9819,7 @@ "notApplicable": "applicable" } }, - "Example 16": { + "Example 26": { "summary": "DateTime datum.", "description": "Example response for a DateTime datum with a value of January 1st, 2000", "value": { @@ -11373,19 +9828,15 @@ "notApplicable": "applicable" } }, - "Example 17": { + "Example 27": { "summary": "Range datum.", "description": "Example response for a range datum with both low and high range values set", "value": { "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, "estimated": false, "unit": { "symbol": "MPa", @@ -11394,15 +9845,15 @@ "notApplicable": "applicable" } }, - "Example 18": { + "Example 28": { "summary": "Range datum - low bound only.", "description": "Example response for a range datum with only the low range value set", "value": { "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, "estimated": false, "unit": { "symbol": "MPa", @@ -11411,7 +9862,7 @@ "notApplicable": "applicable" } }, - "Example 19": { + "Example 29": { "summary": "Point datum - single valued.", "description": "Example response for a single valued point datum", "value": { @@ -11429,7 +9880,7 @@ "notApplicable": "applicable" } }, - "Example 20": { + "Example 30": { "summary": "Point datum - multi valued with parameters.", "description": "Example response for a multi valued point datum with parameters", "value": { @@ -11467,7 +9918,6 @@ "parameterValue": { "type": "discrete", "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" } } @@ -11505,7 +9955,6 @@ "parameterValue": { "type": "discrete", "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" } } @@ -11520,29 +9969,39 @@ } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database, table, record history, tabular attribute, row or column not found" } } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { - "get": { + }, + "delete": { "tags": [ "Data" ], - "summary": "Get a datum for a given database, record history, record version and attribute.", - "operationId": "GetDatumForVersion", + "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "DeleteCellDatumForTabularAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { @@ -11555,7 +10014,7 @@ } }, { - "name": "record-version-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -11564,153 +10023,576 @@ } }, { - "name": "attribute-guid", + "name": "row-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "column-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "put": { + "tags": [ + "Data" + ], + "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "SetCellDatumForTabularAttribute", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "filterEmptyCells", - "in": "query", + "name": "record-history-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } }, { - "name": "filterEmptyRows", - "in": "query", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } }, - "examples": { - "Example 21": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 22": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 23": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 24": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 25": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 26": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 27": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8947463+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8947463+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8947463+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-08-29T02:14:07.8947463+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 31": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 32": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 33": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 34": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" }, "notApplicable": "applicable" } }, - "Example 28": { + "Example 35": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 36": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 37": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 38": { "summary": "Range datum - low bound only.", "description": "Example response for a range datum with only the low range value set", "value": { "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, "estimated": false, "unit": { "symbol": "MPa", @@ -11719,7 +10601,7 @@ "notApplicable": "applicable" } }, - "Example 29": { + "Example 39": { "summary": "Point datum - single valued.", "description": "Example response for a single valued point datum", "value": { @@ -11737,7 +10619,7 @@ "notApplicable": "applicable" } }, - "Example 30": { + "Example 40": { "summary": "Point datum - multi valued with parameters.", "description": "Example response for a multi valued point datum with parameters", "value": { @@ -11775,7 +10657,6 @@ "parameterValue": { "type": "discrete", "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" } } @@ -11813,7 +10694,6 @@ "parameterValue": { "type": "discrete", "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" } } @@ -11828,29 +10708,30 @@ } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, record history, record version, attribute or datum not found" + "description": "Database, record history, tabular attribute, row or column not found" } } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { - "get": { + }, + "delete": { "tags": [ "Data" ], - "summary": "Get a datum for a given attribute and the latest version of a record history in given database.", - "operationId": "GetDatumForLatest", + "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "DeleteCellDatumForTabularAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -11865,302 +10746,167 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "row-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, record history, tabular attribute, row, column or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { + "put": { + "tags": [ + "Data" + ], + "summary": "Create or edit a file datum for a given attribute and record history in a given database and table.", + "operationId": "SetFileDatumForAttributeFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "filterEmptyCells", - "in": "query", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } }, { - "name": "filterEmptyRows", - "in": "query", + "name": "record-history-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } - } - ], - "responses": { + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" + }, + "Description": { + "type": "string", + "description": "File description." + }, + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." + }, + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" + } + } + } + } + }, + "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 31": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 32": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 33": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 34": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 35": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 36": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 37": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 38": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 39": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 40": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } + "$ref": "#/components/schemas/GsaFileDatum" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, record history, attribute or datum not found" + "description": "Database, table, record history or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { + "put": { "tags": [ "Data" ], - "summary": "Get the binary data for a given database, table, record history, record version and attribute. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForVersionFromTable", + "summary": "Create or edit a file datum for a given attribute and record history in a given database.", + "operationId": "SetFileDatumForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { @@ -12172,122 +10918,103 @@ "format": "uuid" } }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" + }, + "Description": { + "type": "string", + "description": "File description." + }, + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." + }, + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaFileDatum" } } - }, - "x-is-file": true + } }, "400": { - "description": "Attribute is not an exportable type" + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history, record version, attribute or datum not found" + "description": "Database, record history or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { + "put": { "tags": [ "Data" ], - "summary": "Get the binary data for a given attribute and the latest version of a record history in given database and table. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForLatestFromTable", + "summary": "Create or edit a picture datum for a given attribute and record history in a given database and table.", + "operationId": "SetPictureDatumForAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -12303,100 +11030,74 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaPictureDatum" } } - }, - "x-is-file": true + } }, "400": { - "description": "Attribute is not an exportable type" + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database, table, record history or attribute not found" + }, + "415": { + "description": "Invalid image file" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { + "put": { "tags": [ "Data" ], - "summary": "Get the binary data for a given database, record history, record version and attribute. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForVersion", + "summary": "Create or edit a picture datum for a given attribute and record history in a given database.", + "operationId": "SetPictureDatumForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -12408,116 +11109,81 @@ "format": "uuid" } }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaPictureDatum" } } - }, - "x-is-file": true + } }, "400": { - "description": "Attribute is not an exportable type" + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, record history, record version, attribute or datum not found" + "description": "Database, record history or attribute not found" + }, + "415": { + "description": "Invalid image file" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { + "put": { "tags": [ "Data" ], - "summary": "Get the binary data for a given attribute and the latest version of a record history in given database. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForLatest", + "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "SetCellFileDatumForTabularAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "record-history-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -12526,113 +11192,121 @@ } }, { - "name": "attribute-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "maxWidth", - "in": "query", + "name": "row-guid", + "in": "path", + "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" } }, { - "name": "maxHeight", - "in": "query", + "name": "column-guid", + "in": "path", + "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" + }, + "Description": { + "type": "string", + "description": "File description." + }, + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." + }, + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaFileDatum" } } - }, - "x-is-file": true + } }, "400": { - "description": "Attribute is not an exportable type" + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, record history, attribute or datum not found" + "description": "Database, table, record history, tabular attribute, row or column not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { + "put": { "tags": [ "Data" ], - "summary": "Get a datum for a given database, table, record history, record version, tabular attribute, row and column.", - "operationId": "GetCellDatumForVersionFromTable", + "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "SetCellFileDatumForTabularAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { @@ -12644,23 +11318,12 @@ "format": "uuid" } }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, @@ -12681,96 +11344,95 @@ "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" + }, + "Description": { + "type": "string", + "description": "File description." + }, + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." + }, + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 2": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } + "$ref": "#/components/schemas/GsaFileDatum" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" + "description": "Database, record history, tabular attribute, row or column not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { + "put": { "tags": [ "Data" ], - "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database and table.", - "operationId": "GetCellDatumForLatestFromTable", + "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "SetCellPictureDatumForTabularAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -12786,11 +11448,9 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, @@ -12811,86 +11471,69 @@ "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 3": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 4": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } + "$ref": "#/components/schemas/GsaPictureDatum" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table, record history, tabular attribute, row, column or datum not found" + "description": "Database, table, record history, tabular attribute, row or column not found" + }, + "415": { + "description": "Invalid image file" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { + "put": { "tags": [ "Data" ], - "summary": "Get a datum for a given database, record history, record version, tabular attribute, row and column.", - "operationId": "GetCellDatumForVersion", + "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "SetCellPictureDatumForTabularAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -12902,23 +11545,12 @@ "format": "uuid" } }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, @@ -12939,90 +11571,73 @@ "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 5": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 6": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } + "$ref": "#/components/schemas/GsaPictureDatum" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, record history, record version, tabular attribute, row, column or datum not found" + "description": "Database, record history, tabular attribute, row or column not found" + }, + "415": { + "description": "Invalid image file" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { + "post": { "tags": [ "Data" ], - "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database.", - "operationId": "GetCellDatumForLatest", + "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database and table.", + "operationId": "SetDatumNotApplicableFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "record-history-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -13031,124 +11646,51 @@ } }, { - "name": "attribute-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "row-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 7": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 8": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } - } - } - } + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, record history, tabular attribute, row, column or datum not found" + "description": "Database, table, record history or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { + "post": { "tags": [ "Data" ], - "summary": "Get the binary data for a given database, table, record history, record version, tabular attribute, row and column. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForVersionFromTable", + "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database.", + "operationId": "SetDatumNotApplicable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { @@ -13160,140 +11702,51 @@ "format": "uuid" } }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } } ], "responses": { "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true + "description": "Ok" }, - "400": { - "description": "Column is not an exportable type" + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" + "description": "Database, record history or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { + "post": { "tags": [ "Data" ], - "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database and table. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForLatestFromTable", + "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database and table.", + "operationId": "AppendValuesForDiscreteAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -13309,253 +11762,194 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 1": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 2": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" + "examples": { + "Example 1": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 2": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } } } }, - "x-is-file": true - }, - "400": { - "description": "Column is not an exportable type" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given database, record history, record version, tabular attribute, row and column. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 1": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 2": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 1": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 2": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + } + } } } - ], + }, "responses": { "200": { "description": "Ok", "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaDiscreteDatum" } } - }, - "x-is-file": true + } }, "400": { - "description": "Column is not an exportable type" + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, record history, record version, tabular attribute, row, column or datum not found" + "description": "Database, table, record history, discrete attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { + "post": { "tags": [ "Data" ], - "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForLatest", + "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database.", + "operationId": "AppendValuesForDiscreteAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -13570,128 +11964,202 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 3": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 4": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 3": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 4": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 3": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 4": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 3": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] + } + }, + "Example 4": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaDiscreteDatum" } } - }, - "x-is-file": true + } }, "400": { - "description": "Column is not an exportable type" + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, record history, tabular attribute, row, column or datum not found" + "description": "Database, record history, discrete attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { - "put": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { + "post": { "tags": [ "Data" ], - "summary": "Create or edit a datum for a given attribute and record history in a given database and table.", - "operationId": "SetDatumForAttributeFromTable", + "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database and table.", + "operationId": "AppendValuesForPointAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -13707,11 +12175,9 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } @@ -13720,113 +12186,49 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 12.7 + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "Example 2": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 1.26, + "pointValue": 1190.0, "parametersAndValues": [ { "parameter": { @@ -13834,24 +12236,24 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 273.16 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } } } ] }, { - "pointValue": 1.31, + "pointValue": 1240.0, "parametersAndValues": [ { "parameter": { @@ -13859,86 +12261,46 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 293.56 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" } } } ] - } - ] - } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9162716+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" }, { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } ] } @@ -13947,113 +12309,49 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "discrete", - "discreteValues": [ + "values": [ { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 2": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, + "values": [ { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, + "pointValue": 1190.0, "parametersAndValues": [ { "parameter": { @@ -14061,24 +12359,24 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 273.16 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } } } ] }, { - "pointValue": 1.31, + "pointValue": 1240.0, "parametersAndValues": [ { "parameter": { @@ -14086,86 +12384,46 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 293.56 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" } } } ] - } - ] - } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9162716+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" }, { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } ] } @@ -14174,113 +12432,49 @@ }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 12.7 + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "Example 2": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 1.26, + "pointValue": 1190.0, "parametersAndValues": [ { "parameter": { @@ -14288,24 +12482,24 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 273.16 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } } } ] }, { - "pointValue": 1.31, + "pointValue": 1240.0, "parametersAndValues": [ { "parameter": { @@ -14313,86 +12507,46 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 293.56 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" } } } ] - } - ] - } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9162716+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" }, { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } ] } @@ -14401,113 +12555,49 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 12.7 + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "Example 2": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 1.26, + "pointValue": 1190.0, "parametersAndValues": [ { "parameter": { @@ -14515,24 +12605,24 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 273.16 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } } } ] }, { - "pointValue": 1.31, + "pointValue": 1240.0, "parametersAndValues": [ { "parameter": { @@ -14540,17 +12630,42 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 293.56 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] + }, + { + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" } } } @@ -14558,71 +12673,6 @@ } ] } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9162716+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } } } } @@ -14634,211 +12684,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 2": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 3": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 4": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 5": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 6": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 7": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 8": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 9": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 10": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } + "$ref": "#/components/schemas/GsaPointDatum" } } } @@ -14850,93 +12696,25 @@ "description": "Forbidden" }, "404": { - "description": "Database, table, record history or attribute not found" - }, - "422": { - "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." - } - } - }, - "delete": { - "tags": [ - "Data" - ], - "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database and table.", - "operationId": "DeleteDatumForAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database, table, record history, point attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { - "put": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { + "post": { "tags": [ "Data" ], - "summary": "Create or edit a datum for a given attribute and record history in a given database.", - "operationId": "SetDatumForAttribute", + "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database.", + "operationId": "AppendValuesForPointAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -14951,11 +12729,9 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } @@ -14964,113 +12740,49 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 12.7 + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 1.26, + "pointValue": 1190.0, "parametersAndValues": [ { "parameter": { @@ -15078,24 +12790,24 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 273.16 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } } } ] }, { - "pointValue": 1.31, + "pointValue": 1240.0, "parametersAndValues": [ { "parameter": { @@ -15103,17 +12815,42 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 293.56 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] + }, + { + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" } } } @@ -15121,183 +12858,177 @@ } ] } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9373059+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, + "values": [ { - "linkingValue": "1327-53-3" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "tabular", - "rows": [ + "values": [ { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] }, { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] }, { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } ] } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 12.7 + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 1.26, + "pointValue": 1190.0, "parametersAndValues": [ { "parameter": { @@ -15305,24 +13036,24 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 273.16 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } } } ] }, { - "pointValue": 1.31, + "pointValue": 1240.0, "parametersAndValues": [ { "parameter": { @@ -15330,201 +13061,97 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 293.56 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" } } } ] - } - ] - } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9373059+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" }, { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } ] } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 12.7 + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } ] } }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "setDatumType": "point", - "estimated": false, "values": [ { - "pointValue": 1.26, + "pointValue": 1190.0, "parametersAndValues": [ { "parameter": { @@ -15532,24 +13159,24 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 273.16 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } } } ] }, { - "pointValue": 1.31, + "pointValue": 1240.0, "parametersAndValues": [ { "parameter": { @@ -15557,17 +13184,42 @@ }, "parameterValue": { "parameterType": "numeric", - "parameterValue": 293.56 + "parameterValue": 293.0 } }, { "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" }, "parameterValue": { "parameterType": "discrete", "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] + }, + { + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" } } } @@ -15575,298 +13227,6 @@ } ] } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9373059+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9373059+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } } } } @@ -15878,211 +13238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 11": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 12": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 13": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 14": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 15": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 16": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 17": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 18": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 19": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 20": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } + "$ref": "#/components/schemas/GsaPointDatum" } } } @@ -16094,1899 +13250,2829 @@ "description": "Forbidden" }, "404": { - "description": "Database, record history or attribute not found" - }, - "422": { - "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." + "description": "Database, record history, point attribute or datum not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}:search-index-status": { + "get": { "tags": [ - "Data" + "Database" ], - "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database.", - "operationId": "DeleteDatumForAttribute", + "summary": "Get Search Index Status for a given database", + "operationId": "GetSearchIndexStatus", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", + "description": "", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, + "name": "include-errors", + "in": "query", + "description": "", "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "type": "boolean" } } ], "responses": { "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "put": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchIndexStatus" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchIndexStatus" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchIndexStatus" + } + } + } + }, + "403": { + "description": "Forbidden is returned if include diagnostics is requested and the current user is not an administrator" + }, + "404": { + "description": "Database key not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-identity}:generate-integration-schema": { + "get": { "tags": [ - "Data" + "Database" ], - "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "SetCellDatumForTabularAttributeFromTable", + "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "table-identity", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } } }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-name}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromTableName", + "parameters": [ { - "name": "record-history-guid", + "name": "database-key", "in": "path", + "description": "", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "attribute-guid", + "name": "table-name", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", + "description": "", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-identity}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayout", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" } }, { - "name": "row-guid", + "name": "table-identity", "in": "path", + "description": "", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "integer", + "format": "int32" } }, { - "name": "column-guid", + "name": "layout-identity", "in": "path", + "description": "", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-identity}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayoutWithTableName", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "layout-identity", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-name}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayoutName", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-identity", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "layout-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-name}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayoutNameWithTableName", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "layout-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/standard-names:generate-integration-schema": { + "post": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema with attributes for each provided standard name in the given database. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromStandardNames", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" } } ], "requestBody": { + "description": "", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9432929+00:00" - } - }, - "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } + "type": "array", + "items": { + "type": "string" } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9432929+00:00" - } - }, - "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } + "type": "array", + "items": { + "type": "string" } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9432929+00:00" - } - }, - "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/standard-names:generate-integration-schema": { + "post": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema with attributes for each provided standard name. This will include attribute from all loaded databases for which the user is an Admin.", + "operationId": "GenerateSchemaFromStandardNamesAllDatabases", + "requestBody": { + "description": "", + "content": { + "application/json-patch+json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}:export": { + "post": { + "tags": [ + "DataExport" + ], + "summary": "Export data from the given database.", + "operationId": "ExportData", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportRequest" }, "examples": { "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", "value": { - "setDatumType": "integer", - "value": 34 + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] } }, "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "setDatumType": "logical", - "value": true + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] } }, "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] } }, "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "setDatumType": "point", - "estimated": false, - "values": [ + "attributes": [ { - "pointValue": 12.7 + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" ] } }, "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9432929+00:00" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] } }, "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" }, - "examples": { - "Example 21": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 22": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 23": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 24": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 25": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 26": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 27": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 28": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + "Example 9": { + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" }, - "notApplicable": "applicable" - } - }, - "Example 29": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 30": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row or column not found" - } - } - }, - "delete": { - "tags": [ - "Data" - ], - "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "DeleteCellDatumForTabularAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "SetCellDatumForTabularAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { + }, "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", "value": { - "setDatumType": "integer", - "value": 34 + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", "value": { - "setDatumType": "logical", - "value": true + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + } + ], + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" + } + ], + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", "value": { - "setDatumType": "point", - "estimated": false, - "values": [ + "attributes": [ { - "pointValue": 12.7 + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" + }, + { + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + } + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" ] } - }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9462947+00:00" - } - }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaDataExportRequest" }, "examples": { - "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", "value": { - "setDatumType": "integer", - "value": 34 + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] } }, - "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "setDatumType": "logical", - "value": true + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] } }, - "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", + "Example 3": { + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, - "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "Example 4": { + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, - "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "Example 5": { + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] } }, - "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "Example 6": { + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "setDatumType": "point", - "estimated": false, - "values": [ + "attributes": [ { - "pointValue": 12.7 + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" ] } }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "Example 7": { + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9462947+00:00" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] } }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "Example 8": { + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] } }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", + "Example 9": { + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", "value": { - "setDatumType": "integer", - "value": 34 + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, - "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", + "Example 10": { + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", "value": { - "setDatumType": "logical", - "value": true + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 11": { + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + } + ], + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" + } + ], + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", "value": { - "setDatumType": "point", - "estimated": false, - "values": [ + "attributes": [ { - "pointValue": 12.7 + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" + }, + { + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + } + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" ] } - }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9462947+00:00" - } - }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } } } }, - "application/*+json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSetDatum" + "$ref": "#/components/schemas/GsaDataExportRequest" }, "examples": { - "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", "value": { - "setDatumType": "integer", - "value": 34 + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] } }, - "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "setDatumType": "logical", - "value": true + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] } }, - "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", + "Example 3": { + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, - "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "Example 4": { + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, - "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "Example 5": { + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false + "attributes": [ + { + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] } }, - "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "Example 6": { + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "setDatumType": "point", - "estimated": false, - "values": [ + "attributes": [ { - "pointValue": 12.7 + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" ] } }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "Example 7": { + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "setDatumType": "datetime", - "value": "2026-08-28T02:22:26.9462947+00:00" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] } }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "Example 8": { + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] } }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "Example 9": { + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" }, - "examples": { - "Example 31": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 32": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 33": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 34": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 35": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 36": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 37": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 38": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + "Example 10": { + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" }, - "notApplicable": "applicable" - } - }, - "Example 39": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" } - } - ], - "notApplicable": "applicable" - } - }, - "Example 40": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 11": { + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 12": { + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" } - } - ] + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 13": { + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + } + ], + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 14": { + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" + } + ], + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 15": { + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } + { + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" } + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" + ] } } } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, tabular attribute, row or column not found" - } - } - }, - "delete": { - "tags": [ - "Data" - ], - "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "DeleteCellDatumForTabularAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a file datum for a given attribute and record history in a given database and table.", - "operationId": "SetFileDatumForAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { + }, + "application/*+json": { "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." - } - } + "$ref": "#/components/schemas/GsaDataExportRequest" }, - "encoding": { - "File": { - "style": "form" + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] + } }, - "Description": { - "style": "form" + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] + } }, - "Target": { - "style": "form" + "Example 3": { + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } }, - "AllowIndex": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a file datum for a given attribute and record history in a given database.", - "operationId": "SetFileDatumForAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + "Example 4": { + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", + "value": { + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } - } - }, - "encoding": { - "File": { - "style": "form" }, - "Description": { - "style": "form" + "Example 5": { + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] + } }, - "Target": { - "style": "form" + "Example 6": { + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } }, - "AllowIndex": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a picture datum for a given attribute and record history in a given database and table.", - "operationId": "SetPictureDatumForAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" + "Example 7": { + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] + } + }, + "Example 8": { + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] + } + }, + "Example 9": { + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 10": { + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 11": { + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 12": { + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 13": { + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + } + ], + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 14": { + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" + } + ], + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 15": { + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" + }, + { + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + } + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" + ] } - } - }, - "encoding": { - "Picture": { - "style": "form" } } } @@ -17994,223 +16080,246 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" } } } }, - "400": { - "description": "Bad request" + "404": { + "description": "Database not found" }, "403": { "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or attribute not found" - }, - "415": { - "description": "Invalid image file" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { - "put": { + "/v1alpha/integration-schemas/{schema}:export": { + "post": { "tags": [ - "Data" + "DataExport" ], - "summary": "Create or edit a picture datum for a given attribute and record history in a given database.", - "operationId": "SetPictureDatumForAttribute", + "summary": "Export data from the integration schema.", + "operationId": "ExportDataFromIntegrationSchema", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", + "name": "schema", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "type": "string" } } ], "requestBody": { "content": { - "multipart/form-data": { + "application/json-patch+json": { "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" - } - } + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" }, - "encoding": { - "Picture": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", + "value": { + "recordReferences": [ + { + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" + }, + { + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } + }, + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", + "value": { + "recordReferences": [ + { + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + }, + { + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } } } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history or attribute not found" - }, - "415": { - "description": "Invalid image file" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "SetCellFileDatumForTabularAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { + }, + "application/json": { "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" + }, + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", + "value": { + "recordReferences": [ + { + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" + }, + { + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } + }, + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", + "value": { + "recordReferences": [ + { + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + }, + { + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] } } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" }, - "encoding": { - "File": { - "style": "form" - }, - "Description": { - "style": "form" + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", + "value": { + "recordReferences": [ + { + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" + }, + { + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } }, - "Target": { - "style": "form" + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", + "value": { + "recordReferences": [ + { + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + }, + { + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" + }, + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", + "value": { + "recordReferences": [ + { + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" + }, + { + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } }, - "AllowIndex": { - "style": "form" + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", + "value": { + "recordReferences": [ + { + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + }, + { + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } } } } @@ -18218,48 +16327,52 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileDatum" + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" } } } }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table, record history, tabular attribute, row or column not found" + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { - "put": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { + "get": { "tags": [ - "Data" + "Graph" ], - "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "SetCellFileDatumForTabularAttribute", + "summary": "Get the graph for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForVersionFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "record-history-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -18268,18 +16381,16 @@ } }, { - "name": "attribute-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "row-guid", + "name": "record-version-guid", "in": "path", "required": true, "schema": { @@ -18288,107 +16399,188 @@ } }, { - "name": "column-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." - } - } - }, - "encoding": { - "File": { - "style": "form" - }, - "Description": { - "style": "form" - }, - "Target": { - "style": "form" - }, - "AllowIndex": { - "style": "form" - } - } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } - }, + ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileDatum" + "$ref": "#/components/schemas/GsaGraph" + }, + "examples": { + "Example 1": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "value": { + "functionalType": "float", + "series": [ + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + }, + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + } + ], + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + "constraintParameters": [ + { + "type": "numeric", + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "numberOfPoints": 8 + } + } } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, record history, tabular attribute, row or column not found" + "description": "Database, table, record history, record version, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { - "put": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { + "get": { "tags": [ - "Data" + "Graph" ], - "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "SetCellPictureDatumForTabularAttributeFromTable", + "summary": "Get the graph for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForLatestFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -18404,97 +16596,178 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "row-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "column-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" - } - } - }, - "encoding": { - "Picture": { - "style": "form" - } - } - } - } - }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" + "$ref": "#/components/schemas/GsaGraph" + }, + "examples": { + "Example 2": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "value": { + "functionalType": "float", + "series": [ + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + }, + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + } + ], + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + "constraintParameters": [ + { + "type": "numeric", + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "numberOfPoints": 8 + } + } } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, table, record history, tabular attribute, row or column not found" - }, - "415": { - "description": "Invalid image file" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { - "put": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { + "get": { "tags": [ - "Data" + "Graph" ], - "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "SetCellPictureDatumForTabularAttribute", + "summary": "Get a graph for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -18507,18 +16780,16 @@ } }, { - "name": "attribute-guid", + "name": "record-version-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "row-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -18527,94 +16798,184 @@ } }, { - "name": "column-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" - } - } - }, - "encoding": { - "Picture": { - "style": "form" - } - } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } - }, + ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" + "$ref": "#/components/schemas/GsaGraph" + }, + "examples": { + "Example 3": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "value": { + "functionalType": "float", + "series": [ + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + }, + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + } + ], + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + "constraintParameters": [ + { + "type": "numeric", + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "numberOfPoints": 8 + } + } } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, record history, tabular attribute, row or column not found" - }, - "415": { - "description": "Invalid image file" + "description": "Database, record history, record version, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { + "get": { "tags": [ - "Data" + "Graph" ], - "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database and table.", - "operationId": "SetDatumNotApplicableFromTable", + "summary": "Get the graph for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForLatest", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -18623,47 +16984,180 @@ } }, { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], "responses": { "200": { - "description": "Ok" + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraph" + }, + "examples": { + "Example 4": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "value": { + "functionalType": "float", + "series": [ + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + }, + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + } + ], + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + "constraintParameters": [ + { + "type": "numeric", + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "numberOfPoints": 8 + } + } + } + } + } }, - "403": { - "description": "Forbidden" + "400": { + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, table, record history or attribute not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { "post": { "tags": [ - "Data" + "Graph" ], - "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database.", - "operationId": "SetDatumNotApplicable", + "summary": "Evaluate the graph for a given set of parameter values for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphForVersionFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { @@ -18676,78 +17170,45 @@ } }, { - "name": "attribute-guid", + "name": "record-version-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok" }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { - "post": { - "tags": [ - "Data" - ], - "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database and table.", - "operationId": "AppendValuesForDiscreteAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, { - "name": "record-history-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -18755,33 +17216,27 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -18790,33 +17245,27 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -18825,33 +17274,27 @@ }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -18860,33 +17303,27 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -18901,40 +17338,89 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteDatum" + "$ref": "#/components/schemas/GsaGraphValue" + }, + "examples": { + "Example 1": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false + } + }, + "Example 2": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true + } + }, + "Example 3": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" + } + } + }, + "Example 4": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "value": { + "graphValueType": "noValueExists" + } + } } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, table, record history, discrete attribute or datum not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { "post": { "tags": [ - "Data" + "Graph" ], - "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database.", - "operationId": "AppendValuesForDiscreteAttribute", + "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphValueForLatestFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { @@ -18949,46 +17435,62 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -18997,33 +17499,27 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19032,33 +17528,27 @@ }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19067,33 +17557,27 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, + "parametersWithValues": [ { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19108,55 +17592,93 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteDatum" + "$ref": "#/components/schemas/GsaGraphValue" + }, + "examples": { + "Example 5": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false + } + }, + "Example 6": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true + } + }, + "Example 7": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" + } + } + }, + "Example 8": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "value": { + "graphValueType": "noValueExists" + } + } } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, record history, discrete attribute or datum not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { "post": { "tags": [ - "Data" + "Graph" ], - "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database and table.", - "operationId": "AppendValuesForPointAttributeFromTable", + "summary": "Evaluate the graph for a given set of parameter values for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphForVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", + "name": "record-version-guid", "in": "path", "required": true, "schema": { @@ -19167,134 +17689,62 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 3": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, + "parametersWithValues": [ { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19303,121 +17753,27 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "Example 3": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, + "parametersWithValues": [ { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19426,121 +17782,27 @@ }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "Example 3": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, + "parametersWithValues": [ { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19549,169 +17811,115 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "Example 3": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ + "parametersWithValues": [ { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphValue" }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "examples": { + "Example 9": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false + } + }, + "Example 10": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true + } + }, + "Example 11": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" } - ] + } + }, + "Example 12": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "value": { + "graphValueType": "noValueExists" + } } } } } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPointDatum" - } - } - } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, table, record history, point attribute or datum not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { "post": { "tags": [ - "Data" + "Graph" ], - "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database.", - "operationId": "AppendValuesForPointAttribute", + "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphValueForLatest", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -19726,134 +17934,62 @@ { "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, + "parametersWithValues": [ { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19862,121 +17998,27 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, + "parametersWithValues": [ { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -19985,121 +18027,27 @@ }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, + "parametersWithValues": [ { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -20108,121 +18056,27 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "Example 4": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "values": [ + "parametersWithValues": [ { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } } ] } @@ -20237,306 +18091,316 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPointDatum" + "$ref": "#/components/schemas/GsaGraphValue" + }, + "examples": { + "Example 13": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false + } + }, + "Example 14": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true + } + }, + "Example 15": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" + } + } + }, + "Example 16": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "value": { + "graphValueType": "noValueExists" + } + } } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, record history, point attribute or datum not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}:search-index-status": { + "/v1alpha/help-location/url/{help-key}": { "get": { "tags": [ - "Database" + "HelpLocation" ], - "summary": "GetSearch Index Status for a given database", - "operationId": "GetSearchIndexStatus", + "summary": "Returns the URL that the given helpKey maps to.", + "operationId": "GetHelpUrl", "parameters": [ { - "name": "database-key", + "name": "help-key", "in": "path", - "description": "", + "description": "The help key.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } - }, + } + ], + "responses": { + "200": { + "description": "Ok" + } + } + } + }, + "/v1alpha/help-location/redirect/{help-key}": { + "get": { + "tags": [ + "HelpLocation" + ], + "summary": "Redirects client to the URL that the given helpKey maps to.", + "operationId": "GetHelpUrlRedirect", + "parameters": [ { - "name": "include-errors", - "in": "query", - "description": "", + "name": "help-key", + "in": "path", + "description": "The help key.", + "required": true, "schema": { - "type": "boolean" + "type": "string" } } ], "responses": { "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - } - } - }, - "403": { - "description": "Forbidden is returned if include diagnostics is requested and the current user is not an administrator" + "description": "OK" }, - "404": { - "description": "Database key not found" + "302": { + "description": "Redirect to the help location." } } } }, - "/v1alpha/databases/{database-key}/tables/{table-identity}:generate-integration-schema": { - "get": { + "/v1alpha/identities": { + "post": { "tags": [ - "Database" + "Identities" ], - "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromTable", + "summary": "For internal use only.\r\nTranslates guids to identities.", + "operationId": "TranslateGuidsToIdentities", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "table-identity", - "in": "path", - "description": "", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "integer", - "format": "int32" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + } + } + }, "responses": { "200": { "description": "OK", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" + "400": { + "description": "Bad request" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-name}:generate-integration-schema": { + "/v1alpha/integration-schemas": { "get": { "tags": [ - "Database" - ], - "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromTableName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-name", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string" - } - } + "Integration" ], + "summary": "Lists the available integration schemas.", + "operationId": "Schemas", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "array", + "items": { + "type": "string" + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "array", + "items": { + "type": "string" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "array", + "items": { + "type": "string" + } } } } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-identity}:generate-integration-schema": { - "get": { + }, + "post": { "tags": [ - "Database" + "Integration" ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayout", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "layout-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" + "summary": "Add an integration schema. Will fail if the schema is not valid, or if the user is not both a global administrator and an administrator for the schema.", + "operationId": "AddSchema", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } } } - ], + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created successfully", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } } } }, + "400": { + "description": "Bad request. Returns validation errors information" + }, "403": { - "description": "Forbidden" + "description": "Forbidden. User is not a global administrator or an administrator for the schema" }, - "404": { - "description": "Database, table or layout not found" + "422": { + "description": "MI not in attribute-based access control mode" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-identity}:generate-integration-schema": { + "/v1alpha/integration-schemas/{schema}:search-index-status": { "get": { "tags": [ - "Database" + "Integration" ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayoutWithTableName", + "summary": "Returns the status of a given integration schema.", + "operationId": "GetStatusForIntegrationSchema", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-name", + "name": "schema", "in": "path", - "description": "", "required": true, "schema": { "type": "string" } }, { - "name": "layout-identity", - "in": "path", - "description": "", - "required": true, + "name": "include-errors", + "in": "query", "schema": { - "type": "integer", - "format": "int32" + "type": "boolean" } } ], @@ -20546,17 +18410,17 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" } } } @@ -20565,47 +18429,24 @@ "description": "Forbidden" }, "404": { - "description": "Database, table or layout not found" + "description": "Not Found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-name}:generate-integration-schema": { + "/v1alpha/integration-schemas:search-index-status": { "get": { "tags": [ - "Database" + "Integration" ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayoutName", + "summary": "Returns the status of all available integration schemas.", + "operationId": "AllSchemaStatus", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "layout-name", - "in": "path", - "description": "", - "required": true, + "name": "include-errors", + "in": "query", "schema": { - "type": "string" + "type": "boolean" } } ], @@ -20615,66 +18456,164 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } } } } }, "403": { "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-name}:generate-integration-schema": { - "get": { - "tags": [ - "Database" + "/v1alpha/integration-schemas/{schema}": { + "put": { + "tags": [ + "Integration" ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayoutNameWithTableName", + "summary": "Updates an integration schema.\r\nWill fail if the schema does not exist, is not valid, or if the user is not both a global administrator and an administrator for the schema.", + "operationId": "UpdateSchema", "parameters": [ { - "name": "database-key", + "name": "schema", "in": "path", - "description": "", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "responses": { + "201": { + "description": "Updated successfully", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + } } }, + "400": { + "description": "Bad request. Returns validation errors information" + }, + "403": { + "description": "Forbidden. User is not a global administrator or an administrator for the schema" + }, + "404": { + "description": "Not Found. Schema does not exist" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + }, + "delete": { + "tags": [ + "Integration" + ], + "summary": "Delete an integration schema. Will fail if the schema does not exist, or if the user is not both a global administrator and an administrator for the schema.", + "operationId": "DeleteSchema", + "parameters": [ { - "name": "table-name", + "name": "schema", "in": "path", - "description": "", + "description": "Schema to be deleted", "required": true, "schema": { "type": "string" } + } + ], + "responses": { + "204": { + "description": "Schema deleted" + }, + "403": { + "description": "Forbidden" }, + "404": { + "description": "Schema not found" + } + } + }, + "get": { + "tags": [ + "Integration" + ], + "summary": "Returns the full object representing the integration schema.\r\nNames and identities of source items will be populated if they can be found in the databases currently loaded in MI, otherwise just the GUIDs will be returned.", + "operationId": "GetSchema", + "parameters": [ { - "name": "layout-name", + "name": "schema", "in": "path", - "description": "", + "description": "The schema name.", "required": true, "schema": { "type": "string" } + }, + { + "name": "includeImplicitAttributes", + "in": "query", + "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", + "schema": { + "type": "boolean" + } } ], "responses": { @@ -20683,132 +18622,318 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } } } }, - "403": { - "description": "Forbidden" + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + } + }, + "/v1alpha/integration-schemas/{schema}/attributes": { + "get": { + "tags": [ + "Integration" + ], + "summary": "Returns a list of the attributes defined in the integration schema.", + "operationId": "SchemaTargets", + "parameters": [ + { + "name": "schema", + "in": "path", + "description": "The schema name.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "includeImplicitAttributes", + "in": "query", + "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationAttribute" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationAttribute" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationAttribute" + } + } + } + } }, "404": { - "description": "Database, table or layout not found" + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" } } } }, - "/v1alpha/databases/{database-key}/standard-names:generate-integration-schema": { - "post": { + "/v1alpha/integration-schemas/{schema}/sources/database/{database-key}/table/{table-identity}": { + "get": { "tags": [ - "Database" + "Integration" ], - "summary": "Generate an integration schema with attributes for each provided standard name in the given database. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromStandardNames", + "summary": "Returns a list of the schema source mapping from the given table. Will fail if the database is not loaded in MI.\r\nNames and identities of source items will be populated.", + "operationId": "SchemaTableMappings", "parameters": [ + { + "name": "schema", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "database-key", "in": "path", - "description": "", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" + } + }, + { + "name": "table-identity", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" + } + } + } + } + }, + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + } + }, + "/v1alpha/job-queue/jobs": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get a list of jobs.", + "operationId": "GetJobs", + "parameters": [ + { + "name": "jobType", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "nameFilter", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "descriptionFilter", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "submitterNameFilter", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsResponse" + } + } } } + } + }, + "post": { + "tags": [ + "JobQueue" ], + "summary": "Create a new job.", + "operationId": "CreateJob", "requestBody": { - "description": "", "content": { "application/json-patch+json": { "schema": { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/GsaCreateJobRequest" } }, "application/json": { "schema": { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/GsaCreateJobRequest" } }, "text/json": { "schema": { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/GsaCreateJobRequest" } }, "application/*+json": { "schema": { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/GsaCreateJobRequest" } } } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created successfully", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaJob" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaJob" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaJob" } } } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" } } - } - }, - "/v1alpha/standard-names:generate-integration-schema": { - "post": { + }, + "delete": { "tags": [ - "Database" + "JobQueue" ], - "summary": "Generate an integration schema with attributes for each provided standard name. This will include attribute from all loaded databases for which the user is an Admin.", - "operationId": "GenerateSchemaFromStandardNamesAllDatabases", + "summary": "Delete specified jobs.", + "operationId": "DeleteJobs", "requestBody": { - "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "format": "uuid" } } }, @@ -20816,7 +18941,8 @@ "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "format": "uuid" } } }, @@ -20824,7 +18950,8 @@ "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "format": "uuid" } } }, @@ -20832,7 +18959,8 @@ "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "format": "uuid" } } } @@ -20844,71 +18972,101 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } } } } }, - "403": { - "description": "Forbidden" + "422": { + "description": "No job IDs were specified" }, - "404": { - "description": "Database not found" + "500": { + "description": "Failed to delete one or more jobs" } } } }, - "/v1alpha/databases/{database-key}:export": { - "post": { + "/v1alpha/job-queue/jobs/{id}": { + "get": { "tags": [ - "DataExport" + "JobQueue" ], - "summary": "Export data from the given database.", - "operationId": "ExportData", + "summary": "Get job by ID.", + "operationId": "GetJob", "parameters": [ { - "name": "database-key", + "name": "id", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + } } }, + "404": { + "description": "Job not found" + } + } + }, + "patch": { + "tags": [ + "JobQueue" + ], + "summary": "Update a job.", + "operationId": "UpdateJob", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "id", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -20916,2641 +19074,1798 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" - }, - "examples": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + } + } + }, + "404": { + "description": "Job not found" + } + } + }, + "delete": { + "tags": [ + "JobQueue" + ], + "summary": "Delete a job.", + "operationId": "DeleteJob", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Success - no content" + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}:retrieve-definition": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get a job creation object based on an existing job.", + "operationId": "RestoreJob", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + } + } + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}:move-to-top": { + "post": { + "tags": [ + "JobQueue" + ], + "summary": "Move a job to the top of the queue (actually sets the scheduled execution date to now, could be done with patch method).", + "operationId": "MoveToTop", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}:resubmit": { + "post": { + "tags": [ + "JobQueue" + ], + "summary": "Resubmit a job.", + "operationId": "Resubmit", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaResubmitJobRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaResubmitJobRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaResubmitJobRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaResubmitJobRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + } + } + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/files": { + "post": { + "tags": [ + "JobQueue" + ], + "summary": "Uploads an ephemeral file and returns an ID which can subsequently be used to refer to that file in a job creation request. Ephemeral files have a short lifespan\r\nand should be used to provide file data to jobs only. They should not be used as file storage.", + "operationId": "UploadFile", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + } + } + }, + "encoding": { + "file": { + "style": "form" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}/outputs": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get a job's output filenames.", + "operationId": "GetOutputFilenames", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}/outputs:export": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Retrieve a job output file.", + "operationId": "GetJobOutputFile", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "fileName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "404": { + "description": "Job or file not found" + } + } + } + }, + "/v1alpha/job-queue/current-user": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get the current user.", + "operationId": "GetCurrentUser", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaCurrentUser" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCurrentUser" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCurrentUser" + } + } + } + } + } + } + }, + "/v1alpha/job-queue/processing-configuration": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get the processing configuration.", + "operationId": "GetProcessingConfig", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaProcessingConfig" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaProcessingConfig" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaProcessingConfig" + } + } + } + } + } + } + }, + "/v1alpha/license/user-license:ensure-checked-out": { + "get": { + "tags": [ + "License" + ], + "summary": "Either checks out a user license for the requesting user, or returns an error response if no such license is available.\r\nThis method is a no-op because it relies on license check to happen within Granta.Server.Api.Auth.UserContextFilter", + "operationId": "EnsureUserLicenseAvailable", + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" + } + } + } + } + } + } + }, + "/v1alpha/license/server-licenses:ensure-checked-out": { + "post": { + "tags": [ + "License" + ], + "summary": "Checks out server wide licenses and returns a bool for each provided app name indicating if\r\nthe relevant license(s) required have been checked out.", + "operationId": "CheckoutAppLicense", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" + "appNames": [ + "MI BoM Analyzer" ] } }, "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" + "appNames": [ + "RS Reports", + "Sustainability Analytics" ] } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { + "Example 1": { + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + "appNames": [ + "MI BoM Analyzer" ] } }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", + "Example 2": { + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + "appNames": [ + "RS Reports", + "Sustainability Analytics" ] } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { + "Example 1": { + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + "appNames": [ + "MI BoM Analyzer" ] } }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", + "Example 2": { + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + "appNames": [ + "RS Reports", + "Sustainability Analytics" ] } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { + "Example 1": { + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" + "appNames": [ + "MI BoM Analyzer" ] } }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", + "Example 2": { + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" + "appNames": [ + "RS Reports", + "Sustainability Analytics" ] } - }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + } + } + } + } + } + } + }, + "/v1alpha/license/server-licenses": { + "get": { + "tags": [ + "License" + ], + "summary": "Get info on which server licenses are enabled, and the license expiry date.", + "operationId": "GetServerLicense", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + } + } + } + } + } + } + }, + "/api/v1/lists/audit/search": { + "post": { + "tags": [ + "ListAuditLog" + ], + "summary": "Posts a search request, and returns an object containing search result identifier", + "operationId": "RunListAuditLogSearch", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } + "listIdentifiers": [ + "fb407082-9600-450b-becd-38a11a9fbc3d" ], - "recordProperties": [ - "tableName", - "fullName" + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 + } } - }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } + "listIdentifiers": [ + "fb407082-9600-450b-becd-38a11a9fbc3d" ], - "recordProperties": [ - "tableName", - "fullName" + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 + } } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } + "listIdentifiers": [ + "fb407082-9600-450b-becd-38a11a9fbc3d" ], - "recordProperties": [ - "fullName" + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 + } } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } + "listIdentifiers": [ + "fb407082-9600-450b-becd-38a11a9fbc3d" ], - "recordProperties": [ - "fullName" + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 + } } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/api/v1/lists/audit/search/results/{resultResourceIdentifier}": { + "get": { + "tags": [ + "ListAuditLog" + ], + "summary": "Returns the search results found in the specified resource", + "operationId": "GetListAuditLogSearchResults", + "parameters": [ + { + "name": "resultResourceIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListAuditLogItem" } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListAuditLogItem" } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListAuditLogItem" } } } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Search result not found" + }, + "410": { + "description": "Search result no longer available" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/items": { + "get": { + "tags": [ + "ListItem" + ], + "summary": "Returns the items in the given list", + "operationId": "GetListItems", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/items/add": { + "post": { + "tags": [ + "ListItem" + ], + "summary": "Adds the specified items to an existing list.", + "operationId": "AddItemsToList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" - ] - } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", - "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" - ] - } - }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" - ] + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/items/remove": { + "post": { + "tags": [ + "ListItem" + ], + "summary": "Removed the specified items from an existing list.", + "operationId": "RemoveItemsFromList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists": { + "get": { + "tags": [ + "ListManagement" + ], + "summary": "Returns all lists visible to the calling user", + "operationId": "GetAllLists", + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeadersInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeadersInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeadersInfo" + } + } + } + }, + "403": { + "description": "Forbidden" + } + } + }, + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Creates a new list with the specified properties and items.", + "operationId": "CreateList", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/api/v1/lists/search": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Posts a search request, and returns an object containing search result identifier", + "operationId": "RunRecordListsSearch", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/api/v1/lists/search/results/{resultResourceIdentifier}": { + "get": { + "tags": [ + "ListManagement" + ], + "summary": "Returns the search results found in the specified resource", + "operationId": "GetRecordListSearchResults", + "parameters": [ + { + "name": "resultResourceIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Search result not found" + }, + "410": { + "description": "Search result no longer available" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}": { + "get": { + "tags": [ + "ListManagement" + ], + "summary": "Returns the given list if it exists and the calling user has read access to it", + "operationId": "GetList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + }, + "patch": { + "tags": [ + "ListManagement" + ], + "summary": "Performs a partial update on the properties of a list.", + "operationId": "UpdateList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" + }, + "examples": { + "Example 1": { + "summary": "Update the name of list", + "description": "Update the name of a list", + "value": { + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", + "Example 2": { + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" - ] + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" + }, + "examples": { + "Example 1": { + "summary": "Update the name of list", + "description": "Update the name of a list", + "value": { + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", + "Example 2": { + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" + }, + "examples": { + "Example 1": { + "summary": "Update the name of list", + "description": "Update the name of a list", + "value": { + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", + "Example 2": { + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" }, "examples": { "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", + "summary": "Update the name of list", + "description": "Update the name of a list", "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" - ] + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" - ] - } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", - "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" - ] - } - }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" - ] - } - }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" - ] - } - }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true } } } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" - ] - } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", - "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" - ] - } - }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" - ] - } - }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" - ] - } - }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } - }, + } + }, + "delete": { + "tags": [ + "ListManagement" + ], + "summary": "Delete an existing list.", + "operationId": "DeleteList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/request-approval": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Update the status of an existing list to \"awaiting approval\".", + "operationId": "RequestApproval", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" + "$ref": "#/components/schemas/GsaRecordListHeader" } } } }, - "404": { - "description": "Database not found" + "400": { + "description": "Bad request" }, "403": { "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } } } }, - "/v1alpha/integration-schemas/{schema}:export": { + "/api/v1/lists/list/{listIdentifier}/reset": { "post": { "tags": [ - "DataExport" + "ListManagement" ], - "summary": "Export data from the integration schema.", - "operationId": "ExportDataFromIntegrationSchema", + "summary": "Update the status of an existing list to not be \"awaiting approval\".", + "operationId": "ResetAwaitingApproval", "parameters": [ { - "name": "schema", + "name": "listIdentifier", "in": "path", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } - }, + } + } + }, + "/api/v1/lists/list/{listIdentifier}/publish": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Update the status of an existing list to \"published\". The list must be awaiting approval, and not already published.\r\nThe \"awaiting approval\" flag will be reset to false.", + "operationId": "PublishList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" + "$ref": "#/components/schemas/GsaRecordListHeader" } } } }, - "404": { - "description": "Schema not found" + "400": { + "description": "Bad request" }, - "422": { - "description": "MI not in attribute-based access control mode" + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } } } }, - "/v1alpha/dataupdater/updates": { - "get": { + "/api/v1/lists/list/{listIdentifier}/unpublish": { + "post": { "tags": [ - "DataUpdater" + "ListManagement" + ], + "summary": "Update the status of an existing list to \"unpublished\". The list must be published, and awaiting approval.\r\nThe \"awaiting approval\" flag will be reset to false.", + "operationId": "UnpublishList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "operationId": "GetAllUpdates", "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "text/plain": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } + "$ref": "#/components/schemas/GsaRecordListHeader" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } } } }, - "/v1alpha/dataupdater/updates/{database-key}": { - "get": { + "/api/v1/lists/list/{listIdentifier}/revise": { + "post": { "tags": [ - "DataUpdater" + "ListManagement" ], - "operationId": "GetUpdatesForDatabase", + "summary": "Creates a private copy of a list that can be revised.", + "operationId": "ReviseList", "parameters": [ { - "name": "database-key", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "text/plain": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } + "$ref": "#/components/schemas/GsaRecordListHeader" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } } - }, + } + }, + "/api/v1/lists/list/{listIdentifier}/copy": { "post": { "tags": [ - "DataUpdater" + "ListManagement" ], - "summary": "Register an update", - "operationId": "RegisterUpdate", + "summary": "Creates a copy of the list and its items", + "operationId": "CopyList", "parameters": [ { - "name": "database-key", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - } - } - }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdateToken" + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdateToken" + "$ref": "#/components/schemas/GsaRecordListHeader" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdateToken" + "$ref": "#/components/schemas/GsaRecordListHeader" } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } } } }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}": { - "get": { + "/api/v1/lists/list/{listIdentifier}/permissions/subscribe": { + "post": { "tags": [ - "DataUpdater" + "ListPermissions" ], - "summary": "Get registered update.\r\nRetrieves info about an update that was registered by the Apply side.", - "operationId": "GetUpdate", + "summary": "Subscribes the calling user to the specified list.", + "operationId": "Subscribe", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", + "name": "listIdentifier", "in": "path", "required": true, "schema": { @@ -23560,48 +20875,48 @@ } ], "responses": { - "200": { - "description": "OK", + "202": { + "description": "Accepted", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdate" + "$ref": "#/components/schemas/GsaUserPermission" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdate" + "$ref": "#/components/schemas/GsaUserPermission" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdate" + "$ref": "#/components/schemas/GsaUserPermission" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } } - }, - "delete": { + } + }, + "/api/v1/lists/list/{listIdentifier}/permissions/unsubscribe": { + "post": { "tags": [ - "DataUpdater" + "ListPermissions" ], - "summary": "Deletes an update if it is in a deletable state.", - "operationId": "DeleteUpdate", + "summary": "Unsubscribes the calling user from the specified list.", + "operationId": "Unsubscribe", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", + "name": "listIdentifier", "in": "path", "required": true, "schema": { @@ -23611,36 +20926,51 @@ } ], "responses": { - "200": { - "description": "OK" + "202": { + "description": "Accepted", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Update not found" + "description": "Record list not found" + }, + "422": { + "description": "Unsubscribe Failed" } } } }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}/header": { + "/api/v1/lists/list/{listIdentifier}/permissions": { "get": { "tags": [ - "DataUpdater" + "ListPermissions" ], - "summary": "Get update header from update file.\r\nWorks even for unregistered updates (i.e. ones just created by the Create side).", - "operationId": "GetUpdateHeader", + "summary": "Gets all permissions associated with the specified list.", + "operationId": "GetPermissions", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", + "name": "listIdentifier", "in": "path", "required": true, "schema": { @@ -23651,49 +20981,42 @@ ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" } } - } - }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:dry-run": { + }, "post": { "tags": [ - "DataUpdater" + "ListPermissions" ], - "summary": "Start a dry run job for a given update", - "operationId": "DryRunUpdate", + "summary": "Sets permissions for the specified list. Returns a collection of the created/updated permissions.", + "operationId": "SetPermissions", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", + "name": "listIdentifier", "in": "path", "required": true, "schema": { @@ -23702,54 +21025,82 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + } + } + }, "responses": { - "200": { - "description": "OK", + "202": { + "description": "Accepted", "content": { "text/plain": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } }, "application/json": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } }, "text/json": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list or user or group not found" } } } }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:apply": { - "post": { + "/api/v1/lists/list/{listIdentifier}/permissions/user/{userIdentifier}": { + "get": { "tags": [ - "DataUpdater" + "ListPermissions" ], - "summary": "Start an apply job for a given update", - "operationId": "ApplyUpdate", + "summary": "Gets the permission flags of the permission associating the specified list with the specified user.", + "operationId": "GetPermissionsForUser", "parameters": [ { - "name": "database-key", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "update-token-guid", + "name": "userIdentifier", "in": "path", "required": true, "schema": { @@ -23760,52 +21111,51 @@ ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "text/plain": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" } }, "application/json": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" } }, "text/json": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "User or group, record list or record list permission not found" } } - } - }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:finalize": { - "post": { + }, + "put": { "tags": [ - "DataUpdater" + "ListPermissions" ], - "summary": "Start a finalize job for a given update", - "operationId": "FinalizeUpdate", + "summary": "Sets the permission flags of the permission associating the specified list with the specified user.", + "operationId": "SetPermissionsForUser", "parameters": [ { - "name": "database-key", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "update-token-guid", + "name": "userIdentifier", "in": "path", "required": true, "schema": { @@ -23814,49 +21164,76 @@ } } ], - "responses": { - "200": { - "description": "OK", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + } + } + } + }, + "responses": { + "201": { + "description": "Created", "content": { "text/plain": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" } }, "application/json": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" } }, "text/json": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list or user or group not found" } } } }, - "/v1alpha/dataupdater/projects/{database-key}": { + "/v1alpha/metrics/jobs": { "get": { "tags": [ - "DataUpdater" + "Metrics" ], - "operationId": "GetProjectsForDatabase", + "summary": "Get a summary of jobs currently running or completed since the start time.", + "operationId": "GetJobsSummary", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "start", + "in": "query", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -23866,26 +21243,17 @@ "content": { "text/plain": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } + "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" } }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } + "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } + "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" } } } @@ -23893,54 +21261,80 @@ } } }, - "/v1alpha/dataupdater/projects/{database-key}:fill-in-fallback-ids": { - "post": { + "/v1alpha/databases/{database-key}/permission-categories": { + "get": { "tags": [ - "DataUpdater" + "Permission-Based Access Control" ], - "summary": "Starts a long-running operation of generating fallback identifiers for a given database.\r\nReturns immediately.\r\nUser is expected to watch MI Server logs for progress and errors.", - "operationId": "FillInFallbackIdentifiers", + "summary": "Get all permission-based access control categories for the specified database.", + "operationId": "GetPermissionCategories", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], "responses": { "200": { - "description": "OK" + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPermissionCategoriesInfo" + }, + "example": { + "categories": [ + { + "name": "Geo", + "guid": "262a0f59-c781-4611-92bd-090b0a2f360d" + }, + { + "name": "Sensitivity", + "guid": "f9050678-4c1c-4801-9b5f-14719e55182d" + }, + { + "name": "Division", + "guid": "7f248108-b3c2-4724-8ef0-846c0ff95416" + } + ] + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + }, + "422": { + "description": "MI not in permission-based access control mode" } } } }, - "/v1alpha/dataupdater/projects/{database-key}/{project-id}": { - "put": { + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}": { + "get": { "tags": [ - "DataUpdater" + "Permission-Based Access Control" ], - "summary": "Creates a new project or updates an existing one.", - "operationId": "CreateOrUpdateProject", + "summary": "Get a permission-based access control category with a specified guid.", + "operationId": "GetPermissionCategory", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "project-id", + "name": "category-guid", "in": "path", "required": true, "schema": { @@ -23949,90 +21343,65 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - } - } - }, "responses": { "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "DataUpdater" - ], - "summary": "Deletes a project.", - "operationId": "DeleteProject", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPermissionCategory" + }, + "example": { + "permissions": [ + { + "name": "US", + "guid": "4c726824-b6ea-4226-84f7-a320189023c4" + }, + { + "name": "EMEA", + "guid": "4cf0f471-ef89-4acc-9531-11bcaef2b4a3" + }, + { + "name": "APAC", + "guid": "db7894a6-7a80-4dae-a2a1-82d6e8906a77" + } + ], + "name": "Geo", + "guid": "262a0f59-c781-4611-92bd-090b0a2f360d" + } + } } }, - { - "name": "project-id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK" + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or category not found" + }, + "422": { + "description": "MI not in permission-based access control mode" } } - }, - "post": { + } + }, + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions": { + "get": { "tags": [ - "DataUpdater" + "Permission-Based Access Control" ], - "summary": "Creates and queues a new 'create update' job for a given project.", - "operationId": "CreateUpdate", + "summary": "Get all permission-based access control permissions for the specified category.", + "operationId": "GetPermissionsInCategory", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "project-id", + "name": "category-guid", "in": "path", "required": true, "schema": { @@ -24041,159 +21410,72 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - } - } - }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "type": "string", - "format": "uuid" - } - }, "application/json": { "schema": { - "type": "string", - "format": "uuid" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaPermissionsInfo" + }, + "example": { + "permissions": [ + { + "name": "US", + "guid": "4c726824-b6ea-4226-84f7-a320189023c4" + }, + { + "name": "EMEA", + "guid": "4cf0f471-ef89-4acc-9531-11bcaef2b4a3" + }, + { + "name": "APAC", + "guid": "db7894a6-7a80-4dae-a2a1-82d6e8906a77" + } + ] } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or category not found" + }, + "422": { + "description": "MI not in permission-based access control mode" } } } }, - "/v1alpha/dataupdater/profiles/{profile-id}/selections/{database-key}": { + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}": { "get": { "tags": [ - "DataUpdater" + "Permission-Based Access Control" ], - "summary": "Retrieves selection based on profile and database key", - "operationId": "GetSelection", + "summary": "Get a permission-based access control permission with a given guid in the specified category.", + "operationId": "GetPermissionInCategory", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "profile-id", + "name": "category-guid", "in": "path", "required": true, "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSelection" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSelection" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSelection" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/jobs": { - "get": { - "tags": [ - "DataUpdater" - ], - "summary": "Get all jobs.\r\n(pertaining to databases that the user is administrator of)", - "operationId": "GetDataUpdaterJobs", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - } - } + "type": "string", + "format": "uuid" } - } - } - } - }, - "/v1alpha/dataupdater/jobs/{job-id}": { - "get": { - "tags": [ - "DataUpdater" - ], - "summary": "Get a specific job.", - "operationId": "GetDataUpdaterJob", - "parameters": [ + }, { - "name": "job-id", + "name": "permission-guid", "in": "path", "required": true, "schema": { @@ -24204,83 +21486,62 @@ ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" + "$ref": "#/components/schemas/GsaPermission" + }, + "example": { + "role": "DOMAIN\\US", + "description": "Members of the US role", + "setMessage": "Permission set", + "unsetMessage": "No permission set", + "name": "US", + "guid": "4c726824-b6ea-4226-84f7-a320189023c4" } } } - } - } - }, - "delete": { - "tags": [ - "DataUpdater" - ], - "summary": "Delete a specific job.\r\nOnly valid if job is in one of the completed states.", - "operationId": "DeleteCompletedDataUpdaterJob", - "parameters": [ - { - "name": "job-id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or category or permission not found" + }, + "422": { + "description": "MI not in permission-based access control mode" } } } }, - "/v1alpha/find-similar/databases/{database-key}/tables/{table-guid}/record/{record-guid}": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}": { + "get": { "tags": [ - "FindSimilar" + "Records - Record Histories" ], - "summary": "Gets the long-running operation for running the finds similar records calculation in a given database and table for a given record", - "operationId": "FindSimilar", + "summary": "Get a record history with a specified guid for a given database and table.", + "operationId": "GetRecordHistoryFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-guid", + "name": "record-history-guid", "in": "path", "required": true, "schema": { @@ -24291,7 +21552,7 @@ { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -24303,7 +21564,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -24313,76 +21574,61 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - } - } - }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "22781fbe-5dd0-4685-b384-d313c964c3a6", - "status": "pending" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "22781fbe-5dd0-4685-b384-d313c964c3a6", - "status": "pending" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "identifier": "22781fbe-5dd0-4685-b384-d313c964c3a6", - "status": "pending" + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" } } } + }, + "404": { + "description": "Database, table or record history not found" } } } }, - "/v1alpha/find-similar/integration-schemas/{schema}/databases/{database-key}/record/{record-guid}": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}": { + "get": { "tags": [ - "FindSimilar" + "Records - Record Histories" ], - "summary": "Gets the long-running operation for running a find similar calculation against an integration schema.", - "operationId": "IntegrationFindSimilar", + "summary": "Get a record history with a specified guid for a given database.", + "operationId": "GetRecordHistory", "parameters": [ { - "name": "schema", + "name": "database-key", "in": "path", "required": true, "schema": { @@ -24390,170 +21636,102 @@ } }, { - "name": "database-key", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "record-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } - }, + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "a91c3b13-24c9-409c-8e32-27ceae33dac9", - "status": "pending" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "identifier": "a91c3b13-24c9-409c-8e32-27ceae33dac9", - "status": "pending" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "a91c3b13-24c9-409c-8e32-27ceae33dac9", - "status": "pending" + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" } } } }, "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" + "description": "Database or record history not found" } } } }, - "/v1alpha/find-similar/{operation-identifier}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories": { + "post": { "tags": [ - "FindSimilar" + "Records - Record Histories" ], - "summary": "Gets the long-running operation for calculating the find similar results.", - "operationId": "GetRunFindSimilarOperation", + "summary": "Create a new record history.", + "operationId": "CreateRecordHistory", "parameters": [ { - "name": "operation-identifier", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLongRunningOperationInclude" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "9d997dd0-096c-4efb-ba65-d5faa72e3830", - "status": "pending" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "9d997dd0-096c-4efb-ba65-d5faa72e3830", - "status": "pending" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "9d997dd0-096c-4efb-ba65-d5faa72e3830", - "status": "pending" - } - } + "type": "string" } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Long-running operation not found" - } - } - }, - "delete": { - "tags": [ - "FindSimilar" - ], - "summary": "Requests cancellation of a long-running operation for calculating similarity scores.\r\nCancellation will only happen when the operation is pending or in progress, and is not guaranteed - it is a best-effort attempt to stop the operation early.\r\nThe long-running operation status will be set to awaitingCancellation; then to cancelled if cancellation is successful.\r\nIf the long-running operation has already completed (succeeded or failed), an error will be returned.\r\nIf the long-running operation has already been cancelled, the status will remain as is (awaitingCancellation or cancelled).", - "operationId": "CancelFindSimilarRun", - "parameters": [ { - "name": "operation-identifier", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -24562,209 +21740,326 @@ } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" - }, - "example": { - "identifier": "a2a3bddd-a2e3-469b-b37f-84029ea91745", - "status": "pending" - } + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" + "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } }, - "example": { - "identifier": "a2a3bddd-a2e3-469b-b37f-84029ea91745", - "status": "pending" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperation" + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } }, - "example": { - "identifier": "a2a3bddd-a2e3-469b-b37f-84029ea91745", - "status": "pending" - } - } - } - }, - "422": { - "description": "Invalid status for long-running operation - operation must not be complete (succeeded or failed)", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperationInvalidStatusException" + "Example 3": { + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "8a2dca61-a99e-4da9-a7e6-6d8949024567" + } }, - "example": { - "message": "Invalid status Succeeded for long-running operation.", - "code": "longRunningOperationInvalidStatus", - "status": "succeeded" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperationInvalidStatusException" + "Example 4": { + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } }, - "example": { - "message": "Invalid status Succeeded for long-running operation.", - "code": "longRunningOperationInvalidStatus", - "status": "succeeded" + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaLongRunningOperationInvalidStatusException" + "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } }, - "example": { - "message": "Invalid status Succeeded for long-running operation.", - "code": "longRunningOperationInvalidStatus", - "status": "succeeded" + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + }, + "Example 3": { + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "8a2dca61-a99e-4da9-a7e6-6d8949024567" + } + }, + "Example 4": { + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } + }, + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } } } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Long-running operation not found" - } - } - } - }, - "/v1alpha/find-similar/{operation-identifier}/result": { - "get": { - "tags": [ - "FindSimilar" - ], - "summary": "Gets the result of a long-running operation running a find similar calculation.", - "operationId": "GetFindSimilarOperationResult", - "parameters": [ - { - "name": "operation-identifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarResponse" - } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarResponse" + "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } + }, + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + }, + "Example 3": { + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "8a2dca61-a99e-4da9-a7e6-6d8949024567" + } + }, + "Example 4": { + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } + }, + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarResponse" + "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } + }, + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + }, + "Example 3": { + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "8a2dca61-a99e-4da9-a7e6-6d8949024567" + } + }, + "Example 4": { + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } + }, + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } } } } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Long-running operation not found" - }, - "422": { - "description": "Invalid status for long-running operation - operation must be complete (succeeded or failed)" - } - } - } - }, - "/v1alpha/find-similar/{find-similar-identifier}/full-results": { - "get": { - "tags": [ - "FindSimilar" - ], - "summary": "Returns the find similar results for a given find similar identifier.", - "operationId": "GetFindSimilarOperationFullResult", - "parameters": [ - { - "name": "find-similar-identifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } - ], + }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGetFindSimilarResultsResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGetFindSimilarResultsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetFindSimilarResultsResponse" + "$ref": "#/components/schemas/GsaRecordHistory" + }, + "example": { + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "New Alumino Silicate Record", + "guid": "bf003e88-9cd8-495d-9428-cdb0d4513168" + } + ], + "subsets": [], + "guid": "7fc3c239-e26f-4809-9a61-731513dadd05" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Find similar run not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:move": { + "post": { "tags": [ - "Graph" + "Records - Record Histories" ], - "summary": "Get the graph for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForVersionFromTable", + "summary": "Move a record history to be under a new parent.", + "operationId": "MoveRecordHistoryInTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -24776,398 +22071,235 @@ "type": "string", "format": "uuid" } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraph" - }, - "examples": { - "Example 1": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", - "value": { - "functionalType": "float", - "series": [ - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ - { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "numberOfPoints": 8 + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 1": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" } } + }, + "Example 2": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 1": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } + }, + "Example 2": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 1": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } + }, + "Example 2": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 1": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } + }, + "Example 2": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { - "get": { - "tags": [ - "Graph" - ], - "summary": "Get the graph for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForLatestFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" } } - ], + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraph" + "$ref": "#/components/schemas/GsaRecordHistory" + }, + "example": { + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordHistoryMoveException" }, "examples": { + "Example 1": { + "summary": "New parent is not a folder.", + "value": { + "message": "Cannot move record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" + } + ] + } + }, "Example 2": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "summary": "New parent is not in the same table.", "value": { - "functionalType": "float", - "series": [ + "message": "Cannot move record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, + "errors": [ { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" + } + ] + } + }, + "Example 3": { + "summary": "The 'short name' of the record to be moved is not unique under the new parent.", + "value": { + "message": "Cannot move record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, + "errors": [ { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ + ] + } + }, + "Example 4": { + "summary": "New parent is withdrawn.", + "value": { + "message": "Cannot move record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" } - ], - "numberOfPoints": 8 + ] + } + }, + "Example 5": { + "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", + "value": { + "message": "Cannot move record history with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", + "reason": "ParentIsADescendant" + } + ] } } } } } }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database, table or record history not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:move": { + "post": { "tags": [ - "Graph" + "Records - Record Histories" ], - "summary": "Get a graph for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForVersion", + "summary": "Move a record history to be under a new parent.", + "operationId": "MoveRecordHistory", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -25178,397 +22310,243 @@ "type": "string", "format": "uuid" } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraph" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } }, - "examples": { - "Example 3": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", - "value": { - "functionalType": "float", - "series": [ - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ - { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "numberOfPoints": 8 + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" } } + }, + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } + }, + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveRecordHistory" + }, + "examples": { + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } + } + }, + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { - "get": { - "tags": [ - "Graph" - ], - "summary": "Get the graph for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForLatest", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" } } - ], + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraph" + "$ref": "#/components/schemas/GsaRecordHistory" + }, + "example": { + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordHistoryMoveException" }, "examples": { - "Example 4": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "Example 6": { + "summary": "New parent is not a folder.", "value": { - "functionalType": "float", - "series": [ + "message": "Cannot move record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, + "errors": [ { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" + } + ] + } + }, + "Example 7": { + "summary": "New parent is not in the same table.", + "value": { + "message": "Cannot move record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, + "errors": [ { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ + ] + } + }, + "Example 8": { + "summary": "The 'short name' of the record to be moved is not unique under the new parent.", + "value": { + "message": "Cannot move record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, + "errors": [ { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" } - ], - "numberOfPoints": 8 + ] + } + }, + "Example 9": { + "summary": "New parent is withdrawn.", + "value": { + "message": "Cannot move record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" + } + ] + } + }, + "Example 10": { + "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", + "value": { + "message": "Cannot move record history with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", + "reason": "ParentIsADescendant" + } + ] } } } } } }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database or record history not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:copy": { "post": { "tags": [ - "Graph" + "Records - Record Histories" ], - "summary": "Evaluate the graph for a given set of parameter values for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphForVersionFromTable", + "summary": "Make a copy of a record history.", + "operationId": "CopyRecordHistoryInTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -25580,166 +22558,150 @@ "type": "string", "format": "uuid" } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 2": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 3": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 2": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 3": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 2": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 3": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 2": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 3": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } @@ -25747,100 +22709,131 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphValue" + "$ref": "#/components/schemas/GsaRecordHistory" + }, + "example": { + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "13829a89-9502-49fe-98e2-7e5ddaf03dcc" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordHistoryCopyException" }, "examples": { "Example 1": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "summary": "New parent is not a folder.", "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false + "message": "Cannot copy record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" + } + ] } }, "Example 2": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "summary": "New parent is not in the same table.", "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true + "message": "Cannot copy record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" + } + ] } }, "Example 3": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "summary": "The 'short name' of the record to be copied is not unique under the new parent.", "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } + "message": "Cannot copy record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, + "errors": [ + { + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" + } + ] } }, "Example 4": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "summary": "New parent is withdrawn.", "value": { - "graphValueType": "noValueExists" + "message": "Cannot copy record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" + } + ] } } } } } }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database, table or record history not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:copy": { "post": { "tags": [ - "Graph" + "Records - Record Histories" ], - "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphValueForLatestFromTable", + "summary": "Make a copy of a record history.", + "operationId": "CopyRecordHistory", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { @@ -25851,157 +22844,150 @@ "type": "string", "format": "uuid" } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" + } + }, + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" + } + }, + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": { + "subsetOption": "none", + "newShortName": "Short name for new record" } } } @@ -26009,93 +22995,135 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphValue" + "$ref": "#/components/schemas/GsaRecordHistory" }, - "examples": { - "Example 5": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false - } + "example": { + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "Example 6": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true - } + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" }, - "Example 7": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "4f45830a-657d-46ae-9570-9af2e7f5486f" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordHistoryCopyException" + }, + "examples": { + "Example 5": { + "summary": "New parent is not a folder.", "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } + "message": "Cannot copy record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" + } + ] + } + }, + "Example 6": { + "summary": "New parent is not in the same table.", + "value": { + "message": "Cannot copy record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" + } + ] + } + }, + "Example 7": { + "summary": "The 'short name' of the record to be copied is not unique under the new parent.", + "value": { + "message": "Cannot copy record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, + "errors": [ + { + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" + } + ] } }, "Example 8": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "summary": "New parent is withdrawn.", "value": { - "graphValueType": "noValueExists" + "message": "Cannot copy record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" + } + ] } } } } } }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database or record history not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest": { + "get": { "tags": [ - "Graph" + "Records - Record Histories" ], - "summary": "Evaluate the graph for a given set of parameter values for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphForVersion", + "summary": "Get the latest record version for a record history for a given database and table.", + "operationId": "GetLatestRecordVersionFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "record-history-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -26104,7 +23132,7 @@ } }, { - "name": "record-version-guid", + "name": "record-history-guid", "in": "path", "required": true, "schema": { @@ -26113,20 +23141,108 @@ } }, { - "name": "attribute-guid", + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Alumino silicate - 1720", + "recordColor": "fuchsia", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": false, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true + }, + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + } + } + }, + "404": { + "description": "Database, table or record history not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest": { + "get": { + "tags": [ + "Records - Record Histories" + ], + "summary": "Get the latest record version for a record history for a given database.", + "operationId": "GetLatestRecordVersion", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -26138,7 +23254,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -26148,210 +23264,78 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - } - } - }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphValue" + "$ref": "#/components/schemas/GsaRecordVersion" }, - "examples": { - "Example 9": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false - } + "example": { + "recordHistory": { + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" }, - "Example 10": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true - } + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "Example 11": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } - } + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Alumino silicate - 1720", + "recordColor": "fuchsia", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": false, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true }, - "Example 12": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", - "value": { - "graphValueType": "noValueExists" - } - } + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" } } } }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database or record history not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}": { + "get": { "tags": [ - "Graph" + "Records - Record Versions" ], - "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphValueForLatest", + "summary": "Get a record version with a specified guid for a given database, table and record history.", + "operationId": "GetRecordVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { @@ -26364,20 +23348,18 @@ } }, { - "name": "attribute-guid", + "name": "record-version-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -26389,7 +23371,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -26399,507 +23381,269 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - } - } - }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGraphValue" + "$ref": "#/components/schemas/GsaRecordVersion" }, - "examples": { - "Example 13": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false - } + "example": { + "recordHistory": { + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" }, - "Example 14": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true - } + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "Example 15": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } - } + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Alumino silicate - 1720", + "recordColor": "fuchsia", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": false, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true }, - "Example 16": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", - "value": { - "graphValueType": "noValueExists" - } - } + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" } } } }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, "404": { - "description": "Database, table, record history, attribute or datum not found" + "description": "Database, table, record history or record version not found" } } - } - }, - "/v1alpha/help-location/url/{help-key}": { - "get": { + }, + "delete": { "tags": [ - "HelpLocation" + "Records - Record Versions" ], - "summary": "Returns the URL that the given helpKey maps to.", - "description": "Honours the request's `Accept` header: if the client accepts `text/plain`, the raw URL is\r\nreturned as plain text; otherwise (including the default `application/json`) the URL is returned\r\nas a JSON-encoded string, e.g. `\"https://example.com/help\"`.", - "operationId": "GetHelpUrl", + "summary": "Deletes the record version. If the table is version controlled, only the current unreleased record version can be deleted.", + "operationId": "DeleteRecordVersion", "parameters": [ { - "name": "help-key", + "name": "database-key", "in": "path", - "description": "The help key.", "required": true, "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "Ok" - } - } - } - }, - "/v1alpha/help-location/redirect/{help-key}": { - "get": { - "tags": [ - "HelpLocation" - ], - "summary": "Redirects client to the URL that the given helpKey maps to.", - "operationId": "GetHelpUrlRedirect", - "parameters": [ + }, { - "name": "help-key", + "name": "table-guid", "in": "path", - "description": "The help key.", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "OK" }, - "302": { - "description": "Redirect to the help location." - } - } - } - }, - "/v1alpha/identities": { - "post": { - "tags": [ - "Identities" - ], - "summary": "For internal use only.\r\nTranslates guids to identities.", - "operationId": "TranslateGuidsToIdentities", - "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "record-history-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "record-version-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - } - } - }, "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateBetweenGuidsAndIdentitiesResponse" - } - } - } + "description": "Ok" }, "400": { - "description": "Bad request" + "description": "Bad request. Table is version controlled and record version is not unreleased." + }, + "404": { + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/guids": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:release": { "post": { "tags": [ - "Identities" + "Records - Record Versions" ], - "summary": "For internal use only.\r\nTranslates identities to GUIDs.", - "operationId": "TranslateIdentitiesToGuids", + "summary": "Releases the record version. Must be an unreleased record version.", + "operationId": "ReleaseRecordVersion", "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaTranslateBetweenGuidsAndIdentitiesResponse" + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Arsenic trioxide [1327-53-3]", + "recordColor": "red", + "capabilities": { + "canWrite": true, + "canModify": false, + "canRelease": false, + "canGetModifiableVersion": true, + "canWithdraw": true, + "canDelete": false + }, + "versionNumber": 1, + "versionState": "released", + "name": "Arsenic trioxide [1327-53-3]", + "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" } } } }, "400": { - "description": "Bad request" - } - } - } - }, - "/v1alpha/integration-schemas": { - "get": { - "tags": [ - "Integration" - ], - "summary": "Lists the available integration schemas.", - "operationId": "Schemas", - "responses": { - "200": { - "description": "OK", + "description": "Bad request. Record version state is not unreleased, or table is not version controlled, or parent is not released.", "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, "application/json": { "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string" + "$ref": "#/components/schemas/GsaReleaseRecordVersionControlException" + }, + "examples": { + "Example 1": { + "summary": "Invalid version state.", + "description": "Only unreleased record versions can be released.", + "value": { + "message": "Cannot release record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", + "code": 400, + "errors": [ + { + "message": "Invalid version state 'Released'.", + "reason": "invalidVersionState", + "versionState": "released" + } + ] + } + }, + "Example 2": { + "summary": "Table is not version controlled.", + "value": { + "message": "Cannot release record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", + "code": 400, + "errors": [ + { + "message": "Table is not version controlled.", + "reason": "notVersioned" + } + ] + } + }, + "Example 3": { + "summary": "Parent is not released.", + "value": { + "message": "Cannot release record version with GUID 'efcaab4f-307e-4b2b-96a1-289d95361088'.", + "code": 400, + "errors": [ + { + "message": "Tree parent is not in a valid state to perform this operation.", + "reason": "invalidParentState" + } + ] + } } } } } - } - } - }, - "post": { - "tags": [ - "Integration" - ], - "summary": "Add an integration schema. Will fail if the schema is not valid, or if the user is not both a global administrator and an administrator for the schema.", - "operationId": "AddSchema", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "responses": { - "201": { - "description": "Created successfully", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "400": { - "description": "Bad request. Returns validation errors information" }, "403": { - "description": "Forbidden. User is not a global administrator or an administrator for the schema" + "description": "Forbidden" }, - "422": { - "description": "MI not in attribute-based access control mode" + "404": { + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/integration-schemas/{schema}:search-index-status": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:get-modifiable-version": { + "post": { "tags": [ - "Integration" + "Records - Record Versions" ], - "summary": "Returns the status of a given integration schema.", - "operationId": "GetStatusForIntegrationSchema", + "summary": "Gets the latest modifiable record version, or creates a new one if none exists. The record version must be the latest version, and must be either released or withdrawn.", + "operationId": "GetModifiableRecordVersion", "parameters": [ { - "name": "schema", + "name": "database-key", "in": "path", "required": true, "schema": { @@ -26907,84 +23651,130 @@ } }, { - "name": "include-errors", - "in": "query", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - } + "type": "string", + "format": "uuid" } }, - "403": { - "description": "Forbidden" + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1alpha/integration-schemas:search-index-status": { - "get": { - "tags": [ - "Integration" - ], - "summary": "Returns the status of all available integration schemas.", - "operationId": "AllSchemaStatus", - "parameters": [ { - "name": "include-errors", - "in": "query", + "name": "record-version-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { - "text/plain": { + "application/json": { "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - } - }, - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Arsenic trioxide [1327-53-3]", + "recordColor": "red", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": true, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true + }, + "versionNumber": 2, + "versionState": "unreleased", + "name": "Arsenic trioxide [1327-53-3]", + "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" } - }, - "text/json": { + } + } + }, + "400": { + "description": "Bad request. Record version state is not the latest version, is not released or withdrawn, or table is not version controlled.", + "content": { + "application/json": { "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + "$ref": "#/components/schemas/GsaGetModifiableRecordVersionControlException" + }, + "examples": { + "Example 1": { + "summary": "Invalid version state.", + "description": "A new version can only be created from the latest released or withdrawn record version.", + "value": { + "message": "Cannot create a new version from the record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", + "code": 400, + "errors": [ + { + "message": "Invalid version state 'Superseded'.", + "reason": "invalidVersionState", + "versionState": "superseded" + } + ] + } + }, + "Example 2": { + "summary": "Table is not version controlled.", + "value": { + "message": "Cannot create a new version from the record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", + "code": 400, + "errors": [ + { + "message": "Table is not version controlled.", + "reason": "notVersioned" + } + ] + } + }, + "Example 3": { + "summary": "Record version is not the latest version.", + "value": { + "message": "Cannot create a new version from the record version with GUID '060a7c46-5edd-4bb9-9f07-763b6b2ec118'.", + "code": 400, + "errors": [ + { + "message": "There is a newer version.", + "reason": "notTheLatestVersion", + "newerVersion": { + "versionNumber": 2, + "versionState": "unreleased", + "name": "Arsenic trioxide [1327-53-3] - new version", + "guid": "88e46391-0cf4-442d-ae47-44821b4160b0" + } + } + ] + } } } } @@ -26992,760 +23782,277 @@ }, "403": { "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/integration-schemas/{schema}": { - "put": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:withdraw": { + "post": { "tags": [ - "Integration" + "Records - Record Versions" ], - "summary": "Updates an integration schema.\r\nWill fail if the schema does not exist, is not valid, or if the user is not both a global administrator and an administrator for the schema.", - "operationId": "UpdateSchema", + "summary": "Withdraws the record version. Must be a released record version.", + "operationId": "WithdrawRecordVersion", "parameters": [ { - "name": "schema", + "name": "database-key", "in": "path", "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "responses": { - "201": { - "description": "Updated successfully", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "400": { - "description": "Bad request. Returns validation errors information" - }, - "403": { - "description": "Forbidden. User is not a global administrator or an administrator for the schema" }, - "404": { - "description": "Not Found. Schema does not exist" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - }, - "delete": { - "tags": [ - "Integration" - ], - "summary": "Delete an integration schema. Will fail if the schema does not exist, or if the user is not both a global administrator and an administrator for the schema.", - "operationId": "DeleteSchema", - "parameters": [ { - "name": "schema", + "name": "table-guid", "in": "path", - "description": "Schema to be deleted", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } - } - ], - "responses": { - "204": { - "description": "Schema deleted" - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Schema not found" - } - } - }, - "get": { - "tags": [ - "Integration" - ], - "summary": "Returns the full object representing the integration schema.\r\nNames and identities of source items will be populated if they can be found in the databases currently loaded in MI, otherwise just the GUIDs will be returned.", - "operationId": "GetSchema", - "parameters": [ { - "name": "schema", + "name": "record-history-guid", "in": "path", - "description": "The schema name.", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "includeImplicitAttributes", - "in": "query", - "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", + "name": "record-version-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Arsenic trioxide [1327-53-3]", + "recordColor": "red", + "capabilities": { + "canWrite": true, + "canModify": false, + "canRelease": false, + "canGetModifiableVersion": true, + "canWithdraw": false, + "canDelete": false + }, + "versionNumber": 1, + "versionState": "withdrawn", + "name": "Arsenic trioxide [1327-53-3]", + "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" } - }, - "text/json": { + } + } + }, + "400": { + "description": "Bad request. Record version state is not released, or table is not version controlled.", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaWithdrawRecordVersionControlException" + }, + "examples": { + "Example 1": { + "summary": "Invalid version state.", + "description": "Only released record versions can be withdrawn.", + "value": { + "message": "Cannot withdraw record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", + "code": 400, + "errors": [ + { + "message": "Invalid version state 'Unreleased'.", + "reason": "invalidVersionState", + "versionState": "unreleased" + } + ] + } + }, + "Example 2": { + "summary": "Table is not version controlled.", + "value": { + "message": "Cannot withdraw record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", + "code": 400, + "errors": [ + { + "message": "Table is not version controlled.", + "reason": "notVersioned" + } + ] + } + } } } } }, "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/integration-schemas/{schema}/attributes": { + "/v1alpha/schema/mi-version": { "get": { "tags": [ - "Integration" - ], - "summary": "Returns a list of the attributes defined in the integration schema.", - "operationId": "SchemaTargets", - "parameters": [ - { - "name": "schema", - "in": "path", - "description": "The schema name.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "includeImplicitAttributes", - "in": "query", - "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", - "schema": { - "type": "boolean" - } - } + "Schema" ], + "summary": "Returns the currently running MI version to the caller.", + "operationId": "GetVersion", "responses": { "200": { "description": "OK", "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationAttribute" - } - } - }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationAttribute" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationAttribute" - } + "$ref": "#/components/schemas/GsaMiVersion" } } } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" } } } }, - "/v1alpha/integration-schemas/{schema}/sources/database/{database-key}/table/{table-identity}": { + "/v1alpha/security-attribute-groupings": { "get": { "tags": [ - "Integration" - ], - "summary": "Returns a list of the schema source mapping from the given table. Will fail if the database is not loaded in MI.\r\nNames and identities of source items will be populated.", - "operationId": "SchemaTableMappings", - "parameters": [ - { - "name": "schema", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } + "Schema" ], + "summary": "Gets all security attribute groupings for a given database.", + "operationId": "GetSecurityAttributeGroupings", "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" - } - } - }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSecurityAttributeGrouping" + } } } } } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" } } } }, - "/v1alpha/job-queue/jobs": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes": { "get": { "tags": [ - "JobQueue" + "Schema - Attributes" ], - "summary": "Get a list of jobs.", - "operationId": "GetJobs", + "summary": "Get all attributes in table", + "operationId": "GetAttributes", "parameters": [ { - "name": "jobType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", + "name": "database-key", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "nameFilter", - "in": "query", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "descriptionFilter", + "name": "mode", "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { + "enum": [ + "read", + "write" + ], "type": "string" } }, { - "name": "submitterNameFilter", - "in": "query", + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { + "enum": [ + "read", + "write" + ], "type": "string" } - }, - { - "name": "pageSize", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGetJobsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsResponse" + "$ref": "#/components/schemas/GsaAttributesInfo" } } } + }, + "404": { + "description": "Database, table or attribute not found" } } }, "post": { "tags": [ - "JobQueue" + "Schema - Attributes" ], - "summary": "Create a new job.", - "operationId": "CreateJob", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Created successfully", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } - } - } - } - }, - "delete": { - "tags": [ - "JobQueue" - ], - "summary": "Delete specified jobs.", - "operationId": "DeleteJobs", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - }, - "422": { - "description": "No job IDs were specified" - }, - "500": { - "description": "Failed to delete one or more jobs" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get job by ID.", - "operationId": "GetJob", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } - } - }, - "404": { - "description": "Job not found" - } - } - }, - "patch": { - "tags": [ - "JobQueue" - ], - "summary": "Update a job.", - "operationId": "UpdateJob", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } - } - }, - "404": { - "description": "Job not found" - } - } - }, - "delete": { - "tags": [ - "JobQueue" - ], - "summary": "Delete a job.", - "operationId": "DeleteJob", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "Success - no content" - }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}:retrieve-definition": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get a job creation object based on an existing job.", - "operationId": "RestoreJob", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - } - } - }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}:move-to-top": { - "post": { - "tags": [ - "JobQueue" - ], - "summary": "Move a job to the top of the queue (actually sets the scheduled execution date to now, could be done with patch method).", - "operationId": "MoveToTop", + "summary": "Create a new attribute.", + "operationId": "CreateAttribute", "parameters": [ { - "name": "id", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK" }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}:resubmit": { - "post": { - "tags": [ - "JobQueue" - ], - "summary": "Resubmit a job.", - "operationId": "Resubmit", - "parameters": [ { - "name": "id", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -27758,1973 +24065,1966 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } - } - }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/files": { - "post": { - "tags": [ - "JobQueue" - ], - "summary": "Uploads an ephemeral file and returns an ID which can subsequently be used to refer to that file in a job creation request. Ephemeral files have a short lifespan\r\nand should be used to provide file data to jobs only. They should not be used as file storage.", - "operationId": "UploadFile", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - } - } - }, - "encoding": { - "file": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/GsaCreateAttribute" }, - "text/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}/outputs": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get a job's output filenames.", - "operationId": "GetOutputFilenames", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "type": "string" + "examples": { + "Example 1": { + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" + }, + "Example 2": { + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "050c780f-1afd-444f-af64-7bd6f899cef9" } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string" + }, + "Example 3": { + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" } - } - } - } - }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}/outputs:export": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Retrieve a job output file.", - "operationId": "GetJobOutputFile", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "fileName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "404": { - "description": "Job or file not found" - } - } - } - }, - "/v1alpha/job-queue/current-user": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get the current user.", - "operationId": "GetCurrentUser", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaCurrentUser" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrentUser" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrentUser" - } - } - } - } - } - } - }, - "/v1alpha/job-queue/processing-configuration": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get the processing configuration.", - "operationId": "GetProcessingConfig", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaProcessingConfig" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProcessingConfig" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaProcessingConfig" - } - } - } - } - } - } - }, - "/v1alpha/license/user-license:ensure-checked-out": { - "get": { - "tags": [ - "License" - ], - "summary": "Either checks out a user license for the requesting user, or returns an error response if no such license is available.\r\nThis method is a no-op because it relies on license check to happen within Granta.Server.Api.Auth.UserContextFilter", - "operationId": "EnsureUserLicenseAvailable", - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - } - } - } - } - } - }, - "/v1alpha/license/advanced-selection-license:ensure-checked-out": { - "get": { - "tags": [ - "License" - ], - "summary": "Determines whether the requesting user has an Advanced Selection license available.\r\nIf a user has a license available this will be checked out.", - "operationId": "EnsureAdvancedSelectionLicenseAvailable", - "responses": { - "200": { - "description": "OK" - }, - "403": { - "description": "Forbidden", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - } - } - } - } - } - }, - "/v1alpha/license/server-licenses:ensure-checked-out": { - "post": { - "tags": [ - "License" - ], - "summary": "Checks out server wide licenses and returns a bool for each provided app name indicating if\r\nthe relevant license(s) required have been checked out.", - "operationId": "CheckoutAppLicense", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + }, + "Example 4": { + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", "value": { - "appNames": [ - "MI BoM Analyzer" - ] + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" } }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + }, + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "appNames": [ - "MI BoM Analyzer" - ] + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" } }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + }, + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "appNames": [ - "MI BoM Analyzer" - ] + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" } }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "appNames": [ - "MI BoM Analyzer" - ] + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" } }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" - } - } - } - } - } - } - }, - "/v1alpha/license/server-licenses": { - "get": { - "tags": [ - "License" - ], - "summary": "Get info on which server licenses are enabled, and the license expiry date.", - "operationId": "GetServerLicense", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaEnabledLicensesInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaEnabledLicensesInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaEnabledLicensesInfo" - } - } - } - } - } - } - }, - "/v1alpha/license/users/{userName}/licenses": { - "delete": { - "tags": [ - "License" - ], - "summary": "Removes all checked-out user and database licenses for the specified user.\r\nRestricted to MI System Administrators.", - "operationId": "RemoveUserLicenses", - "parameters": [ - { - "name": "userName", - "in": "path", - "description": "The username whose licenses should be removed.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No content - licenses removed (or user had no licenses)." - }, - "400": { - "description": "Bad request - username was not supplied." - }, - "403": { - "description": "Forbidden - caller is not a system administrator." - } - } - } - }, - "/api/v1/lists/audit/search": { - "post": { - "tags": [ - "ListAuditLog" - ], - "summary": "Posts a search request, and returns an object containing search result identifier", - "operationId": "RunListAuditLogSearch", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "listIdentifiers": [ - "89600164-b2b6-4789-864a-3f3aca60d626" - ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" - ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "listIdentifiers": [ - "89600164-b2b6-4789-864a-3f3aca60d626" - ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" - ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", "value": { - "listIdentifiers": [ - "89600164-b2b6-4789-864a-3f3aca60d626" - ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" - ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Mass" } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", + }, + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", "value": { - "listIdentifiers": [ - "89600164-b2b6-4789-864a-3f3aca60d626" + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Observed masses" + } + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" + "defaultThresholdType": "atLeast", + "name": "Max ratio" + } + }, + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "value": { + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" + } + }, + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "value": { + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" + } + }, + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" + } + }, + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "value": { + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" + } + }, + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + } ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/api/v1/lists/audit/search/results/{resultResourceIdentifier}": { - "get": { - "tags": [ - "ListAuditLog" - ], - "summary": "Returns the search results found in the specified resource", - "operationId": "GetListAuditLogSearchResults", - "parameters": [ - { - "name": "resultResourceIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListAuditLogItem" + }, + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + } + ], + "defaultThresholdType": "equal", + "name": "Environmental resistance" } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListAuditLogItem" + }, + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + }, + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } + ] + }, + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListAuditLogItem" + }, + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ + { + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" + }, + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" + }, + { + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" + } + ], + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "defaultThresholdType": "exists", + "name": "Restricted Substances" } } } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Search result not found" - }, - "410": { - "description": "Search result no longer available" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/items": { - "get": { - "tags": [ - "ListItem" - ], - "summary": "Returns the items in the given list", - "operationId": "GetListItems", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/items/add": { - "post": { - "tags": [ - "ListItem" - ], - "summary": "Adds the specified items to an existing list.", - "operationId": "AddItemsToList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - } - } - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/items/remove": { - "post": { - "tags": [ - "ListItem" - ], - "summary": "Removed the specified items from an existing list.", - "operationId": "RemoveItemsFromList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } - } - } - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists": { - "get": { - "tags": [ - "ListManagement" - ], - "summary": "Returns all lists visible to the calling user", - "operationId": "GetAllLists", - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeadersInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeadersInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeadersInfo" - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - }, - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Creates a new list with the specified properties and items.", - "operationId": "CreateList", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/api/v1/lists/search": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Posts a search request, and returns an object containing search result identifier", - "operationId": "RunRecordListsSearch", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/api/v1/lists/search/results/{resultResourceIdentifier}": { - "get": { - "tags": [ - "ListManagement" - ], - "summary": "Returns the search results found in the specified resource", - "operationId": "GetRecordListSearchResults", - "parameters": [ - { - "name": "resultResourceIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Search result not found" - }, - "410": { - "description": "Search result no longer available" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}": { - "get": { - "tags": [ - "ListManagement" - ], - "summary": "Returns the given list if it exists and the calling user has read access to it", - "operationId": "GetList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - }, - "patch": { - "tags": [ - "ListManagement" - ], - "summary": "Performs a partial update on the properties of a list.", - "operationId": "UpdateList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" + "$ref": "#/components/schemas/GsaCreateAttribute" }, "examples": { "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" } }, "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "050c780f-1afd-444f-af64-7bd6f899cef9" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" - }, - "examples": { - "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", + }, + "Example 3": { + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" } }, - "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", + "Example 4": { + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" - }, - "examples": { - "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", + }, + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" } }, - "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" - }, - "examples": { - "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", + }, + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" } }, - "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" + } + }, + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" + } + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" + } + }, + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" + } + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" + } + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" + } + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Mass" + } + }, + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Observed masses" + } + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "defaultThresholdType": "atLeast", + "name": "Max ratio" + } + }, + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "value": { + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" + } + }, + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "value": { + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" + } + }, + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" + } + }, + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "value": { + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" + } + }, + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + } + ], + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" + } + }, + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + } + ], + "defaultThresholdType": "equal", + "name": "Environmental resistance" + } + }, + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + }, + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } + ] + }, + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" + } + }, + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ + { + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" + }, + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" + }, + { + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" + } + ], + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "defaultThresholdType": "exists", + "name": "Restricted Substances" } } } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - }, - "delete": { - "tags": [ - "ListManagement" - ], - "summary": "Delete an existing list.", - "operationId": "DeleteList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/request-approval": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Update the status of an existing list to \"awaiting approval\".", - "operationId": "RequestApproval", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/reset": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Update the status of an existing list to not be \"awaiting approval\".", - "operationId": "ResetAwaitingApproval", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/publish": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Update the status of an existing list to \"published\". The list must be awaiting approval, and not already published.\r\nThe \"awaiting approval\" flag will be reset to false.", - "operationId": "PublishList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/unpublish": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Update the status of an existing list to \"unpublished\". The list must be published, and awaiting approval.\r\nThe \"awaiting approval\" flag will be reset to false.", - "operationId": "UnpublishList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateAttribute" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/revise": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Creates a private copy of a list that can be revised.", - "operationId": "ReviseList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" + "examples": { + "Example 1": { + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" + } + }, + "Example 2": { + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "050c780f-1afd-444f-af64-7bd6f899cef9" + } + }, + "Example 3": { + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" + } + }, + "Example 4": { + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" + } + }, + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" + } + }, + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" + } + }, + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" + } + }, + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" + } + }, + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" + } + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" + } + }, + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" + } + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" + } + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" + } + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Mass" + } + }, + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Observed masses" + } + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "defaultThresholdType": "atLeast", + "name": "Max ratio" + } + }, + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "value": { + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" + } + }, + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "value": { + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" + } + }, + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" + } + }, + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "value": { + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" + } + }, + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + } + ], + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" + } + }, + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + } + ], + "defaultThresholdType": "equal", + "name": "Environmental resistance" + } + }, + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + }, + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } + ] + }, + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" + } + }, + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ + { + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" + }, + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" + }, + { + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" + } + ], + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "defaultThresholdType": "exists", + "name": "Restricted Substances" + } } } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/copy": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Creates a copy of the list and its items", - "operationId": "CopyList", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateAttribute" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/permissions/subscribe": { - "post": { - "tags": [ - "ListPermissions" - ], - "summary": "Subscribes the calling user to the specified list.", - "operationId": "Subscribe", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/permissions/unsubscribe": { - "post": { - "tags": [ - "ListPermissions" - ], - "summary": "Unsubscribes the calling user from the specified list.", - "operationId": "Unsubscribe", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" + "examples": { + "Example 1": { + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" + } + }, + "Example 2": { + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "050c780f-1afd-444f-af64-7bd6f899cef9" + } + }, + "Example 3": { + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" + } + }, + "Example 4": { + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" + } + }, + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" + } + }, + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" + } + }, + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" + } + }, + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" + } + }, + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" + } + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" + } + }, + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" + } + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" + } + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" + } + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Mass" + } + }, + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Observed masses" + } + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "defaultThresholdType": "atLeast", + "name": "Max ratio" + } + }, + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "value": { + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" + } + }, + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "value": { + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" + } + }, + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" + } + }, + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "value": { + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" + } + }, + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + } + ], + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" + } + }, + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + } + ], + "defaultThresholdType": "equal", + "name": "Environmental resistance" + } + }, + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + }, + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } + ] + }, + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" + } + }, + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ + { + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" + }, + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" + }, + { + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" + } + ], + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "defaultThresholdType": "exists", + "name": "Restricted Substances" + } } } } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - }, - "422": { - "description": "Unsubscribe Failed" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/permissions": { - "get": { - "tags": [ - "ListPermissions" - ], - "summary": "Gets all permissions associated with the specified list.", - "operationId": "GetPermissions", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } - ], + }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - }, - "post": { - "tags": [ - "ListPermissions" - ], - "summary": "Sets permissions for the specified list. Returns a collection of the created/updated permissions.", - "operationId": "SetPermissions", - "parameters": [ - { - "name": "listIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + "$ref": "#/components/schemas/GsaAttribute" + }, + "examples": { + "Example 5": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", + "value": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } + }, + "Example 6": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "4ee7d63a-ee60-4246-92de-4bf61bc48cec" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 8": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + } + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + } + } } } - } - }, - "responses": { - "202": { - "description": "Accepted", + }, + "400": { + "description": "Bad request", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" + "$ref": "#/components/schemas/GsaAttributeCreationException" + }, + "examples": { + "Example 1": { + "summary": "No such discrete type", + "description": "The GUID provided for the discrete type does not match a discrete type in the database.", + "value": { + "message": "Cannot create attribute 'Used material type'.", + "code": 400, + "errors": [ + { + "message": "Could not find discrete type with GUID '6da9f4b1-8ed5-4fa9-84bc-c1cb4438f4bf' in database 'MI_Training'.", + "guid": "6da9f4b1-8ed5-4fa9-84bc-c1cb4438f4bf", + "databaseKey": "MI_Training", + "entityType": "discreteType", + "reason": "noSuchEntity" + } + ] + } + }, + "Example 2": { + "summary": "Multiple validation errors for creating a MathsFunctional Attribute", + "description": "Unit not found; no expressions specified (and 'allow anonymous expressions' not set to true); parameterContents contains a parameter that is not in attributeParameters", + "value": { + "message": "Cannot create attribute 'Fatigue strength model'.", + "code": 400, + "errors": [ + { + "message": "Could not find unit with GUID 'a1a77958-022d-4e67-b874-2c9e8e219148' in database 'MI_Training'.", + "guid": "a1a77958-022d-4e67-b874-2c9e8e219148", + "databaseKey": "MI_Training", + "entityType": "unit", + "reason": "noSuchEntity" + }, + { + "message": "The Maths Functional attribute is not valid.", + "errors": [ + { + "message": "Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.", + "reason": "noExpressions" + }, + { + "message": "Parameters in parameter contents must be from this attribute's parameters. GUIDs not found in attribute's parameters: '093b4156-aec3-43a6-9814-20bde5369b53'.", + "parameterGuids": [ + "093b4156-aec3-43a6-9814-20bde5369b53" + ], + "reason": "parameterContentUnknownParameters" + } + ], + "reason": "mathsFunctional" + } + ] + } + }, + "Example 3": { + "summary": "Invalid JSON", + "description": "The required property 'name' was not provided.", + "value": { + "message": "CreateDateTimeAttribute: Required property 'name' not found in JSON", + "code": 400 + } + } } } } }, - "400": { - "description": "Bad request" - }, "403": { "description": "Forbidden" }, "404": { - "description": "Record list or user or group not found" + "description": "Database or table not found" } } } }, - "/api/v1/lists/list/{listIdentifier}/permissions/user/{userIdentifier}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}": { "get": { "tags": [ - "ListPermissions" + "Schema - Attributes" ], - "summary": "Gets the permission flags of the permission associating the specified list with the specified user.", - "operationId": "GetPermissionsForUser", + "summary": "Get attribute in table", + "operationId": "GetAttribute", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "userIdentifier", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - } - } - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "User or group, record list or record list permission not found" - } - } - }, - "put": { - "tags": [ - "ListPermissions" - ], - "summary": "Sets the permission flags of the permission associating the specified list with the specified user.", - "operationId": "SetPermissionsForUser", - "parameters": [ { - "name": "listIdentifier", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -29733,578 +26033,277 @@ } }, { - "name": "userIdentifier", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - } + "enum": [ + "read", + "write" + ], + "type": "string" } }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list or user or group not found" - } - } - } - }, - "/v1alpha/metrics/jobs": { - "get": { - "tags": [ - "Metrics" - ], - "summary": "Get a summary of jobs currently running or completed since the start time.", - "operationId": "GetJobsSummary", - "parameters": [ { - "name": "start", - "in": "query", - "description": "The number of System.DateTime.Ticks that represent the UTC start time.", + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { + "enum": [ + "read", + "write" + ], "type": "string" } } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" - } - } - } - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Record Links" - ], - "summary": "Get record link results for the latest version of a given record history in a given table for a given record link group.", - "operationId": "GetLinkResultsForGroupForHistoryFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" + "$ref": "#/components/schemas/GsaAttribute" }, "examples": { "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "dc90ec7c-cf04-4886-90ca-3f99766942d4" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "cb810faf-12cc-4cde-9cbf-b7c8d7f8b784" - } - } - ] + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" } }, "Example 2": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" - } - } - ] - } - }, - "Example 3": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" - } - } - ] + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" } }, - "Example 4": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", + "Example 3": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "ca1e44ac-6117-4049-bcd6-97a962c27d1f" + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "8ace85be-2c9b-4981-8c6c-8ef40c439014" + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "ba34fb62-c340-4d04-b558-1debb756501e" + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "0ecf9f47-cfda-42e6-a797-22cffe4bfe45" + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "29caacd5-91f7-4d7c-923d-9ca3351a5ab1" } - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Record Links" - ], - "summary": "Get record link results for the latest version of a given record history for a given record link group", - "operationId": "GetLinkResultsForGroupForHistory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" - }, - "examples": { - "Example 5": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "7a9cb010-5ebb-4465-bf2e-bf8688a252a1" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "a4667318-9fb1-4ecf-8345-23d73dd4e80c" - } - } - ] + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" } }, - "Example 6": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", + "Example 4": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" }, - "results": [ + "tabularColumns": [ { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" }, { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" - } + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" }, { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" - } + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" } - ] - } - }, - "Example 7": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" } - } - ] - } - }, - "Example 8": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", - "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "c374e704-5b51-4460-84e6-a28bb87500f5" + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "83fbc71c-d88e-4c89-b288-69aad41c0db9" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "b57b3f29-7c9c-4174-a9ca-ef2ef2545887" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "01723302-a1f1-43d8-af20-d8fc888cf5f7" - } - } - ] + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } } } @@ -30312,53 +26311,28 @@ } }, "404": { - "description": "Database, record history or record link group not found" + "description": "Database, table or attribute not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { + }, + "patch": { "tags": [ - "Record Links" + "Schema - Attributes" ], - "summary": "Get record link results for a given record version in a given table and record history for a given record link group", - "operationId": "GetLinkResultsForGroupForVersionFromTable", + "summary": "Update attribute.", + "operationId": "UpdateAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", "required": true, "schema": { "type": "string", @@ -30366,2250 +26340,1452 @@ } }, { - "name": "record-link-group-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" - }, - "examples": { - "Example 9": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "7d36f357-b0c1-4e65-8a4e-530d9ec73c95" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "68f47e35-4548-498c-bf00-03f0074ba28a" - } - } - ] - } - }, - "Example 10": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" - } - } - ] - } - }, - "Example 11": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" - } - } - ] - } - }, - "Example 12": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", - "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "bdecdc62-6c86-4186-92ee-62c11d2e0fd7" - }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "a69accc7-e390-4006-90e8-7bf3d9845024" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "1c8700ed-f33c-4ed0-8431-3b88a09a15d2" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "7e2e79b0-5519-49d4-81a1-f94616aaf8fe" - } - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history, record version or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Record Links" - ], - "summary": "Get record link results for a given record version of a given record history for a given record link group", - "operationId": "GetLinkResultsForGroupForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" - }, - "examples": { - "Example 13": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "6360d43a-9a98-45d6-9a59-f380e29475f1" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "aed9cbfd-127c-44dc-b1cf-8e1d373f0e88" - } - } - ] - } - }, - "Example 14": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" - } - } - ] - } - }, - "Example 15": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" - } - } - ] - } - }, - "Example 16": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", - "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "a97be309-973e-45b0-b3b9-dcb2c0af2540" - }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "a7d067b9-6220-483f-a5d0-715100b552b7" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "e6aabaec-91af-4b0b-8ba5-56784c1e9632" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "41df61a5-5930-49e4-8ea5-5a1ab8f6304c" - } - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database, record history, record version or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}": { - "get": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Get a record history with a specified guid for a given database and table.", - "operationId": "GetRecordHistoryFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" - }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - } - } - }, - "404": { - "description": "Database, table or record history not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}": { - "get": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Get a record history with a specified guid for a given database.", - "operationId": "GetRecordHistory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" - }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - } - } - }, - "404": { - "description": "Database or record history not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories": { - "post": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Create a new record history.", - "operationId": "CreateRecordHistory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "record", - "name": "New Record Name" + "type": "discrete", + "name": "Metals (updated)" } }, "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" } }, "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "7179f01e-4c9a-47e2-a078-c2b6b7720cd4" + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" } }, "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "type": "discrete", + "defaultThresholdType": "equal" } }, "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "discrete", + "isHiddenFromSearchCriteria": true } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 6": { + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "recordType": "record", - "name": "New Record Name" + "type": "discrete", + "isMultiValued": true } }, - "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } + "type": "shortText", + "isUnique": true } }, - "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "7179f01e-4c9a-47e2-a078-c2b6b7720cd4" + "type": "point", + "isMultiValued": true } }, - "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] } }, - "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" } } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "recordType": "record", - "name": "New Record Name" + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" } }, - "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" } } }, - "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "7179f01e-4c9a-47e2-a078-c2b6b7720cd4" + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] } }, - "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } + ] + } } }, - "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + }, + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" } } + }, + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": null + } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "record", - "name": "New Record Name" + "type": "discrete", + "name": "Metals (updated)" } }, "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" } }, "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "7179f01e-4c9a-47e2-a078-c2b6b7720cd4" + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" } }, "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "type": "discrete", + "defaultThresholdType": "equal" } }, "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "discrete", + "isHiddenFromSearchCriteria": true } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "New Alumino Silicate Record", - "guid": "7b9199f2-3ad2-4678-a701-1010d9e6ef34" - } - ], - "subsets": [], - "guid": "207f6073-a59d-4e33-8bad-7dfb08c93a6a" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:move": { - "post": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Move a record history to be under a new parent.", - "operationId": "MoveRecordHistoryInTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 6": { + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "discrete", + "isMultiValued": true } }, - "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "shortText", + "isUnique": true } }, - "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "point", + "isMultiValued": true } }, - "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] + } + }, + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "value": { + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" } } }, - "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "value": { + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" + } }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + "value": { + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryMoveException" + } }, - "examples": { - "Example 1": { - "summary": "New parent is not a folder.", - "value": { - "message": "Cannot move Record History with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "errors": [ - { - "message": "New parent Record History (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder", - "parentRecordHistoryGuid": "17877254-3a26-4a28-94d6-9f6be164914c" - } - ] - } - }, - "Example 2": { - "summary": "New parent is not in the same table.", - "value": { - "message": "Cannot move Record History with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "0a0a07f6-20d8-4292-a275-a7385398d8a2", - "errors": [ - { - "message": "New parent Record History (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same Table.", - "reason": "ParentNotInSameTable", - "parentRecordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - ] - } - }, - "Example 3": { - "summary": "The 'short name' of the record to be moved is not unique under the new parent.", - "value": { - "message": "Cannot move Record History with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "b39060d9-ac86-48dc-9e75-7ea241b7a556", - "errors": [ + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "value": { + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] + } + }, + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "value": { + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ { - "message": "A Record History with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder", - "shortName": "Sheet" - } - ] - } - }, - "Example 4": { - "summary": "New parent is withdrawn.", - "value": { - "message": "Cannot move Record History with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "ce294339-e59d-4be1-a96c-f9e92adb71ac", - "errors": [ + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, { - "message": "New parent Record History (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn", - "parentRecordHistoryGuid": "4afa8a76-cd32-4835-be9d-31756bb9b7fb" - } - ] - } - }, - "Example 5": { - "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", - "value": { - "message": "Cannot move Record History with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "errors": [ + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, { - "message": "New parent Record History (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", - "reason": "ParentIsADescendant", - "parentRecordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583" + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } } ] } } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or record history not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:move": { - "post": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Move a record history to be under a new parent.", - "operationId": "MoveRecordHistory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" } }, - "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" } } }, - "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": null + } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { - "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "discrete", + "name": "Metals (updated)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" } }, - "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" } }, "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" - }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryMoveException" - }, - "examples": { - "Example 6": { - "summary": "New parent is not a folder.", - "value": { - "message": "Cannot move Record History with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "errors": [ - { - "message": "New parent Record History (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder", - "parentRecordHistoryGuid": "17877254-3a26-4a28-94d6-9f6be164914c" - } - ] - } - }, - "Example 7": { - "summary": "New parent is not in the same table.", - "value": { - "message": "Cannot move Record History with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "0a0a07f6-20d8-4292-a275-a7385398d8a2", - "errors": [ - { - "message": "New parent Record History (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same Table.", - "reason": "ParentNotInSameTable", - "parentRecordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - ] - } - }, - "Example 8": { - "summary": "The 'short name' of the record to be moved is not unique under the new parent.", - "value": { - "message": "Cannot move Record History with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "b39060d9-ac86-48dc-9e75-7ea241b7a556", - "errors": [ - { - "message": "A Record History with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder", - "shortName": "Sheet" - } - ] - } - }, - "Example 9": { - "summary": "New parent is withdrawn.", - "value": { - "message": "Cannot move Record History with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "ce294339-e59d-4be1-a96c-f9e92adb71ac", - "errors": [ - { - "message": "New parent Record History (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn", - "parentRecordHistoryGuid": "4afa8a76-cd32-4835-be9d-31756bb9b7fb" - } - ] - } - }, - "Example 10": { - "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", - "value": { - "message": "Cannot move Record History with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", - "code": "recordHistoryMove", - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "errors": [ - { - "message": "New parent Record History (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", - "reason": "ParentIsADescendant", - "parentRecordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - ] - } + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "defaultThresholdType": "equal" } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or record history not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:copy": { - "post": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Make a copy of a record history.", - "operationId": "CopyRecordHistoryInTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 5": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "type": "discrete", + "isHiddenFromSearchCriteria": true } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 6": { + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "discrete", + "isMultiValued": true } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "type": "shortText", + "isUnique": true } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "point", + "isMultiValued": true } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + } } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" + } } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" - }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - } - ], - "guid": "52ad2d66-3302-4832-b103-74c1f743c480" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryCopyException" }, - "examples": { - "Example 1": { - "summary": "New parent is not a folder.", - "value": { - "message": "Cannot copy Record History with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "errors": [ - { - "message": "New parent Record History (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder", - "parentRecordHistoryGuid": "17877254-3a26-4a28-94d6-9f6be164914c" - } - ] - } - }, - "Example 2": { - "summary": "New parent is not in the same table.", - "value": { - "message": "Cannot copy Record History with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "0a0a07f6-20d8-4292-a275-a7385398d8a2", - "errors": [ + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "value": { + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ { - "message": "New parent Record History (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same Table.", - "reason": "ParentNotInSameTable", - "parentRecordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - ] - } - }, - "Example 3": { - "summary": "The 'short name' of the record to be copied is not unique under the new parent.", - "value": { - "message": "Cannot copy Record History with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "b39060d9-ac86-48dc-9e75-7ea241b7a556", - "errors": [ + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, { - "message": "A Record History with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder", - "shortName": "Sheet" - } - ] - } - }, - "Example 4": { - "summary": "New parent is withdrawn.", - "value": { - "message": "Cannot copy Record History with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "ce294339-e59d-4be1-a96c-f9e92adb71ac", - "errors": [ + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, { - "message": "New parent Record History (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn", - "parentRecordHistoryGuid": "4afa8a76-cd32-4835-be9d-31756bb9b7fb" + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } } ] } } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or record history not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:copy": { - "post": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Make a copy of a record history.", - "operationId": "CopyRecordHistory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" } }, - "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" + } } }, - "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "type": "link", + "target": null } } } }, - "application/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { - "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "type": "discrete", + "name": "Metals (updated)" } }, - "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" } }, - "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 3": { + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { + }, "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "type": "discrete", + "defaultThresholdType": "equal" } }, "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "discrete", + "isHiddenFromSearchCriteria": true } }, "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "type": "discrete", + "isMultiValued": true } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + }, + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "value": { + "type": "shortText", + "isUnique": true } }, - "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "type": "point", + "isMultiValued": true } }, - "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "value": { + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "value": { + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" + } + }, + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + "value": { + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" } - ], - "guid": "71e2f72e-d41e-4072-85e3-bd0b76181cb9" + } + }, + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "value": { + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] + } + }, + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "value": { + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } + ] + } + } + }, + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + }, + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" + } + } + }, + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": null + } } } } - }, - "400": { - "description": "Bad request", + } + }, + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryCopyException" + "$ref": "#/components/schemas/GsaAttribute" }, "examples": { - "Example 5": { - "summary": "New parent is not a folder.", + "Example 9": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", "value": { - "message": "Cannot copy Record History with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "errors": [ - { - "message": "New parent Record History (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder", - "parentRecordHistoryGuid": "17877254-3a26-4a28-94d6-9f6be164914c" - } - ] + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" } }, - "Example 6": { - "summary": "New parent is not in the same table.", + "Example 10": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot copy Record History with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "0a0a07f6-20d8-4292-a275-a7385398d8a2", - "errors": [ - { - "message": "New parent Record History (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same Table.", - "reason": "ParentNotInSameTable", - "parentRecordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - ] + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" } }, - "Example 7": { - "summary": "The 'short name' of the record to be copied is not unique under the new parent.", + "Example 11": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot copy Record History with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "b39060d9-ac86-48dc-9e75-7ea241b7a556", - "errors": [ - { - "message": "A Record History with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder", - "shortName": "Sheet" - } - ] + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "ec8462ef-592b-4b89-b8d2-c8a5e14a5b30" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" } }, - "Example 8": { - "summary": "New parent is withdrawn.", + "Example 12": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", "value": { - "message": "Cannot copy Record History with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryCopy", - "recordHistoryGuid": "ce294339-e59d-4be1-a96c-f9e92adb71ac", - "errors": [ + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, { - "message": "New parent Record History (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn", - "parentRecordHistoryGuid": "4afa8a76-cd32-4835-be9d-31756bb9b7fb" + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" } - ] + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or record history not found" + "description": "Database, table or attribute not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest": { - "get": { + }, + "delete": { "tags": [ - "Records - Record Histories" + "Schema - Attributes" ], - "summary": "Get the latest record version for a record history for a given database and table.", - "operationId": "GetLatestRecordVersionFromTable", + "summary": "Delete an attribute.", + "operationId": "DeleteAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { - "200": { - "description": "Ok", + "400": { + "description": "Bad request. Attribute in use.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" + "$ref": "#/components/schemas/GsaAttributeDeletionException" }, "example": { - "recordHistory": { - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Alumino silicate - 1720", - "recordColor": "fuchsia", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": false, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true - }, - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "message": "Cannot delete attribute 'Tensile strength' (GUID = '000000e3-0001-4fff-8fff-dd92ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in version controlled data.", + "reason": "usage", + "referencedByType": "versionControlledData" + }, + { + "message": "It is being used in one or more expressions.", + "reason": "usage", + "referencedByType": "expression", + "referencedBy": [ + { + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ] + } + ] } } } }, + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table or record history not found" + "description": "Database, table or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes": { "get": { "tags": [ - "Records - Record Histories" + "Schema - Attributes" ], - "summary": "Get the latest record version for a record history for a given database.", - "operationId": "GetLatestRecordVersion", + "summary": "Get all meta-attributes in table", + "operationId": "GetMetaAttributes", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "record-history-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -32620,7 +27796,7 @@ { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -32632,7 +27808,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -32648,83 +27824,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Alumino silicate - 1720", - "recordColor": "fuchsia", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": false, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true - }, - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "$ref": "#/components/schemas/GsaAttributesInfo" } } } }, "404": { - "description": "Database or record history not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}": { "get": { "tags": [ - "Records - Record Versions" + "Schema - Attributes" ], - "summary": "Get a record version with a specified guid for a given database, table and record history.", - "operationId": "GetRecordVersion", + "summary": "Get meta-attribute in table", + "operationId": "GetMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", "required": true, "schema": { "type": "string", @@ -32732,7 +27861,7 @@ } }, { - "name": "record-version-guid", + "name": "meta-attribute-guid", "in": "path", "required": true, "schema": { @@ -32743,7 +27872,7 @@ { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -32755,7 +27884,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -32771,143 +27900,276 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" + "$ref": "#/components/schemas/GsaAttribute" }, - "example": { - "recordHistory": { - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + "examples": { + "Example 13": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", + "value": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "Example 14": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Alumino silicate - 1720", - "recordColor": "fuchsia", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": false, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true + "Example 15": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "aadd98b2-1520-451d-9d04-c8a6b0fb485f" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } }, - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "Example 16": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + } + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + } } } } }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, table or meta-attribute not found" } } }, - "delete": { - "tags": [ - "Records - Record Versions" - ], - "summary": "Deletes the record version. If the table is version controlled, only the current unreleased record version can be deleted.", - "operationId": "DeleteRecordVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request. Table is version controlled and record version is not unreleased." - }, - "404": { - "description": "Database, table, record history or record version not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:release": { - "post": { + "patch": { "tags": [ - "Records - Record Versions" + "Schema - Attributes" ], - "summary": "Releases the record version. Must be an unreleased record version.", - "operationId": "ReleaseRecordVersion", + "summary": "Update meta-attribute.", + "operationId": "UpdateMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", "required": true, "schema": { "type": "string", @@ -32915,7 +28177,7 @@ } }, { - "name": "record-version-guid", + "name": "meta-attribute-guid", "in": "path", "required": true, "schema": { @@ -32924,148 +28186,480 @@ } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Arsenic trioxide [1327-53-3]", - "recordColor": "red", - "userCapabilities": { - "canWrite": true, - "canModify": false, - "canRelease": false, - "canGetModifiableVersion": true, - "canWithdraw": true, - "canDelete": false - }, - "versionNumber": 1, - "versionState": "released", - "name": "Arsenic trioxide [1327-53-3]", - "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null + } } } } - }, - "400": { - "description": "Bad request. Record version state is not unreleased, or table is not version controlled, or parent is not released.", + } + }, + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaReleaseRecordVersionControlException" + "$ref": "#/components/schemas/GsaAttribute" }, "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "Only unreleased record versions can be released.", + "Example 17": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", "value": { - "message": "Cannot release Record Version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", - "code": "releaseRecordVersionControl", - "recordVersionGuid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a", - "errors": [ - { - "message": "Invalid version state 'Released'.", - "reason": "invalidVersionState", - "versionState": "released" - } - ] + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" } }, - "Example 2": { - "summary": "Table is not version controlled.", + "Example 18": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot release Record Version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", - "code": "releaseRecordVersionControl", - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" } }, - "Example 3": { - "summary": "Parent is not released.", + "Example 19": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot release Record Version with GUID '12012148-2c4c-43e2-8e92-fe990d04dd0d'.", - "code": "releaseRecordVersionControl", - "recordVersionGuid": "12012148-2c4c-43e2-8e92-fe990d04dd0d", - "errors": [ + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "50456950-c170-4f95-bbb4-e779e7ff8d7b" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 20": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ { - "message": "Tree parent is not in a valid state to perform this operation.", - "reason": "invalidParentState" + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" } - ] + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, table or meta-attribute not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:get-modifiable-version": { - "post": { + }, + "delete": { "tags": [ - "Records - Record Versions" + "Schema - Attributes" ], - "summary": "Gets the latest modifiable record version, or creates a new one if none exists. The record version must be the latest version, and must be either released or withdrawn.", - "operationId": "GetModifiableRecordVersion", + "summary": "Delete a meta-attribute.", + "operationId": "DeleteMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", "required": true, "schema": { "type": "string", @@ -33073,7 +28667,7 @@ } }, { - "name": "record-version-guid", + "name": "meta-attribute-guid", "in": "path", "required": true, "schema": { @@ -33083,307 +28677,106 @@ } ], "responses": { - "201": { - "description": "Created", + "400": { + "description": "Bad request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" + "$ref": "#/components/schemas/GsaAttributeDeletionException" }, "example": { - "recordHistory": { - "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Arsenic trioxide [1327-53-3]", - "recordColor": "red", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": true, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true - }, - "versionNumber": 2, - "versionState": "unreleased", - "name": "Arsenic trioxide [1327-53-3]", - "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" - } - } - } - }, - "400": { - "description": "Bad request. Record version state is not the latest version, is not released or withdrawn, or table is not version controlled.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetModifiableRecordVersionControlException" - }, - "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "A new version can only be created from the latest released or withdrawn record version.", - "value": { - "message": "Cannot create a new version from the Record Version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", - "code": "getModifiableRecordVersionControl", - "recordVersionGuid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a", - "errors": [ - { - "message": "Invalid version state 'Superseded'.", - "reason": "invalidVersionState", - "versionState": "superseded" - } - ] - } - }, - "Example 2": { - "summary": "Table is not version controlled.", - "value": { - "message": "Cannot create a new version from the Record Version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", - "code": "getModifiableRecordVersionControl", - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] - } - }, - "Example 3": { - "summary": "Record version is not the latest version.", - "value": { - "message": "Cannot create a new version from the Record Version with GUID '330653b7-3734-425c-9a8a-cffb2d534e47'.", - "code": "getModifiableRecordVersionControl", - "recordVersionGuid": "330653b7-3734-425c-9a8a-cffb2d534e47", - "errors": [ + "message": "Cannot delete attribute 'Notes' (GUID = '98ddd57b-9fb0-4f99-98e6-9a2a792d0594').", + "code": 400, + "errors": [ + { + "message": "It is being used in version controlled data.", + "reason": "usage", + "referencedByType": "versionControlledData" + }, + { + "message": "It is being used in one or more search masks.", + "reason": "usage", + "referencedByType": "searchMask", + "referencedBy": [ { - "message": "There is a newer version.", - "reason": "notTheLatestVersion", - "newerVersion": { - "versionNumber": 2, - "versionState": "unreleased", - "name": "Arsenic trioxide [1327-53-3] - new version", - "guid": "279c6af8-559e-45dc-a8af-f4aaebbb512b" - } + "name": "Search mask that searches in Notes", + "guid": "fffce0f7-f454-4d9d-acba-1f82792b8439" } ] } - } + ] } } } }, + "200": { + "description": "OK" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, table or meta-attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:withdraw": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes": { + "get": { "tags": [ - "Records - Record Versions" + "Schema - Attributes" ], - "summary": "Withdraws the record version. Must be a released record version.", - "operationId": "WithdrawRecordVersion", + "summary": "Get meta-attributes for attribute", + "operationId": "GetMetaAttributesForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Arsenic trioxide [1327-53-3]", - "recordColor": "red", - "userCapabilities": { - "canWrite": true, - "canModify": false, - "canRelease": false, - "canGetModifiableVersion": true, - "canWithdraw": false, - "canDelete": false - }, - "versionNumber": 1, - "versionState": "withdrawn", - "name": "Arsenic trioxide [1327-53-3]", - "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" - } - } - } - }, - "400": { - "description": "Bad request. Record version state is not released, or table is not version controlled.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaWithdrawRecordVersionControlException" - }, - "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "Only released record versions can be withdrawn.", - "value": { - "message": "Cannot withdraw Record Version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", - "code": "withdrawRecordVersionControl", - "recordVersionGuid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a", - "errors": [ - { - "message": "Invalid version state 'Unreleased'.", - "reason": "invalidVersionState", - "versionState": "unreleased" - } - ] - } - }, - "Example 2": { - "summary": "Table is not version controlled.", - "value": { - "message": "Cannot withdraw Record Version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", - "code": "withdrawRecordVersionControl", - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history or record version not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/permission-category-access-controls": { - "get": { - "tags": [ - "Records - Record Versions" - ], - "summary": "Get permission-based access control settings for a given record version.\r\nReturns the access control for each permission in each category.", - "operationId": "GetRecordVersionPermissionCategoryAccessControls", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } }, { - "name": "table-guid", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "record-version-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -33393,108 +28786,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" - }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "$ref": "#/components/schemas/GsaAttributesInfo" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table, record history or record version not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database, table or attribute not found" } } }, - "patch": { + "post": { "tags": [ - "Records - Record Versions" + "Schema - Attributes" ], - "summary": "Update permission-based access control settings for a given record version.\r\nSets the access control for the given permissions.", - "description": "\r\n\r\nCan also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation)", - "operationId": "UpdateRecordVersionPermissionCategoryAccessControls", + "summary": "Create a new meta-attribute for attribute.", + "operationId": "CreateMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", "required": true, "schema": { "type": "string", @@ -33502,7 +28821,7 @@ } }, { - "name": "record-version-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -33515,340 +28834,68 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateAttribute" }, "examples": { "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateAttribute" }, "examples": { "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateAttribute" }, "examples": { "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateAttribute" }, "examples": { "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" } } } @@ -33856,211 +28903,331 @@ } }, "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" - }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "400": { - "description": "Bad request", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" + "$ref": "#/components/schemas/GsaAttribute" }, "examples": { - "Example 1": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID 'a9b0ba82-4a9b-4b02-aa99-b21ef7896f6e', but the permission category does not exist.", + "Example 25": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID 'a9b0ba82-4a9b-4b02-aa99-b21ef7896f6e' does not exist.", - "reason": "noSuchCategory", - "categoryGuid": "a9b0ba82-4a9b-4b02-aa99-b21ef7896f6e" - } - ] + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" } }, - "Example 2": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '7ca939e9-f234-452b-be32-7bf1f3581dfb' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", + "Example 26": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '7ca939e9-f234-452b-be32-7bf1f3581dfb' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "reason": "noSuchPermission", - "permissionGuid": "7ca939e9-f234-452b-be32-7bf1f3581dfb", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - ] + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" } }, - "Example 3": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", + "Example 27": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "reason": "duplicateCategoryGuids", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ] - } - ] + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "8891fdb5-a38c-463a-bd0b-d28b041874f1" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" } }, - "Example 4": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", + "Example 28": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "reason": "duplicatePermissionGuids", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ] + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" } - ] + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } } } } } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or record version not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/schema/mi-version": { - "get": { - "tags": [ - "Schema" - ], - "summary": "Returns the currently running MI version to the caller.", - "operationId": "GetVersion", - "responses": { - "200": { - "description": "OK", + "400": { + "description": "Bad request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMiVersion" + "$ref": "#/components/schemas/GsaAttributeCreationException" + }, + "example": { + "message": "Cannot create meta-attribute 'Notes'.", + "code": 400, + "errors": [ + { + "message": "The name or GUID is not valid.", + "errors": [ + { + "message": "Meta-attribute with GUID '56a0f034-3edc-445f-8953-ec21e2287000' already exists.", + "guid": "56a0f034-3edc-445f-8953-ec21e2287000", + "reason": "entityAlreadyExists", + "entityTypeName": "Meta-attribute" + } + ], + "reason": "namedEntity" + }, + { + "message": "Cannot have a meta-attribute as an 'About attribute'.", + "reason": "aboutAttributeCannotBeMeta" + } + ] } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or attribute not found" } } } }, - "/v1alpha/schema:resolve-link-targets": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}:validate": { "post": { "tags": [ - "Schema" + "Schema - Attributes" ], - "summary": "Gets all target tables that match the provided link target, for each target.\r\nThere could be several matches or no matches for each link target.\r\nFor example if two databases are loaded with the same databaseGuid and the databaseVersionGuid isn't specified,\r\nor if the databaseGuid and databaseVersionGuid are not specified and the tableGuid matches in several databases.\r\nThere could be no matches if the target database is not loaded.", - "description": "Note that all accessible databases will be checked.\r\n If write mode is requested, the user must have write access to all accessible databases.\r\n To use the latest versions available, don't set the version control mode.", - "operationId": "ResolveLinkTargets", + "summary": "Validates the provided value against the attributes data rules.", + "operationId": "ValidateAttribute", "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], @@ -34068,2161 +29235,2464 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" - }, - "examples": { - "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - } + "$ref": "#/components/schemas/GsaValidateAttributeRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" - }, - "examples": { - "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - } + "$ref": "#/components/schemas/GsaValidateAttributeRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" - }, - "examples": { - "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - } + "$ref": "#/components/schemas/GsaValidateAttributeRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" - }, - "examples": { - "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", - "value": { - "linkTargets": [ - { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - } + "$ref": "#/components/schemas/GsaValidateAttributeRequest" } } } }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsInfo" - }, - "examples": { - "Example 1": { - "summary": "Resolved links", - "description": "This example shows results from resolving two link targets.", - "value": { - "resolvedLinkTargets": [ - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" - }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - }, - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "ProcessUniverse English Display Name", - "fr": "ProcessUniverse French Display Name" - }, - "name": "ProcessUniverse", - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Resolved links with multiple targets", - "description": "In this example, the first link target resolves to two copies of MaterialUniverse, each in different databases. This could happen if both databases have the same databaseGuid and the databaseVersionGuid was not specified in the request;or if the databaseGuid and databaseVersionGuid were not specified and the tableGuid matches.", - "value": { - "resolvedLinkTargets": [ - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" - }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "databaseKey": "AnotherDatabase", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse in another database", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - }, - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "ProcessUniverse English Display Name", - "fr": "ProcessUniverse French Display Name" - }, - "name": "ProcessUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - ] - } - }, - "Example 3": { - "summary": "Resolved links with missing targets", - "description": "In this example, the first link target does not resolve to any table. This could happen if the target database is not loaded.", - "value": { - "resolvedLinkTargets": [ - { - "linkTarget": { - "databaseGuid": "52dfaf4a-fe83-4e65-9ebf-4a5fb065277d", - "tableGuid": "4b26d73c-09df-4b06-b9e2-8309d367903c" - }, - "tables": [] - }, - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "ProcessUniverse English Display Name", - "fr": "ProcessUniverse French Display Name" - }, - "name": "ProcessUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - ] - } - } + "$ref": "#/components/schemas/GsaAttributeValidateResponse" } } } }, "400": { "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}:validate": { + "post": { "tags": [ "Schema - Attributes" ], - "summary": "Get all attributes in table", - "operationId": "GetAttributes", + "summary": "Validates the provided value against the meta attributes data rules.", + "operationId": "ValidateMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "meta-attribute-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributesInfo" - } - } - } - }, - "404": { - "description": "Database, table or attribute not found" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAttributeValidateResponse" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or meta-attribute not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes:query": { "post": { "tags": [ "Schema - Attributes" ], - "summary": "Create a new attribute.", - "operationId": "CreateAttribute", + "summary": "Get attributes in table, populate the requested properties. Optionally filter the returned attributes.", + "operationId": "QueryAttributes", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Fetch all attributes with unit and meta attributes", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all attributes with custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true + } + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "193906bf-be6e-4717-afdb-e7d9e89f9cce" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "link" + ] + } } }, "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" - } - }, - "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ - { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true }, - { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" - } - ], - "name": "Delivery date (with meta-attributes)" - } - }, - "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + "name": true, + "guid": true }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "Example 5": { + "summary": "Fetch attribute with name \"Young's modulus\"", "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + "properties": { + "type": true, + "name": true, + "guid": true }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" + "filter": { + "name": [ + "Young's modulus" + ] + } } }, - "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 6": { + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } } - }, - "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all attributes with unit and meta attributes", "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } } }, - "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 2": { + "summary": "Fetch all attributes with custom properties", "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true + } + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 3": { + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "link" + ] + } } }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 4": { + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 5": { + "summary": "Fetch attribute with name \"Young's modulus\"", "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Young's modulus" + ] + } } }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 6": { + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } } - }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all attributes with unit and meta attributes", "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } } }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "Example 2": { + "summary": "Fetch all attributes with custom properties", "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Mass" - } - }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" - } - }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" - } - }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", - "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" - } - }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", - "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" - } - }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" - } - }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", - "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true + } + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 3": { + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - } - ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" + "filter": { + "type": [ + "link" + ] + } } }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 4": { + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "name": true, + "guid": true }, - "attributeParameters": [ - { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - } - ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 5": { + "summary": "Fetch attribute with name \"Young's modulus\"", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "name": true, + "guid": true }, - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "expressions": [ - { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } + "filter": { + "name": [ + "Young's modulus" ] - }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + } } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 6": { + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ - { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" - }, - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" - }, - { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" - } - ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + "properties": { + "type": true, + "name": true, + "guid": true }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } } } } }, - "application/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Fetch all attributes with unit and meta attributes", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all attributes with custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true + } + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "193906bf-be6e-4717-afdb-e7d9e89f9cce" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "link" + ] + } } }, "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch attribute with name \"Young's modulus\"", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ - { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" - }, - { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" - } - ], - "name": "Delivery date (with meta-attributes)" + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Young's modulus" + ] + } } }, "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" - } - }, - "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + "properties": { + "type": true, + "name": true, + "guid": true }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" - } - }, - "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } } - }, - "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes:query": { + "post": { + "tags": [ + "Schema - Attributes" + ], + "summary": "Get meta-attributes in table, populate the requested properties. Optionally filter the returned meta-attributes.", + "operationId": "QueryMetaAttributes", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all meta-attributes", "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 2": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 3": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 4": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } - }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all meta-attributes", "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 2": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "Example 3": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true }, - "defaultThresholdType": "atLeast", - "name": "Mass" + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "Example 4": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } - }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all meta-attributes", "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "Example 2": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" - } - }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" - } - }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", - "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" - } - }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - } - ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 3": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true }, - "attributeParameters": [ - { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - } - ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 4": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "expressions": [ - { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] + "name": true, + "guid": true }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ - { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" - }, - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true }, - { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" - } - ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + "name": true, + "guid": true }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Fetch all meta-attributes", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "193906bf-be6e-4717-afdb-e7d9e89f9cce" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" - } - }, - "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ - { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true }, - { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" - } - ], - "name": "Delivery date (with meta-attributes)" - } - }, - "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + "name": true, + "guid": true }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" - } - }, - "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" - } - }, - "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" - } - }, - "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } - }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" - } - }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" - } - }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes:query": { + "post": { + "tags": [ + "Schema - Attributes" + ], + "summary": "Get meta-attributes for attribute, populate the requested properties. Optionally filter the returned meta-attributes.", + "operationId": "QueryMetaAttributesForAttribute", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 6": { + "summary": "Fetch all meta-attributes", "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 7": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 8": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "Example 9": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "defaultThresholdType": "atLeast", - "name": "Mass" + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "Example 10": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } - }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 6": { + "summary": "Fetch all meta-attributes", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "Example 7": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "Example 8": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 9": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "Example 10": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } - }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 6": { + "summary": "Fetch all meta-attributes", "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - } - ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 7": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - } - ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 8": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "expressions": [ - { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + "aboutAttribute": { + "type": true, + "name": true, + "guid": true }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] + "displayNames": true, + "name": true, + "guid": true }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 9": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ - { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true }, - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } + } + }, + "Example 10": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true }, - { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" - } - ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + "name": true, + "guid": true }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { - "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" - } - }, - "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" - } - }, - "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "193906bf-be6e-4717-afdb-e7d9e89f9cce" - } - }, - "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" - } - }, - "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ - { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" - }, - { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" - } - ], - "name": "Delivery date (with meta-attributes)" - } - }, "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", + "summary": "Fetch all meta-attributes", "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "summary": "Fetch all meta-attributes with custom properties", "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } } }, "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" - } - }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" - } - }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" - } - }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" - } - }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" - } - }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" - } - }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "defaultThresholdType": "atLeast", - "name": "Mass" - } - }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" - } - }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Attribute not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/configurations/{configuration-type}": { + "get": { + "tags": [ + "Schema - Configurations" + ], + "summary": "Get all configurations of given type", + "operationId": "GetConfigurations", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration-type", + "in": "path", + "description": "The configuration type.", + "required": true, + "schema": { + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConfigurationsInfo" }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "example": { + "configurations": [ + { + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + } + ] + } + } + } + }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Configurations" + ], + "summary": "Create a new configuration.", + "operationId": "CreateConfiguration", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration-type", + "in": "path", + "description": "The configuration type.", + "required": true, + "schema": { + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConfiguration" + }, + "examples": { + "Example 1": { + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "Example 2": { + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "54feeca4-fa7f-42f0-ae38-6cb34d490dba" } - }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConfiguration" + }, + "examples": { + "Example 1": { + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "Example 2": { + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "54feeca4-fa7f-42f0-ae38-6cb34d490dba" } - }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConfiguration" + }, + "examples": { + "Example 1": { + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - } - ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 2": { + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - } - ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "54feeca4-fa7f-42f0-ae38-6cb34d490dba" } - }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConfiguration" + }, + "examples": { + "Example 1": { + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "expressions": [ - { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] - }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 2": { + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ - { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" - }, - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" - }, - { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" - } - ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "54feeca4-fa7f-42f0-ae38-6cb34d490dba" } } } @@ -36235,417 +31705,67 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaConfiguration" }, - "examples": { - "Example 5": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 6": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 7": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "8991933a-3b1a-4b2f-9b10-23ca07ec8a2d" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 8": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - } + "example": { + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributeCreationException" - }, - "examples": { - "Example 1": { - "summary": "No such discrete type", - "description": "The GUID provided for the discrete type does not match a discrete type in the database.", - "value": { - "message": "Cannot create Attribute 'Used material type'.", - "code": "attributeCreation", - "name": "Used material type", - "isMetaAttribute": false, - "errors": [ - { - "message": "Could not find Discrete Type with GUID '62eecaff-19d3-4804-95cd-f9e961b99a6b' in database 'MI_Training'.", - "reason": "noSuchEntity", - "guid": "62eecaff-19d3-4804-95cd-f9e961b99a6b", - "databaseKey": "MI_Training", - "entityType": "discreteType" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for creating a MathsFunctional Attribute", - "description": "Unit not found; no expressions specified (and 'allow anonymous expressions' not set to true); parameterContents contains a parameter that is not in attributeParameters", - "value": { - "message": "Cannot create Attribute 'Fatigue strength model'.", - "code": "attributeCreation", - "name": "Fatigue strength model", - "isMetaAttribute": false, - "errors": [ - { - "message": "Could not find Unit with GUID 'ddf9bf38-97f2-4181-a5ed-63e3f488cb45' in database 'MI_Training'.", - "reason": "noSuchEntity", - "guid": "ddf9bf38-97f2-4181-a5ed-63e3f488cb45", - "databaseKey": "MI_Training", - "entityType": "unit" - }, - { - "message": "The Maths Functional Attribute is not valid.", - "reason": "mathsFunctional", - "errors": [ - { - "message": "Maths Functional Attribute must have at least one Expression or have 'allow anonymous expressions' set to true.", - "reason": "noExpressions" - }, - { - "message": "Parameters in Parameter contents must be from this Attribute's Parameters. GUIDs not found in Attribute's Parameters: '18b8b953-8f4b-4747-a54e-9f3d6f19c789'.", - "reason": "parameterContentUnknownParameters", - "parameterGuids": [ - "18b8b953-8f4b-4747-a54e-9f3d6f19c789" - ] - } - ] - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateDateTimeAttribute: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}": { + "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}": { "get": { "tags": [ - "Schema - Attributes" + "Schema - Configurations" ], - "summary": "Get attribute in table", - "operationId": "GetAttribute", + "summary": "Get individual configuration", + "operationId": "GetConfiguration", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "configuration-type", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "The configuration type.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" } }, { - "name": "attribute-guid", + "name": "configuration-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { @@ -36654,311 +31774,57 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaConfiguration" }, - "examples": { - "Example 1": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 2": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 3": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "d086fa37-5389-49cf-8e4b-7d9091a5ebfb" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 4": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - } + "example": { + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" } } } }, "404": { - "description": "Database, table or attribute not found" + "description": "Database or configuration not found" } } }, "patch": { "tags": [ - "Schema - Attributes" + "Schema - Configurations" ], - "summary": "Update attribute.", - "operationId": "UpdateAttribute", + "summary": "Update a configuration.", + "operationId": "UpdateConfiguration", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "configuration-type", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "The configuration type.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" } }, { - "name": "attribute-guid", + "name": "configuration-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } @@ -36967,1188 +31833,886 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaUpdateConfiguration" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "discrete", - "name": "Metals (updated)" + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "80923f5e-13f6-4a95-b168-932e16bfd90c" } }, "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } + "name": "examples (updated)" } - }, - "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateConfiguration" + }, + "examples": { + "Example 1": { + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "discrete", - "displayNames": { - "fr": null - } + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "80923f5e-13f6-4a95-b168-932e16bfd90c" } }, - "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "Example 2": { + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "type": "discrete", - "displayNames": null + "name": "examples (updated)" } - }, - "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateConfiguration" + }, + "examples": { + "Example 1": { + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "80923f5e-13f6-4a95-b168-932e16bfd90c" } }, - "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "Example 2": { + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" + "name": "examples (updated)" } - }, - "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateConfiguration" + }, + "examples": { + "Example 1": { + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "discrete", - "defaultThresholdType": "equal" + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "80923f5e-13f6-4a95-b168-932e16bfd90c" } }, - "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "Example 2": { + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true + "name": "examples (updated)" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConfiguration" }, - "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", + "example": { + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or configuration not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Configurations" + ], + "summary": "Delete a configuration", + "operationId": "DeleteConfiguration", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration-type", + "in": "path", + "description": "The configuration type.", + "required": true, + "schema": { + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" + } + }, + { + "name": "configuration-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database or configuration not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}:export": { + "get": { + "tags": [ + "Schema - Configurations" + ], + "summary": "Get individual configuration as a file", + "operationId": "ExportConfiguration", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration-type", + "in": "path", + "description": "The configuration type.", + "required": true, + "schema": { + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" + } + }, + { + "name": "configuration-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "404": { + "description": "Database or configuration not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/constants": { + "get": { + "tags": [ + "Schema - Constants" + ], + "summary": "Get all constants", + "operationId": "GetConstants", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConstantsInfo" + }, + "example": { + "constants": [ + { + "name": "PI", + "guid": "00000001-0004-4fff-8fff-0000ffff0000" + }, + { + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + } + ] + } + } + } + }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Constants" + ], + "summary": "Create a new constant.", + "operationId": "CreateConstant", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which constant will be created", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Constant to add to database", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", "value": { - "type": "discrete", - "isMultiValued": true + "value": 0.0072973525693, + "name": "fine-structure constant" } }, - "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "shortText", - "isUnique": true + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "26e6d265-bfad-4960-b515-1a641ccd21f0" } }, - "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", "value": { - "type": "point", - "isMultiValued": true + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" } - }, - "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ] + "value": 0.0072973525693, + "name": "fine-structure constant" } }, - "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "26e6d265-bfad-4960-b515-1a641ccd21f0" } }, - "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } + "value": 0.0072973525693, + "name": "fine-structure constant" } }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "floatFunctional", - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "26e6d265-bfad-4960-b515-1a641ccd21f0" } }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] - } + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant" } }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" - }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" - } - ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "26e6d265-bfad-4960-b515-1a641ccd21f0" } }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" - } + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConstant" }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": null - } + "example": { + "unit": { + "symbol": "m/s", + "guid": "00000097-0013-4fff-8fff-0000ffff0000" + }, + "value": 300000000.0, + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" } } - }, - "application/json": { + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/constants/{constant-guid}": { + "get": { + "tags": [ + "Schema - Constants" + ], + "summary": "Get individual constant", + "operationId": "GetConstant", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "constant-guid", + "in": "path", + "description": "Guid of requested constant", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConstant" + }, + "example": { + "unit": { + "symbol": "m/s", + "guid": "00000097-0013-4fff-8fff-0000ffff0000" + }, + "value": 300000000.0, + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + } + } + } + }, + "404": { + "description": "Database or constant not found" + } + } + }, + "patch": { + "tags": [ + "Schema - Constants" + ], + "summary": "Update constant.", + "operationId": "UpdateConstant", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "constant-guid", + "in": "path", + "description": "Guid of constant to update", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "Constant data to be updated", + "content": { + "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaUpdateConstant" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "discrete", - "name": "Metals (updated)" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "a5648111-aff7-4018-8fe4-7ab24e944d93" } }, "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } + "name": "characteristic impedance of vacuum" } }, "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": { - "fr": null - } - } - }, - "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": null - } - }, - "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" - } - }, - "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "defaultThresholdType": "equal" - } - }, - "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true - } - }, - "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "isMultiValued": true - } - }, - "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true - } - }, - "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true - } - }, - "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", - "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } - } - }, - "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "c6d4d59f-f712-4f74-8dde-c09f3aaa3d28" } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateConstant" + }, + "examples": { + "Example 1": { + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "a5648111-aff7-4018-8fe4-7ab24e944d93" } }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "Example 2": { + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "type": "floatFunctional", - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] + "name": "characteristic impedance of vacuum" } }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "Example 3": { + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] - } + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "c6d4d59f-f712-4f74-8dde-c09f3aaa3d28" } - }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateConstant" + }, + "examples": { + "Example 1": { + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" - }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" - } - ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "a5648111-aff7-4018-8fe4-7ab24e944d93" } }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "Example 2": { + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" - } + "name": "characteristic impedance of vacuum" } }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "Example 3": { + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "link", - "target": null + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "c6d4d59f-f712-4f74-8dde-c09f3aaa3d28" } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaUpdateConstant" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "discrete", - "name": "Metals (updated)" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "a5648111-aff7-4018-8fe4-7ab24e944d93" } }, "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } + "name": "characteristic impedance of vacuum" } }, "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "type": "discrete", - "displayNames": { - "fr": null - } - } - }, - "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": null - } - }, - "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" - } - }, - "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "defaultThresholdType": "equal" - } - }, - "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true - } - }, - "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "isMultiValued": true - } - }, - "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true - } - }, - "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true - } - }, - "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", - "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } - } - }, - "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" - } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", - "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "c6d4d59f-f712-4f74-8dde-c09f3aaa3d28" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConstant" }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", - "value": { - "type": "floatFunctional", - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] - } + "example": { + "unit": { + "symbol": "m/s", + "guid": "00000097-0013-4fff-8fff-0000ffff0000" + }, + "value": 300000000.0, + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or constant not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Constants" + ], + "summary": "Delete a constant", + "operationId": "DeleteConstant", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "constant-guid", + "in": "path", + "description": "Guid of constant to delete", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "400": { + "description": "Bad request. Constant in use.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConstantDeletionException" }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", - "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, + "example": { + "message": "Cannot delete constant 'PI' (GUID = '00000001-0004-4fff-8fff-0000ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in one or more expressions.", + "reason": "usage", + "referencedByType": "expression", + "referencedBy": [ { - "type": "discrete", - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } ] } - } - }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + ] + } + } + } + }, + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database or constant not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/data-rules": { + "get": { + "tags": [ + "Schema - Data Rules" + ], + "summary": "Gets all data rules for a given database.", + "operationId": "GetDataRules", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataRulesInfo" + } + } + } + }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Data Rules" + ], + "summary": "Create a new data rule", + "operationId": "CreateDataRule", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateDataRule" + }, + "examples": { + "Example 1": { + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" - }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" - } - ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" } - }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateDataRule" + }, + "examples": { + "Example 1": { + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" - } + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" } - }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateDataRule" + }, + "examples": { + "Example 1": { + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", "value": { - "type": "link", - "target": null + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaCreateDataRule" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "name": "Metals (updated)" - } - }, - "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } - } - }, - "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": { - "fr": null - } - } - }, - "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": null - } - }, - "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" - } - }, - "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "defaultThresholdType": "equal" - } - }, - "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true - } - }, - "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "isMultiValued": true - } - }, - "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true - } - }, - "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", "value": { - "type": "point", - "isMultiValued": true - } - }, - "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", - "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } - } - }, - "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" - } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", - "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - } - }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", - "value": { - "type": "floatFunctional", - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] - } - }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", - "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] - } - } - }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" - }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" - } - ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" - } - } - }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": null + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" } } } @@ -38156,572 +32720,200 @@ } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "examples": { - "Example 13": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 14": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 15": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "f974f25e-7d73-4d25-9688-250a61fb2260" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 16": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - } + "$ref": "#/components/schemas/GsaDataRule" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributeUpdateException" - }, - "examples": { - "Example 1": { - "summary": "No such discrete type", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the discrete type of the 'Metals' attribute with GUID '0000000b-0001-4fff-8fff-dd92ffff0000', but the discrete type GUID provided did not match any known discrete type.", - "value": { - "message": "Cannot update Attribute with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'.", - "code": "attributeUpdate", - "attributeGuid": "0000000b-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "errors": [ - { - "message": "Could not find Discrete Type with GUID 'b484ecca-a18a-41c7-ad74-46c4bd44449c' in database 'MI_Training'.", - "reason": "noSuchEntity", - "guid": "b484ecca-a18a-41c7-ad74-46c4bd44449c", - "databaseKey": "MI_Training", - "entityType": "discreteType" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for updating a Point Attribute", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'Shape factor' attribute with GUID '00000144-0001-4fff-8fff-dd92ffff0000'.Unit not found; axisName was set to an empty string; attributeParameters cannot be added, because the attribute is not multi-valued", - "value": { - "message": "Cannot update Attribute with GUID '00000144-0001-4fff-8fff-dd92ffff0000'.", - "code": "attributeUpdate", - "attributeGuid": "00000144-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "errors": [ - { - "message": "Could not find Unit with GUID '57aab628-48fb-4e80-bbc3-aa3538e23a64' in database 'MI_Training'.", - "reason": "noSuchEntity", - "guid": "57aab628-48fb-4e80-bbc3-aa3538e23a64", - "databaseKey": "MI_Training", - "entityType": "unit" - }, - { - "message": "Axis name cannot be empty or whitespace.", - "reason": "emptyAxisName" - }, - { - "message": "Only Attributes marked as multi-valued can be parameterized.", - "reason": "pointParametersRequiresMultiValued" - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "UpdateDateTimeAttribute: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or attribute not found" + "description": "Database not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/data-rules/{data-rule-guid}": { + "get": { "tags": [ - "Schema - Attributes" + "Schema - Data Rules" ], - "summary": "Delete an attribute.", - "operationId": "DeleteAttribute", + "summary": "Gets a data rule for a given database and guid.", + "operationId": "GetDataRule", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "attribute-guid", + "name": "data-rule-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } ], "responses": { - "400": { - "description": "Bad request. Attribute in use.", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeDeletionException" - }, - "example": { - "message": "Cannot delete Attribute with GUID '000000e3-0001-4fff-8fff-dd92ffff0000'.", - "code": "deletion", - "entityType": "attribute", - "entityGuid": "000000e3-0001-4fff-8fff-dd92ffff0000", - "errors": [ - { - "message": "It is being used in version controlled data.", - "reason": "usage", - "referencedByType": "versionControlledData" - }, - { - "message": "It is being used in one or more expressions.", - "reason": "usage", - "referencedByType": "expression", - "referencedBy": [ - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ] - } - ] + "$ref": "#/components/schemas/GsaDataRule" } } } }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table or attribute not found" + "description": "Database or data rule not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes": { - "get": { + }, + "patch": { "tags": [ - "Schema - Attributes" + "Schema - Data Rules" ], - "summary": "Get all meta-attributes in table", - "operationId": "GetMetaAttributes", + "summary": "Edit a data rule", + "operationId": "UpdateDataRule", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "data-rule-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDataRule" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDataRule" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDataRule" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDataRule" + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributesInfo" + "$ref": "#/components/schemas/GsaDataRule" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or table not found" + "description": "Database or data rule name not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}": { - "get": { + }, + "delete": { "tags": [ - "Schema - Attributes" + "Schema - Data Rules" ], - "summary": "Get meta-attribute in table", - "operationId": "GetMetaAttribute", + "summary": "Delete a data rule.", + "operationId": "DeleteDataRule", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "data-rule-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, - { - "name": "meta-attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } + "400": { + "description": "Bad request." }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } + "403": { + "description": "Forbidden." }, + "404": { + "description": "Database or data rule not found." + } + } + } + }, + "/v1alpha/databases": { + "get": { + "tags": [ + "Schema - Databases" + ], + "summary": "Lists all databases that the user can see.", + "operationId": "GetAllDatabases", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "role", + "in": "query", "schema": { "enum": [ "read", - "write" + "write", + "powerUser", + "grant", + "admin" ], "type": "string" } @@ -38729,314 +32921,168 @@ ], "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaDatabasesInfo" }, - "examples": { - "Example 17": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 18": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 19": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "eb4ee109-76ef-4d87-a0ab-9dfeceddc202" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 20": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + "example": { + "databases": [ + { + "key": "MI_Training", + "status": "Ok", + "isReadOnly": false, + "isLocked": false, + "name": "MI Training", + "guid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "versionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "indexInSync": true, + "schemaVersion": "2022.08.18.01" } - } + ] } } } - }, - "404": { - "description": "Database, table or meta-attribute not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Attributes" + "Schema - Databases" ], - "summary": "Update meta-attribute.", - "operationId": "UpdateMetaAttribute", + "summary": "Adds a database to the MI server. Only available to users in the System Administrator role.", + "operationId": "AddDatabase", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + } + } + }, + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSlimDatabase" + } + } + } + }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + } + } + } + }, + "/v1alpha/databases/{database-key}": { + "get": { + "tags": [ + "Schema - Databases" + ], + "summary": "Returns details for a given database.", + "operationId": "GetDatabase", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatabase" + } + } } }, + "404": { + "description": "Database not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Databases" + ], + "summary": "Removes the database from the MI server. Only available to users in the System Administrator role.", + "operationId": "RemoveDatabase", + "parameters": [ { - "name": "table-guid", + "name": "database-key", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } - }, - { - "name": "meta-attribute-guid", + } + ], + "responses": { + "200": { + "description": "OK." + }, + "400": { + "description": "Bad request. Returned if database is in the \"Unloading\" state" + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database not found." + } + } + }, + "patch": { + "tags": [ + "Schema - Databases" + ], + "summary": "Update database details.", + "operationId": "UpdateDatabase", + "parameters": [ + { + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" + } + }, + { + "name": "allow-reload", + "in": "query", + "description": "This must be set to true if any of the following properties are patched:\r\n DatabaseKey, DataSource, UseIntegratedSecurity, SqlUserName, SqlPassword, InitialCatalog, Language, Guid.\r\n The database will reload after the changes have been applied.", + "schema": { + "type": "boolean", + "default": false } } ], @@ -39044,188 +33090,104 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, - "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "596faebf-4872-47b7-a220-441a204a9c84", + "guid": "32752ead-2f7d-481e-889a-089b93a65d12", + "name": "MI Training (Updated)" } }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", "value": { - "type": "longText", - "aboutAttribute": null + "author": "Ansys Granta Technical Training (Updated)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, - "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "596faebf-4872-47b7-a220-441a204a9c84", + "guid": "32752ead-2f7d-481e-889a-089b93a65d12", + "name": "MI Training (Updated)" } }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", "value": { - "type": "longText", - "aboutAttribute": null + "author": "Ansys Granta Technical Training (Updated)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, - "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "596faebf-4872-47b7-a220-441a204a9c84", + "guid": "32752ead-2f7d-481e-889a-089b93a65d12", + "name": "MI Training (Updated)" } }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", "value": { - "type": "longText", - "aboutAttribute": null + "author": "Ansys Granta Technical Training (Updated)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, - "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "596faebf-4872-47b7-a220-441a204a9c84", + "guid": "32752ead-2f7d-481e-889a-089b93a65d12", + "name": "MI Training (Updated)" } }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", "value": { - "type": "longText", - "aboutAttribute": null + "author": "Ansys Granta Technical Training (Updated)" } } } @@ -39234,521 +33196,333 @@ }, "responses": { "200": { - "description": "OK", + "description": "OK.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "examples": { - "Example 25": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 26": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 27": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "ce69a39f-c207-4202-90f1-05f088aa2eb7" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 28": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - } + "$ref": "#/components/schemas/GsaDatabase" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributeUpdateException" - }, - "example": { - "message": "Cannot update Meta-Attribute with GUID '05dc05c6-7e15-4790-81e2-34d4ea8750a8'.", - "code": "attributeUpdate", - "attributeGuid": "05dc05c6-7e15-4790-81e2-34d4ea8750a8", - "isMetaAttribute": true, - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Meta-Attribute with GUID '93a576de-1432-497b-83d4-43d1e045a7b5' already exists.", - "reason": "entityAlreadyExists", - "guid": "93a576de-1432-497b-83d4-43d1e045a7b5", - "entityType": "metaAttribute" - } - ] - }, - { - "message": "Cannot have a Meta-Attribute as an 'About Attribute'.", - "reason": "aboutAttributeCannotBeMeta" - } - ] - } - } - } + "description": "Bad request." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database, table or meta-attribute not found" + "description": "Database not found." } } - }, - "delete": { + } + }, + "/v1alpha/databases:validate": { + "post": { "tags": [ - "Schema - Attributes" + "Schema - Databases" ], - "summary": "Delete a meta-attribute.", - "operationId": "DeleteMetaAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "meta-attribute-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Validates whether a database can be added to MI server. Only available to users in the System Administrator role.", + "operationId": "ValidateDatabaseToAdd", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } } } - ], + }, "responses": { - "400": { - "description": "Bad request", + "200": { + "description": "OK.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeDeletionException" - }, - "example": { - "message": "Cannot delete Attribute with GUID 'fa1c0425-9060-4f9a-9516-fc5e49fbab07'.", - "code": "deletion", - "entityType": "attribute", - "entityGuid": "fa1c0425-9060-4f9a-9516-fc5e49fbab07", - "errors": [ - { - "message": "It is being used in version controlled data.", - "reason": "usage", - "referencedByType": "versionControlledData" - }, - { - "message": "It is being used in one or more search masks.", - "reason": "usage", - "referencedByType": "searchMask", - "referencedBy": [ - { - "name": "Search mask that searches in Notes", - "guid": "a805dc3a-f0e9-46ea-98af-3e0944a7a27c" - } - ] - } - ] + "$ref": "#/components/schemas/GsaAddDatabaseValidationResult" } } } }, - "200": { - "description": "OK" + "400": { + "description": "Bad request." }, "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or meta-attribute not found" + "description": "Forbidden." } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes": { - "get": { + "/v1alpha/databases/{database-key}:upgrade": { + "post": { "tags": [ - "Schema - Attributes" + "Schema - Databases" ], - "summary": "Get meta-attributes for attribute", - "operationId": "GetMetaAttributesForAttribute", + "summary": "Upgrade a database to the latest schema version. Only available to users in the System Administrator role.", + "operationId": "UpgradeDatabase", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSlimDatabase" + } + } } }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "400": { + "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\" or \"Unknown\" state" + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database not found." + } + } + } + }, + "/v1alpha/databases:upgrade-external": { + "post": { + "tags": [ + "Schema - Databases" + ], + "summary": "Upgrades an external database to the latest schema version. Only available to users in the System Administrator role.", + "operationId": "UpgradeDatabaseNotAddedToMi", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } } + } + }, + "responses": { + "200": { + "description": "OK." + }, + "400": { + "description": "Bad request. Returned if connecting user is not a db_owner on the database." }, + "403": { + "description": "Forbidden." + } + } + } + }, + "/v1alpha/databases/{database-key}:reload": { + "post": { + "tags": [ + "Schema - Databases" + ], + "summary": "Reloads a database. Only available to users in the System Administrator role.", + "operationId": "ReloadDatabase", + "parameters": [ { - "name": "attribute-guid", + "name": "database-key", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSlimDatabase" + } + } + } + }, + "400": { + "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\", \"SchemaUpgradeRequired\" or \"SchemaDowngradeRequired\" state" + }, + "403": { + "description": "Forbidden." }, + "404": { + "description": "Database not found." + } + } + } + }, + "/v1alpha/databases/{database-key}:lock": { + "post": { + "tags": [ + "Schema - Databases" + ], + "summary": "Lock database", + "operationId": "LockDatabase", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "database-key", + "in": "path", + "description": "Database to lock", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } } ], "responses": { "200": { - "description": "Ok", + "description": "OK.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributesInfo" + "$ref": "#/components/schemas/GsaDatabase" } } } }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + }, "404": { - "description": "Database, table or attribute not found" + "description": "Database not found." } } - }, + } + }, + "/v1alpha/databases/{database-key}:unlock": { "post": { "tags": [ - "Schema - Attributes" + "Schema - Databases" ], - "summary": "Create a new meta-attribute for attribute.", - "operationId": "CreateMetaAttribute", + "summary": "Unlock database", + "operationId": "UnlockDatabase", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database to unlock", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatabase" + } + } } }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database not found." + } + } + } + }, + "/v1alpha/databases/{database-key}/discrete-types": { + "get": { + "tags": [ + "Schema - Discrete Types" + ], + "summary": "Gets all discrete types for a given database.", + "operationId": "GetDiscreteTypes", + "parameters": [ { - "name": "table-guid", + "name": "database-key", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteTypesInfo" + } + } } }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Discrete Types" + ], + "summary": "Create a new discrete type.", + "operationId": "CreateDiscreteType", + "parameters": [ { - "name": "attribute-guid", + "name": "database-key", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "type": "string" } } ], @@ -39756,68 +33530,92 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" + "isOrdered": true, + "name": "Ordered Discrete Type" + } + }, + "Example 2": { + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", + "value": { + "isOrdered": false, + "name": "Unordered Discrete Type" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" + "isOrdered": true, + "name": "Ordered Discrete Type" + } + }, + "Example 2": { + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", + "value": { + "isOrdered": false, + "name": "Unordered Discrete Type" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" + "isOrdered": true, + "name": "Ordered Discrete Type" + } + }, + "Example 2": { + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", + "value": { + "isOrdered": false, + "name": "Unordered Discrete Type" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" + "isOrdered": true, + "name": "Ordered Discrete Type" + } + }, + "Example 2": { + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", + "value": { + "isOrdered": false, + "name": "Unordered Discrete Type" } } } @@ -39830,350 +33628,86 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "examples": { - "Example 33": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 34": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 35": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "74f98c7e-7d1f-44c5-8707-d434d3d7f9f1" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 36": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - } + "$ref": "#/components/schemas/GsaSlimDiscreteType" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributeCreationException" - }, - "example": { - "message": "Cannot create Meta-Attribute 'Notes'.", - "code": "attributeCreation", - "name": "Notes", - "isMetaAttribute": true, - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Meta-Attribute with GUID '1ff074e9-96f9-4f1d-affc-594423b3dc19' already exists.", - "reason": "entityAlreadyExists", - "guid": "1ff074e9-96f9-4f1d-affc-594423b3dc19", - "entityType": "metaAttribute" - } - ] - }, - { - "message": "Cannot have a Meta-Attribute as an 'About Attribute'.", - "reason": "aboutAttributeCannotBeMeta" - } - ] - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or attribute not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}:validate": { - "post": { + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}": { + "get": { "tags": [ - "Schema - Attributes" + "Schema - Discrete Types" ], - "summary": "Validates the provided value against the attributes data rules.", - "operationId": "ValidateAttribute", + "summary": "Gets a single discrete type.", + "operationId": "GetDiscreteType", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "discrete-type-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteType" + } + } + } + }, + "404": { + "description": "Database or discrete type not found" + } + } + }, + "patch": { + "tags": [ + "Schema - Discrete Types" + ], + "summary": "Update discrete type.", + "operationId": "UpdateDiscreteType", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "attribute-guid", + "name": "discrete-type-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } @@ -40182,189 +33716,209 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaUpdateDiscreteType" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaUpdateDiscreteType" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaUpdateDiscreteType" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaUpdateDiscreteType" } } } }, "responses": { "200": { - "description": "OK", + "description": "OK.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeValidateResponse" + "$ref": "#/components/schemas/GsaSlimDiscreteType" } } } }, "400": { - "description": "Bad request" + "description": "Bad request." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database, table or attribute not found" + "description": "Database or discrete type not found." } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}:validate": { - "post": { + }, + "delete": { "tags": [ - "Schema - Attributes" + "Schema - Discrete Types" ], - "summary": "Validates the provided value against the meta attributes data rules.", - "operationId": "ValidateMetaAttribute", + "summary": "Delete discrete type, including all of its discrete values.", + "operationId": "DeleteDiscreteType", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "meta-attribute-guid", + "name": "discrete-type-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" - } - } - } - }, "responses": { - "200": { - "description": "OK", + "400": { + "description": "Bad request. Discrete type in use by Attributes.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeValidateResponse" + "$ref": "#/components/schemas/GsaDiscreteTypeDeletionException" + }, + "example": { + "message": "Cannot delete discrete type 'MU Durability' (GUID = '00000083-0006-4fff-8fff-0000ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in one or more attributes.", + "reason": "usage", + "referencedByType": "attribute", + "referencedBy": [ + { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + ] + } + ] } } } }, - "400": { - "description": "Bad request" + "200": { + "description": "OK." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database, table or meta-attribute not found" + "description": "Database or discrete type not found." } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes:query": { - "post": { + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}:usages": { + "get": { "tags": [ - "Schema - Attributes" + "Schema - Discrete Types" ], - "summary": "Get attributes in table, populate the requested properties. Optionally filter the returned attributes.", - "operationId": "QueryAttributes", + "summary": "Gets objects that are using this discrete type.", + "operationId": "GetAttributesForType", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "discrete-type-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteTypeUsage" + }, + "example": { + "attributes": [ + { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" + }, + "name": "Reinforcement architecture", + "guid": "b172b9b3-228c-4784-9eaa-66349442f930" + } + ], + "tabularColumns": [ + { + "tabularAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "name": "Lay-up sequence details", + "guid": "af6fc0e6-dfbb-4f51-aad3-79419cd5ee92" + }, + "columns": [ + { + "name": "Ply/layer architecture", + "guid": "d0f981f1-9934-4518-af7e-f2a67573f0b0" + } + ] + } + ] + } + } } }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Database or discrete type not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/discrete-types:query": { + "post": { + "tags": [ + "Schema - Discrete Types" + ], + "summary": "Gets discrete types for a given database, populates the requested properties.", + "operationId": "QueryDiscreteTypes", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } } @@ -40373,1892 +33927,1445 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" }, "examples": { "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", + "summary": "Fetch all discrete types with custom properties", "value": { "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true + "discreteValues": { + "name": true, + "guid": true }, + "isOrdered": true, "name": true, "guid": true } } }, "Example 2": { - "summary": "Fetch all attributes with custom properties", + "summary": "Fetch all discrete types with name and discrete value names", "value": { "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true + "discreteValues": { + "name": true }, - "displayNames": true, - "name": true, - "guid": true + "name": true } } }, "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + "summary": "Fetch discrete type with name \"Surface Finish\"", "value": { "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, "name": true, "guid": true }, "filter": { - "type": [ - "link" + "name": [ + "Surface Finish" ] } } }, "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", "value": { "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, "name": true, "guid": true }, "filter": { - "type": [ - "shortText", - "longText" + "guid": [ + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" ] } } - }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all discrete types with custom properties", "value": { "properties": { - "type": true, + "discreteValues": { + "name": true, + "guid": true + }, + "isOrdered": true, "name": true, "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] } } }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 2": { + "summary": "Fetch all discrete types with name and discrete value names", "value": { "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } + "discreteValues": { + "name": true + }, + "name": true } } }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + "Example 3": { + "summary": "Fetch discrete type with name \"Surface Finish\"", "value": { "properties": { "name": true, "guid": true }, "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "name": [ + "Surface Finish" + ] } } }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + "Example 4": { + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", "value": { "properties": { - "discreteType": { - "name": true, - "guid": true - }, "name": true, "guid": true }, "filter": { - "discreteType": {} + "guid": [ + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" + ] } } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" }, "examples": { "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + "summary": "Fetch all discrete types with custom properties", "value": { "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, + "discreteValues": { "name": true, "guid": true }, + "isOrdered": true, "name": true, "guid": true - }, - "filter": { - "type": [ - "link" - ] } } }, - "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "Example 2": { + "summary": "Fetch all discrete types with name and discrete value names", "value": { "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, + "discreteValues": { "name": true }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] + "name": true } } }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", + "Example 3": { + "summary": "Fetch discrete type with name \"Surface Finish\"", "value": { "properties": { - "type": true, "name": true, "guid": true }, "filter": { "name": [ - "Young's modulus" + "Surface Finish" ] } } }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 4": { + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", "value": { "properties": { - "type": true, "name": true, "guid": true }, "filter": { "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" ] } } - }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } - } - }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } - } - }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } - } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" }, "examples": { "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + "summary": "Fetch all discrete types with custom properties", "value": { "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, + "discreteValues": { "name": true, "guid": true }, + "isOrdered": true, "name": true, "guid": true - }, - "filter": { - "type": [ - "link" - ] } } }, - "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "Example 2": { + "summary": "Fetch all discrete types with name and discrete value names", "value": { "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, + "discreteValues": { "name": true }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] + "name": true } } }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", + "Example 3": { + "summary": "Fetch discrete type with name \"Surface Finish\"", "value": { "properties": { - "type": true, "name": true, "guid": true }, "filter": { "name": [ - "Young's modulus" + "Surface Finish" ] } } }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 4": { + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", "value": { "properties": { - "type": true, "name": true, "guid": true }, "filter": { "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" ] } } - }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } - } - }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryDiscreteTypesInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values": { + "get": { + "tags": [ + "Schema - DiscreteTypes - DiscreteValues" + ], + "summary": "Gets all discrete values for a given discreteType, returned in order.", + "operationId": "GetDiscreteValues", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" + } + } + } + }, + "404": { + "description": "Database or discrete type not found" + } + } + }, + "post": { + "tags": [ + "Schema - DiscreteTypes - DiscreteValues" + ], + "summary": "Create new discrete value. It will be added at the end.", + "operationId": "CreateDiscreteValue", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" + }, + "examples": { + "Example 1": { + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } + "name": "New Discrete Value 1" } }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + "Example 2": { + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } + "name": "New Discrete Value 2", + "guid": "3a4a968e-1a4d-482f-b3b3-5d01a209567a" } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" }, "examples": { "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } + "name": "New Discrete Value 1" } }, "Example 2": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } + "name": "New Discrete Value 2", + "guid": "3a4a968e-1a4d-482f-b3b3-5d01a209567a" } - }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" + }, + "examples": { + "Example 1": { + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } + "name": "New Discrete Value 1" } }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + "Example 2": { + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } + "name": "New Discrete Value 2", + "guid": "3a4a968e-1a4d-482f-b3b3-5d01a209567a" } - }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" + }, + "examples": { + "Example 1": { + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } + "name": "New Discrete Value 1" } }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + "Example 2": { + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } + "name": "New Discrete Value 2", + "guid": "3a4a968e-1a4d-482f-b3b3-5d01a209567a" } } } } } }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or discrete type not found" + } + } + }, + "put": { + "tags": [ + "Schema - DiscreteTypes - DiscreteValues" + ], + "summary": "Replace the whole discrete value collection for a given discrete type.\r\nThis will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails.", + "operationId": "ReplaceDiscreteValues", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + } + } + }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" } } } }, "400": { - "description": "Bad request" + "description": "Bad Request. e.g. would delete a discrete value that is in use." }, "403": { "description": "Forbidden" }, "404": { - "description": "Table not found" + "description": "Database or discrete type not found" } } } }, - "/v1alpha/databases/{database-key}/attributes:query": { - "post": { + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values/{discrete-value-guid}": { + "get": { "tags": [ - "Schema - Attributes" + "Schema - DiscreteTypes - DiscreteValues" ], - "summary": "Get attributes in database, populate the requested properties. Optionally filter the returned attributes.", - "operationId": "QueryAttributesInDatabase", + "summary": "Gets specific discrete value for a given discreteType within a given database.", + "operationId": "GetDiscreteValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "discrete-value-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + } + } } }, + "404": { + "description": "Database, discrete type or discrete value not found" + } + } + }, + "patch": { + "tags": [ + "Schema - DiscreteTypes - DiscreteValues" + ], + "summary": "Update discrete value.", + "operationId": "UpdateDiscreteValue", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } + }, + { + "name": "discrete-type-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "discrete-value-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" + } + } + } + }, + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + } + } + } + }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database, discrete type or discrete value not found." + } + } + }, + "delete": { + "tags": [ + "Schema - DiscreteTypes - DiscreteValues" + ], + "summary": "Delete a single discrete value. It must not be used by any data, or the operation will fail.", + "operationId": "DeleteDiscreteValue", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "discrete-value-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "400": { + "description": "Bad request. Discrete value in use.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValueAggregateException" + } + } + } + }, + "200": { + "description": "OK." + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database, discrete type or discrete value not found." + } + } + } + }, + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values:find-unused": { + "get": { + "tags": [ + "Schema - DiscreteTypes - DiscreteValues" + ], + "summary": "Find discrete values that are not in use by any data", + "operationId": "FindUnusedDiscreteValues", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Database or discrete type not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get All Exporter Folders", + "operationId": "GetExportersFolders", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true + "example": { + "folders": [ + { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true + { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "MI_Training", + "guid": "19cc65a2-f8bf-4989-9859-e883756290de" }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } - } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true + "example": { + "folders": [ + { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "MI_Training", + "guid": "19cc65a2-f8bf-4989-9859-e883756290de" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } - } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true + "example": { + "folders": [ + { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" }, - "filter": { - "discreteType": {} + { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "MI_Training", + "guid": "19cc65a2-f8bf-4989-9859-e883756290de" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } + ] + } + } + } + }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Create a new Exporters Folder.", + "operationId": "CreateExportersFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateFolder" + }, + "examples": { + "Example 1": { + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + "value": { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", + "Example 1": { + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } - }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateFolder" + }, + "examples": { + "Example 1": { + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } - }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateFolder" + }, + "examples": { + "Example 1": { + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters:root-folder": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get Root Exporters Folder", + "operationId": "GetExportersRootFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } + } + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get Exporters Folder", + "operationId": "GetExportersFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } + "example": { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } + "example": { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "example": { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + } + } + } + }, + "404": { + "description": "Database or folder not found" + } + } + }, + "patch": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Update an existing Exporters Folder.", + "operationId": "UpdateExportersFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFolder" + }, + "examples": { + "Example 1": { + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } + "name": "New Folder Name" } }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", + "Example 2": { + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } + "guid": "b3fb7bbe-671a-4217-acf6-7287ca0e4f6e" } - }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFolder" + }, + "examples": { + "Example 1": { + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } + "name": "New Folder Name" } }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + "Example 2": { + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } + "guid": "b3fb7bbe-671a-4217-acf6-7287ca0e4f6e" } - }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFolder" + }, + "examples": { + "Example 1": { + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } + "name": "New Folder Name" } }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + "Example 2": { + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } + "guid": "b3fb7bbe-671a-4217-acf6-7287ca0e4f6e" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", + "Example 1": { + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } + "name": "New Folder Name" } }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", + "Example 2": { + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } + "guid": "b3fb7bbe-671a-4217-acf6-7287ca0e4f6e" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Delete an Exporter Folder.", + "operationId": "DeleteExportersFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}:child-folders": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get Child Exporters Folders", + "operationId": "GetExportersChildFolders", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true + "example": { + "folders": [ + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } - } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true + "example": { + "folders": [ + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } - } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true + "example": { + "folders": [ + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" }, - "filter": { - "discreteType": {} + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } - } + ] } } } + }, + "404": { + "description": "Database or folder not found" } - }, + } + } + }, + "/v1alpha/databases/{database-key}/exporters:re-fetch": { + "post": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Re-fetch the Exporter Files.", + "operationId": "RefetchExporters", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaExporterRefetchInfo" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaExporterRefetchInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaExporterRefetchInfo" } } } @@ -42275,700 +35382,320 @@ } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes:query": { + "/v1alpha/databases/{database-key}/exporters/{folder-guid}:move": { "post": { "tags": [ - "Schema - Attributes" + "Schema - Exporters" ], - "summary": "Get meta-attributes in table, populate the requested properties. Optionally filter the returned meta-attributes.", - "operationId": "QueryMetaAttributes", + "summary": "Move an existing Exporter Folder.", + "operationId": "MoveExportersFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Fetch all meta-attributes", + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } - }, - "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } - }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, - "application/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, - "examples": { - "Example 1": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get the Exporter Files in a Folder", + "operationId": "GetExportersFiles", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "example": { + "files": [ + { + "name": "exporter-1.exp", + "guid": "ed97e877-486a-4967-acbb-c86d967a9607" }, - "filter": { - "type": [ - "shortText", - "longText" - ] + { + "name": "no-transform.xslt", + "guid": "e39df5fd-1cf3-4e87-84b1-43f608355d59" } - } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + "example": { + "files": [ + { + "name": "exporter-1.exp", + "guid": "ed97e877-486a-4967-acbb-c86d967a9607" }, - "filter": { - "name": [ - "Notes" - ] + { + "name": "no-transform.xslt", + "guid": "e39df5fd-1cf3-4e87-84b1-43f608355d59" } - } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + "example": { + "files": [ + { + "name": "exporter-1.exp", + "guid": "ed97e877-486a-4967-acbb-c86d967a9607" }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] + { + "name": "no-transform.xslt", + "guid": "e39df5fd-1cf3-4e87-84b1-43f608355d59" } - } + ] } } - }, - "application/*+json": { + } + }, + "404": { + "description": "Database or folder not found" + } + } + }, + "post": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Create a new Exporter File.", + "operationId": "CreateExportersFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + }, + "description": { + "type": "string" } + } + }, + "encoding": { + "file": { + "style": "form" }, - "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } + "description": { + "style": "form" } } } } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "33a16bba-0620-405d-aee3-d2146084fd53" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "33a16bba-0620-405d-aee3-d2146084fd53" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "33a16bba-0620-405d-aee3-d2146084fd53" } } } @@ -42980,681 +35707,243 @@ "description": "Forbidden" }, "404": { - "description": "Table not found" + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}/meta-attributes:query": { - "post": { + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}": { + "get": { "tags": [ - "Schema - Attributes" + "Schema - Exporters" ], - "summary": "Get meta-attributes in database, populate the requested properties. Optionally filter the returned meta-attributes.", - "operationId": "QueryMetaAttributesInDatabase", + "summary": "Get the header information for an Exporter File", + "operationId": "GetExporterFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "file-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "f9494b07-1f81-44a2-b8a3-fd1be4616249" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "f9494b07-1f81-44a2-b8a3-fd1be4616249" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "f9494b07-1f81-44a2-b8a3-fd1be4616249" + } + } } }, + "404": { + "description": "Database, folder or file not found" + } + } + }, + "patch": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Update an existing Exporter File.", + "operationId": "UpdateExportersFile", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", + "Example 1": { + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "name": "New File Name" } }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", + "Example 2": { + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "description": "New description for Exporter file." } }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } + "guid": "cb44bd94-b602-4b61-99af-f3347aea8fed" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFile" + }, + "examples": { + "Example 1": { + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", + "value": { + "name": "New File Name" } }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", + "Example 2": { + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } + "description": "New description for Exporter file." } }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "guid": "cb44bd94-b602-4b61-99af-f3347aea8fed" } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", + "Example 1": { + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "name": "New File Name" } }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", + "Example 2": { + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } + "description": "New description for Exporter file." } }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "guid": "cb44bd94-b602-4b61-99af-f3347aea8fed" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + "Example 1": { + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } + "name": "New File Name" } }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", + "Example 2": { + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } + "description": "New description for Exporter file." } }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "guid": "cb44bd94-b602-4b61-99af-f3347aea8fed" } } } @@ -43663,11 +35952,48 @@ }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "72413554-5d49-4ae4-a154-1f874017bd34" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "72413554-5d49-4ae4-a154-1f874017bd34" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "72413554-5d49-4ae4-a154-1f874017bd34" } } } @@ -43679,703 +36005,191 @@ "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, folder or file not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes:query": { - "post": { + }, + "delete": { "tags": [ - "Schema - Attributes" + "Schema - Exporters" ], - "summary": "Get meta-attributes for attribute, populate the requested properties. Optionally filter the returned meta-attributes.", - "operationId": "QueryMetaAttributesForAttribute", + "summary": "Delete an Exporter File.", + "operationId": "DeleteExportersFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "attribute-guid", + "name": "file-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" }, + "404": { + "description": "Database, folder or file not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:export": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get Exporter File as a file", + "operationId": "ExportExportersFile", + "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "folder-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "responses": { + "200": { + "description": "Ok" + }, + "404": { + "description": "Database, folder or file not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:move": { + "post": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Move an existing Exporter File.", + "operationId": "MoveExportersFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } @@ -44384,11 +36198,48 @@ }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "106904e8-e8eb-4276-b9a6-ce70f21de9b3" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "106904e8-e8eb-4276-b9a6-ce70f21de9b3" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "106904e8-e8eb-4276-b9a6-ce70f21de9b3" } } } @@ -44400,50 +36251,58 @@ "description": "Forbidden" }, "404": { - "description": "Attribute not found" + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/permission-category-access-controls": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions": { "get": { "tags": [ - "Schema - Attributes" + "Schema - Expressions" ], - "summary": "Get permission-based access control settings for a given attribute.\r\nReturns the access control for each permission in each category.", - "operationId": "GetAttributePermissionCategoryAccessControls", + "summary": "Get all expressions for table", + "operationId": "GetExpressions", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -44453,113 +36312,51 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaExpressionsInfo" }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, + "examples": { + "Example 1": { + "summary": "Get all expressions", + "description": "This example demonstrates the response to getting all expressions from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "value": { + "expressions": [ { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } ] } - ] + } } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table or attribute not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or table not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Attributes" + "Schema - Expressions" ], - "summary": "Update permission-based access control settings for a given attribute.\r\nSets the access control for the given permissions.", - "description": "\r\n\r\nCan also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation)", - "operationId": "UpdateAttributePermissionCategoryAccessControls", + "summary": "Create a new expression.", + "operationId": "CreateExpression", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } @@ -44568,340 +36365,140 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { - "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, - "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "8136484c-e1c3-4821-9031-831c0f596e82" + } + }, + "Example 3": { + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "value": { + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { - "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, - "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "8136484c-e1c3-4821-9031-831c0f596e82" + } + }, + "Example 3": { + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "value": { + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { - "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, - "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "8136484c-e1c3-4821-9031-831c0f596e82" + } + }, + "Example 3": { + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "value": { + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { - "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, - "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "8136484c-e1c3-4821-9031-831c0f596e82" + } + }, + "Example 3": { + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "value": { + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } @@ -44909,197 +36506,158 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaExpression" }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "examples": { + "Example 2": { + "summary": "Get expression", + "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "value": { + "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "permissionAccessControls": [ + "attributeDependencies": [ { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": false + "name": "Young's modulus", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": true + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ + "name": "Fatigue strength at 10^7 cycles", + "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" + }, { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": false + "name": "Elongation", + "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 5": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '9b47ef1d-513b-4428-a2a9-9cb1438e37d5', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID '9b47ef1d-513b-4428-a2a9-9cb1438e37d5' does not exist.", - "reason": "noSuchCategory", - "categoryGuid": "9b47ef1d-513b-4428-a2a9-9cb1438e37d5" - } - ] - } - }, - "Example 6": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '35d44506-eaa0-4658-99a9-62cea028a0ab' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '35d44506-eaa0-4658-99a9-62cea028a0ab' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "reason": "noSuchPermission", - "permissionGuid": "35d44506-eaa0-4658-99a9-62cea028a0ab", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "name": "Yield strength (elastic limit)", + "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" } - ] - } - }, - "Example 7": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ + ], + "constantDependencies": [], + "parameterDependencies": [ { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "reason": "duplicateCategoryGuids", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ] - } - ] - } - }, - "Example 8": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "reason": "duplicatePermissionGuids", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ] + "name": "Stress Ratio", + "guid": "00000004-000a-4fff-8fff-0000ffff0000" } - ] + ], + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or attribute not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}/permission-category-access-controls": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}": { "get": { "tags": [ - "Schema - Attributes" + "Schema - Expressions" ], - "summary": "Get permission-based access control settings for a given meta-attribute.\r\nReturns the access control for each permission in each category.", - "operationId": "GetMetaAttributePermissionCategoryAccessControls", + "summary": "Get an expression with a specified guid for a given database and table.", + "operationId": "GetExpression", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "meta-attribute-guid", + "name": "expression-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { @@ -45108,107 +36666,115 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaExpression" }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "examples": { + "Example 1": { + "summary": "Get expression", + "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "value": { + "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "permissionAccessControls": [ + "attributeDependencies": [ { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": false + "name": "Young's modulus", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": true + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ + "name": "Fatigue strength at 10^7 cycles", + "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" + }, { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": false + "name": "Elongation", + "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": true + "name": "Yield strength (elastic limit)", + "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" } - ] + ], + "constantDependencies": [], + "parameterDependencies": [ + { + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "name": "Stress Ratio", + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } - ] + } } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table or meta-attribute not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database, table or expression not found" } } }, "patch": { "tags": [ - "Schema - Attributes" + "Schema - Expressions" ], - "summary": "Update permission-based access control settings for a given meta-attribute.\r\nSets the access control for the given permissions.", - "description": "\r\n\r\nCan also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation)", - "operationId": "UpdateMetaAttributePermissionCategoryAccessControls", + "summary": "Update an expression.", + "operationId": "UpdateExpression", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "meta-attribute-guid", + "name": "expression-guid", "in": "path", "required": true, "schema": { @@ -45221,340 +36787,104 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "de08a676-cdfb-4679-927a-c22f79f5291d" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Fatigue Model (Updated)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "de08a676-cdfb-4679-927a-c22f79f5291d" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Fatigue Model (Updated)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "de08a676-cdfb-4679-927a-c22f79f5291d" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Fatigue Model (Updated)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "de08a676-cdfb-4679-927a-c22f79f5291d" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Fatigue Model (Updated)" } } } @@ -45567,189 +36897,158 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaExpression" }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "examples": { + "Example 3": { + "summary": "Get expression", + "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "value": { + "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "permissionAccessControls": [ + "attributeDependencies": [ { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": false + "name": "Young's modulus", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": true + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ + "name": "Fatigue strength at 10^7 cycles", + "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" + }, { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": false + "name": "Elongation", + "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" }, { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 9": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '347552df-26c3-4c3a-b79a-097b98acf3fa', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID '347552df-26c3-4c3a-b79a-097b98acf3fa' does not exist.", - "reason": "noSuchCategory", - "categoryGuid": "347552df-26c3-4c3a-b79a-097b98acf3fa" - } - ] - } - }, - "Example 10": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '8f467aee-6d4b-44e6-b47b-d40d65db9105' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '8f467aee-6d4b-44e6-b47b-d40d65db9105' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "reason": "noSuchPermission", - "permissionGuid": "8f467aee-6d4b-44e6-b47b-d40d65db9105", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "name": "Yield strength (elastic limit)", + "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" } - ] - } - }, - "Example 11": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ + ], + "constantDependencies": [], + "parameterDependencies": [ { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "reason": "duplicateCategoryGuids", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ] - } - ] - } - }, - "Example 12": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "reason": "duplicatePermissionGuids", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ] + "name": "Stress Ratio", + "guid": "00000004-000a-4fff-8fff-0000ffff0000" } - ] + ], + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or meta-attribute not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database, table or expression not found" } } - } - }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}": { - "get": { + }, + "delete": { "tags": [ - "Schema - Configurations" + "Schema - Expressions" ], - "summary": "Get all configurations of given type", - "operationId": "GetConfigurations", + "summary": "Delete an expression.", + "operationId": "DeleteExpression", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "configuration-type", + "name": "table-guid", "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], + "type": "string", + "format": "uuid" + } + }, + { + "name": "expression-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or expression not found" + } + } + } + }, + "/v1alpha/standard-names": { + "get": { + "tags": [ + "Schema - Global Standard Names" + ], + "summary": "Gets all standard names from all databases, optionally filtered by the provided 'name' query parameter.", + "operationId": "GetGlobalStandardNames", + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Standard name to match. Optional.", + "schema": { "type": "string" } } @@ -45760,13 +37059,160 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConfigurationsInfo" + "$ref": "#/components/schemas/GsaStandardNamesInfo" + } + } + } + } + } + } + }, + "/v1alpha/standard-names:search": { + "post": { + "tags": [ + "Schema - Global Standard Names" + ], + "summary": "Find all standard names from all databases that match one of the names provided in the request.", + "operationId": "FindGlobalStandardNames", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaStandardNamesInfo" + } + } + } + } + } + } + }, + "/v1alpha/databases/{database-key}/help-folders": { + "get": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Get All Help File Folders", + "operationId": "GetHelpFolders", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" }, "example": { - "configurations": [ + "folders": [ { - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + }, + { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + }, + { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + }, + { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" } ] } @@ -45780,38 +37226,16 @@ }, "post": { "tags": [ - "Schema - Configurations" + "Schema - Help Files" ], - "summary": "Create a new configuration.", - "operationId": "CreateConfiguration", + "summary": "Create a new Help File Folder.", + "operationId": "CreateHelpFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], "type": "string" } } @@ -45820,100 +37244,60 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", - "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" - } - }, - "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "b7de3e13-8b28-44ed-8177-980958f622ba" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", - "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" - } - }, - "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "b7de3e13-8b28-44ed-8177-980958f622ba" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", - "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" - } - }, - "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "b7de3e13-8b28-44ed-8177-980958f622ba" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", - "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" - } - }, - "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "b7de3e13-8b28-44ed-8177-980958f622ba" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } @@ -45924,55 +37308,38 @@ "201": { "description": "Created", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaConfiguration" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "$ref": "#/components/schemas/GsaFolder" }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Explore Configuration file with the name 'examples', but there is already a file with that name.", - "value": { - "message": "Cannot create Configuration file 'examples'.", - "code": "fileCreation", - "name": "examples", - "folderType": "configuration", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "File with name 'examples' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "examples", - "parentEntityType": "folder", - "entityType": "file" - } - ] - } - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, @@ -45982,46 +37349,80 @@ } } }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}": { + "/v1alpha/databases/{database-key}/help-folders/:root-folder": { "get": { "tags": [ - "Schema - Configurations" + "Schema - Help Files" ], - "summary": "Get individual configuration", - "operationId": "GetConfiguration", + "summary": "Get Root Help File Folder", + "operationId": "GetHelpRootFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + } } }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}": { + "get": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Get Help File Folder", + "operationId": "GetHelpFolder", + "parameters": [ { - "name": "configuration-type", + "name": "database-key", "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], "type": "string" } }, { - "name": "configuration-guid", + "name": "folder-guid", "in": "path", "required": true, "schema": { @@ -46034,62 +37435,60 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConfiguration" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" } } } }, "404": { - "description": "Database or configuration not found" + "description": "Database or folder not found" } } }, "patch": { "tags": [ - "Schema - Configurations" + "Schema - Help Files" ], - "summary": "Update a configuration.", - "operationId": "UpdateConfiguration", + "summary": "Update an existing Help File Folder.", + "operationId": "UpdateHelpFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], "type": "string" } }, { - "name": "configuration-guid", + "name": "folder-guid", "in": "path", "required": true, "schema": { @@ -46102,96 +37501,84 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "e7fa95da-42e5-400c-b6d6-c355e4d9de11" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", "value": { - "name": "examples (updated)" + "guid": "5a5f1720-745b-40de-b3e6-364a587b3cfd" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "e7fa95da-42e5-400c-b6d6-c355e4d9de11" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", "value": { - "name": "examples (updated)" + "guid": "5a5f1720-745b-40de-b3e6-364a587b3cfd" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "e7fa95da-42e5-400c-b6d6-c355e4d9de11" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", "value": { - "name": "examples (updated)" + "guid": "5a5f1720-745b-40de-b3e6-364a587b3cfd" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "e7fa95da-42e5-400c-b6d6-c355e4d9de11" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", "value": { - "name": "examples (updated)" + "guid": "5a5f1720-745b-40de-b3e6-364a587b3cfd" } } } @@ -46202,94 +37589,63 @@ "200": { "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaConfiguration" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" + "$ref": "#/components/schemas/GsaFolder" }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a Configuration file to ''.", - "value": { - "message": "Cannot update Configuration file with GUID '9526fed7-7738-43db-979d-13cd8d584ada'.", - "code": "fileUpdate", - "fileGuid": "9526fed7-7738-43db-979d-13cd8d584ada", - "folderType": "configuration", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or configuration not found" + "description": "Database not found" } } }, "delete": { "tags": [ - "Schema - Configurations" + "Schema - Help Files" ], - "summary": "Delete a configuration", - "operationId": "DeleteConfiguration", + "summary": "Delete a Help File Folder.", + "operationId": "DeleteHelpFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], "type": "string" } }, { - "name": "configuration-guid", + "name": "folder-guid", "in": "path", "required": true, "schema": { @@ -46303,118 +37659,32 @@ "description": "Ok" }, "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or configuration not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:export": { - "get": { - "tags": [ - "Schema - Configurations" - ], - "summary": "Get configurations as a zip file", - "operationId": "ExportConfigurations", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", - "required": true, - "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true + "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}:export": { + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:child-folders": { "get": { "tags": [ - "Schema - Configurations" + "Schema - Help Files" ], - "summary": "Get individual configuration as a file", - "operationId": "ExportConfiguration", + "summary": "Get Child Help File Folders", + "operationId": "GetHelpChildFolders", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], "type": "string" } }, { - "name": "configuration-guid", + "name": "folder-guid", "in": "path", "required": true, "schema": { @@ -46427,120 +37697,59 @@ "200": { "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] } - } - }, - "x-is-file": true - }, - "404": { - "description": "Database or configuration not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:descendants": { - "get": { - "tags": [ - "Schema - Configurations" - ], - "summary": "Returns file information for all configurations for the specified type.", - "operationId": "GetDescendants", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", - "required": true, - "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar", - "materialSelectionAssistant" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/constants": { - "get": { - "tags": [ - "Schema - Constants" - ], - "summary": "Get all constants", - "operationId": "GetConstants", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { + }, + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaConstantsInfo" + "$ref": "#/components/schemas/GsaFoldersInfo" }, "example": { - "constants": [ + "folders": [ { - "value": 3.1415901184082031, - "name": "PI", - "guid": "00000001-0004-4fff-8fff-0000ffff0000" + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" }, { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" - }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" } ] } @@ -46548,160 +37757,91 @@ } }, "404": { - "description": "Database not found" + "description": "Database or folder not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:move": { "post": { "tags": [ - "Schema - Constants" + "Schema - Help Files" ], - "summary": "Create a new constant.", - "operationId": "CreateConstant", + "summary": "Move an existing Help File Folder.", + "operationId": "MoveHelpFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database in which constant will be created", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "requestBody": { - "description": "Constant to add to database", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" - } - }, - "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "4fa398a0-8b77-44a1-bf92-880f04c71cb5" - } - }, - "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" - } - }, - "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "4fa398a0-8b77-44a1-bf92-880f04c71cb5" - } - }, - "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" - } - }, - "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "4fa398a0-8b77-44a1-bf92-880f04c71cb5" - } - }, - "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" - } - }, - "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "4fa398a0-8b77-44a1-bf92-880f04c71cb5" - } - }, - "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } @@ -46709,139 +37849,69 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaConstant" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" - }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConstantCreationException" + "$ref": "#/components/schemas/GsaFolder" }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "A constant with the same name already exists in the database.", - "value": { - "message": "Cannot create Constant 'Speed of light'.", - "code": "constantCreation", - "name": "Speed of light", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Constant with name 'Speed of light' already exists.", - "reason": "nameAlreadyExists", - "name": "Speed of light", - "entityType": "constant" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "GUID already exists", - "description": "A constant with the same GUID already exists in the database.", - "value": { - "message": "Cannot create Constant 'NewConstant'.", - "code": "constantCreation", - "name": "NewConstant", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Constant with GUID '0000000f-0004-4fff-8fff-0000ffff0000' already exists.", - "reason": "entityAlreadyExists", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000", - "entityType": "constant" - } - ] - } - ] - } - }, - "Example 3": { - "summary": "Unit not found", - "description": "The specified unit GUID does not exist in the database.", - "value": { - "message": "Cannot create Constant 'NewConstant'.", - "code": "constantCreation", - "name": "NewConstant", - "errors": [ - { - "message": "Could not find Unit with GUID 'a699d60b-875c-4884-9812-a0bc39505aab'.", - "reason": "noSuchUnit", - "guid": "a699d60b-875c-4884-9812-a0bc39505aab" - } - ] - } - }, - "Example 4": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateConstant: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}/constants/{constant-guid}": { + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files": { "get": { "tags": [ - "Schema - Constants" + "Schema - Help Files" ], - "summary": "Get individual constant", - "operationId": "GetConstant", + "summary": "Get Files in a Folder", + "operationId": "GetHelpFiles", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database in which constant will be search for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "constant-guid", + "name": "folder-guid", "in": "path", - "description": "Guid of requested constant", "required": true, "schema": { "type": "string", @@ -46853,49 +37923,290 @@ "200": { "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaConstant" + "$ref": "#/components/schemas/GsaFilesInfo" }, "example": { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" - }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" - } - } - } - }, - "404": { - "description": "Database or constant not found" - } + "files": [ + { + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + }, + { + "name": "Atomic_volume.html", + "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" + }, + "example": { + "files": [ + { + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + }, + { + "name": "Atomic_volume.html", + "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" + }, + "example": { + "files": [ + { + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + }, + { + "name": "Atomic_volume.html", + "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" + } + ] + } + } + } + }, + "404": { + "description": "Database or folder not found" + } + } + }, + "post": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Create a new Help File.", + "operationId": "CreateHelpFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + }, + "description": { + "type": "string" + } + } + }, + "encoding": { + "file": { + "style": "form" + }, + "description": { + "style": "form" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "dfe916ca-59fb-4270-8ea8-66877e602afa" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "dfe916ca-59fb-4270-8ea8-66877e602afa" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "dfe916ca-59fb-4270-8ea8-66877e602afa" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}": { + "get": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Get header information for a help file", + "operationId": "GetHelpFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", + "description": "Description of Abrasion-rate file.", + "extension": "html", + "dataLength": 5090, + "path": "Help Pages\\html\\attributenotes\\en\\material", + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", + "description": "Description of Abrasion-rate file.", + "extension": "html", + "dataLength": 5090, + "path": "Help Pages\\html\\attributenotes\\en\\material", + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", + "description": "Description of Abrasion-rate file.", + "extension": "html", + "dataLength": 5090, + "path": "Help Pages\\html\\attributenotes\\en\\material", + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + } + } + } + }, + "404": { + "description": "Database, folder or file not found" + } } }, "patch": { "tags": [ - "Schema - Constants" + "Schema - Help Files" ], - "summary": "Update constant.", - "operationId": "UpdateConstant", + "summary": "Update an existing Help File.", + "operationId": "UpdateHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "constant-guid", + "name": "file-guid", "in": "path", - "description": "Guid of constant to update", "required": true, "schema": { "type": "string", @@ -46904,132 +38215,115 @@ } ], "requestBody": { - "description": "Constant data to be updated", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "8b911829-3589-46cb-b4f3-58d5e16fe845" + "name": "New File Name" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "characteristic impedance of vacuum" + "description": "New description for help file." } }, "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7c8bd26e-1778-4015-85a2-aca4924876f3" + "guid": "f5ad56df-1cf6-4fc8-b58e-ff5d6311422c" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "8b911829-3589-46cb-b4f3-58d5e16fe845" + "name": "New File Name" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "characteristic impedance of vacuum" + "description": "New description for help file." } }, "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7c8bd26e-1778-4015-85a2-aca4924876f3" + "guid": "f5ad56df-1cf6-4fc8-b58e-ff5d6311422c" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "8b911829-3589-46cb-b4f3-58d5e16fe845" + "name": "New File Name" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "characteristic impedance of vacuum" + "description": "New description for help file." } }, "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7c8bd26e-1778-4015-85a2-aca4924876f3" + "guid": "f5ad56df-1cf6-4fc8-b58e-ff5d6311422c" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "8b911829-3589-46cb-b4f3-58d5e16fe845" + "name": "New File Name" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "characteristic impedance of vacuum" + "description": "New description for help file." } }, "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7c8bd26e-1778-4015-85a2-aca4924876f3" + "guid": "f5ad56df-1cf6-4fc8-b58e-ff5d6311422c" } } } @@ -47040,126 +38334,88 @@ "200": { "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaConstant" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" - }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "1e8c3e09-fd7f-4edb-8368-e6f1272d48a0" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConstantUpdateException" + "$ref": "#/components/schemas/GsaFileHeader" }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "A constant with the same name already exists in the database.", - "value": { - "message": "Cannot update constant with GUID '44b2a0ed-300d-46f4-af24-e0a366e7bd49'.", - "code": "constantUpdate", - "constantGuid": "44b2a0ed-300d-46f4-af24-e0a366e7bd49", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Constant with name 'Speed of light' already exists.", - "reason": "nameAlreadyExists", - "name": "Speed of light", - "entityType": "constant" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "GUID already exists", - "description": "A constant with the same GUID already exists in the database.", - "value": { - "message": "Cannot update constant with GUID '1ba9d42b-a79f-4e64-b560-27c199824d8d'.", - "code": "constantUpdate", - "constantGuid": "1ba9d42b-a79f-4e64-b560-27c199824d8d", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Constant with GUID '0000000f-0004-4fff-8fff-0000ffff0000' already exists.", - "reason": "entityAlreadyExists", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000", - "entityType": "constant" - } - ] - } - ] - } - }, - "Example 3": { - "summary": "Unit not found", - "description": "The specified unit GUID does not exist in the database.", - "value": { - "message": "Cannot update constant with GUID '3ba8dc64-6122-4008-a3a4-896235798706'.", - "code": "constantUpdate", - "constantGuid": "3ba8dc64-6122-4008-a3a4-896235798706", - "errors": [ - { - "message": "Could not find Unit with GUID '419da583-80ad-4823-a6aa-48612f59c328'.", - "reason": "noSuchUnit", - "guid": "419da583-80ad-4823-a6aa-48612f59c328" - } - ] - } - } + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "1e8c3e09-fd7f-4edb-8368-e6f1272d48a0" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "1e8c3e09-fd7f-4edb-8368-e6f1272d48a0" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or constant not found" + "description": "Database, folder or file not found" } } }, "delete": { "tags": [ - "Schema - Constants" + "Schema - Help Files" ], - "summary": "Delete a constant", - "operationId": "DeleteConstant", + "summary": "Delete a Help File.", + "operationId": "DeleteHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "constant-guid", + "name": "file-guid", "in": "path", - "description": "Guid of constant to delete", "required": true, "schema": { "type": "string", @@ -47168,102 +38424,95 @@ } ], "responses": { - "400": { - "description": "Bad request. Constant in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaConstantDeletionException" - }, - "example": { - "message": "Cannot delete Constant with GUID '00000001-0004-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "entityType": "constant", - "entityGuid": "00000001-0004-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more expressions.", - "reason": "usage", - "referencedByType": "expression", - "referencedBy": [ - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ] - } - ] - } - } - } - }, "200": { "description": "Ok" }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database or constant not found" + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/data-rules": { + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:export": { "get": { "tags": [ - "Schema - Data Rules" + "Schema - Help Files" ], - "summary": "Gets all data rules for a given database.", - "operationId": "GetDataRules", + "summary": "Get help file as a file", + "operationId": "ExportHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataRulesInfo" - } - } - } + "description": "Ok" }, "404": { - "description": "Database not found" + "description": "Database, folder or file not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:move": { "post": { "tags": [ - "Schema - Data Rules" + "Schema - Help Files" ], - "summary": "Create a new data rule", - "operationId": "CreateDataRule", + "summary": "Move an existing Help File.", + "operationId": "MoveHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -47271,64 +38520,56 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } @@ -47336,12 +38577,49 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "334d5e67-1e29-42d7-ab96-a5858ea5165d" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataRule" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "334d5e67-1e29-42d7-ab96-a5858ea5165d" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "334d5e67-1e29-42d7-ab96-a5858ea5165d" } } } @@ -47353,37 +38631,25 @@ "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/data-rules/{data-rule-guid}": { + "/v1alpha/databases/{database-key}/home-page-folders": { "get": { "tags": [ - "Schema - Data Rules" + "Schema - Home Pages" ], - "summary": "Gets a data rule for a given database and guid.", - "operationId": "GetDataRule", + "summary": "Get All Home Page Folders", + "operationId": "GetHomePageFolders", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "data-rule-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -47391,43 +38657,80 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + }, + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "3e6c7ce3-e8b0-49de-a4d2-1ee6ff295dc4" + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataRule" + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + }, + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "3e6c7ce3-e8b0-49de-a4d2-1ee6ff295dc4" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + }, + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "3e6c7ce3-e8b0-49de-a4d2-1ee6ff295dc4" + } + ] } } } }, "404": { - "description": "Database or data rule not found" + "description": "Database not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Data Rules" + "Schema - Home Pages" ], - "summary": "Edit a data rule", - "operationId": "UpdateDataRule", + "summary": "Create a new Home Page Folder.", + "operationId": "CreateHomePageFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "data-rule-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -47435,33 +38738,95 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" + "$ref": "#/components/schemas/GsaCreateFolder" + }, + "examples": { + "Example 1": { + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" + "$ref": "#/components/schemas/GsaCreateFolder" + }, + "examples": { + "Example 1": { + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" + "$ref": "#/components/schemas/GsaCreateFolder" + }, + "examples": { + "Example 1": { + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" + "$ref": "#/components/schemas/GsaCreateFolder" + }, + "examples": { + "Example 1": { + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" + } + } } } } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataRule" + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } @@ -47473,250 +38838,156 @@ "description": "Forbidden" }, "404": { - "description": "Database or data rule name not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Data Rules" - ], - "summary": "Delete a data rule.", - "operationId": "DeleteDataRule", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "data-rule-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or data rule not found." + "description": "Database not found" } } } }, - "/v1alpha/databases": { + "/v1alpha/databases/{database-key}/home-page-folders:root-folder": { "get": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Lists all databases that the user can see.", - "operationId": "GetAllDatabases", + "summary": "Get Root Home Page Folder", + "operationId": "GetHomePageRootFolder", "parameters": [ { - "name": "role", - "in": "query", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write", - "powerUser", - "grant", - "admin" - ], "type": "string" } } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDatabasesInfo" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "databases": [ - { - "key": "MI_Training", - "status": "Ok", - "isReadOnly": false, - "isLocked": false, - "name": "MI Training", - "guid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "versionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "indexInSync": true, - "schemaVersion": "2022.08.18.01" - } - ] + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" } - } - } - } - } - }, - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Adds a database to the MI server. Only available to users in the System Administrator role.", - "operationId": "AddDatabase", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSlimDatabase" + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" } } } }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." + "404": { + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}": { + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}": { "get": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Returns details for a given database.", - "operationId": "GetDatabase", + "summary": "Get Home Page Folder", + "operationId": "GetHomePageFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "fe2bfa38-3154-4196-b540-fd79b018ca3c" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabase" + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "fe2bfa38-3154-4196-b540-fd79b018ca3c" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "fe2bfa38-3154-4196-b540-fd79b018ca3c" } } } }, "404": { - "description": "Database not found" + "description": "Database or folder not found" } } }, - "delete": { + "patch": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Removes the database from the MI server. Only available to users in the System Administrator role.", - "operationId": "RemoveDatabase", + "summary": "Update an existing Home Page Folder.", + "operationId": "UpdateHomePageFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK." - }, - "400": { - "description": "Bad request. Returned if database is in the \"Unloading\" state" }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found." - } - } - }, - "patch": { - "tags": [ - "Schema - Databases" - ], - "summary": "Update database details.", - "operationId": "UpdateDatabase", - "parameters": [ { - "name": "database-key", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "allow-reload", - "in": "query", - "description": "This must be set to true if any of the following properties are patched:\r\n DatabaseKey, DataSource, UseIntegratedSecurity, SqlUserName, SqlPassword, InitialCatalog, Language, Guid.\r\n The database will reload after the changes have been applied.", - "schema": { - "type": "boolean", - "default": false + "format": "uuid" } } ], @@ -47724,172 +38995,84 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "cd8744fe-ee31-4b10-90e2-b94781aefd6c", - "guid": "99bd2481-0b66-4a0d-b0ab-aa2d965b06eb", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } + "name": "New Folder Name" } }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", + "Example 2": { + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "isImplicitProfileDisabled": true + "guid": "2c45e2a6-1f41-4635-913d-09735686e64a" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "cd8744fe-ee31-4b10-90e2-b94781aefd6c", - "guid": "99bd2481-0b66-4a0d-b0ab-aa2d965b06eb", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } + "name": "New Folder Name" } }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", + "Example 2": { + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "isImplicitProfileDisabled": true + "guid": "2c45e2a6-1f41-4635-913d-09735686e64a" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "cd8744fe-ee31-4b10-90e2-b94781aefd6c", - "guid": "99bd2481-0b66-4a0d-b0ab-aa2d965b06eb", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } + "name": "New Folder Name" } }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", + "Example 2": { + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "isImplicitProfileDisabled": true + "guid": "2c45e2a6-1f41-4635-913d-09735686e64a" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "cd8744fe-ee31-4b10-90e2-b94781aefd6c", - "guid": "99bd2481-0b66-4a0d-b0ab-aa2d965b06eb", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } + "name": "New Folder Name" } }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", + "Example 2": { + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "isImplicitProfileDisabled": true + "guid": "2c45e2a6-1f41-4635-913d-09735686e64a" } } } @@ -47898,835 +39081,1103 @@ }, "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabase" + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "400": { - "description": "Bad request." + "description": "Bad request" }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database not found." + "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/all-table-types": { - "get": { + }, + "delete": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Get all table types for a given database.", - "operationId": "GetAllTableTypes", + "summary": "Delete a Home Page Folder.", + "operationId": "DeleteHomePageFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTableTypesInfo" - } - } - } + "description": "Ok" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database key not found" + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/default": { + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:child-folders": { "get": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Returns details for a default database or null if the default database is not set or user cannot see it.", - "operationId": "GetDefaultDatabase", - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabase" - } - } + "summary": "Get Child Home Page Folders", + "operationId": "GetHomePageChildFolders", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "204": { - "description": "No default database set." - } - } - }, - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Sets the default database.", - "operationId": "UpdateDefaultDatabase", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDatabase" + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "0c7db40b-6656-45a1-a4c1-0ba1d173253f" + } + ] } - } - } - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found." - } - } - } - }, - "/v1alpha/databases/defaultDataSource": { - "get": { - "tags": [ - "Schema - Databases" - ], - "summary": "Returns data source used by the configuration database.", - "operationId": "GetDefaultDataSource", - "responses": { - "200": { - "description": "OK.", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDataSource" + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "0c7db40b-6656-45a1-a4c1-0ba1d173253f" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "0c7db40b-6656-45a1-a4c1-0ba1d173253f" + } + ] } } } }, - "403": { - "description": "Forbidden." + "404": { + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/defaultAdditionalSqlParameters": { - "get": { + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:move": { + "post": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Returns additional SQL parameters used by the configuration database.", - "operationId": "GetDefaultAdditionalSqlParameters", - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAdditionalSqlParameters" - } - } + "summary": "Move an existing Home Page Folder.", + "operationId": "MoveHomePageFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "403": { - "description": "Forbidden." + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } - } - } - }, - "/v1alpha/databases:validate": { - "post": { - "tags": [ - "Schema - Databases" ], - "summary": "Validates whether a database can be added to MI server. Only available to users in the System Administrator role.", - "operationId": "ValidateDatabaseToAdd", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } } } }, "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseValidationResult" + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "400": { - "description": "Bad request." + "description": "Bad request" }, "403": { - "description": "Forbidden." + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}:upgrade": { - "post": { + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files": { + "get": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Upgrade a database to the latest schema version. Only available to users in the System Administrator role.", - "operationId": "UpgradeDatabase", + "summary": "Get the Home Page Files in a Folder", + "operationId": "GetHomePageFiles", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { - "400": { - "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\" or \"Unknown\" state", + "200": { + "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaUpgradeDatabaseException" + "$ref": "#/components/schemas/GsaFilesInfo" }, - "examples": { - "Example 1": { - "summary": "Insufficient permissions for 'MI_TRAINING' database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade 'MI_TRAINING' database to a new schema version by a user that does not have sufficient database permissions.", - "value": { - "message": "Failed to upgrade database 'MI_TRAINING' - the connecting user must be a db_owner on the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "insufficientPermissions", - "statusCode": 400 - } - }, - "Example 2": { - "summary": "Unable to connect to 'MI_TRAINING' database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade 'MI_TRAINING' database to a new schema version, but user was unable to connect to the database.", - "value": { - "message": "Failed to upgrade database 'Unable to connect to the 'MI_TRAINING' database using provided credentials.' - could not connect to the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "unableToConnect", - "additionalInformation": "MI_TRAINING", - "statusCode": 400 + "example": { + "files": [ + { + "name": "home-page-1.html", + "guid": "ce9a6e97-f5eb-4390-87be-6f5458c28778" + }, + { + "name": "home-page-2.html", + "guid": "1e273141-12e9-417d-baa0-df41ac11212d" } - } + ] } - } - } - }, - "200": { - "description": "OK.", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSlimDatabase" + "$ref": "#/components/schemas/GsaFilesInfo" + }, + "example": { + "files": [ + { + "name": "home-page-1.html", + "guid": "ce9a6e97-f5eb-4390-87be-6f5458c28778" + }, + { + "name": "home-page-2.html", + "guid": "1e273141-12e9-417d-baa0-df41ac11212d" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" + }, + "example": { + "files": [ + { + "name": "home-page-1.html", + "guid": "ce9a6e97-f5eb-4390-87be-6f5458c28778" + }, + { + "name": "home-page-2.html", + "guid": "1e273141-12e9-417d-baa0-df41ac11212d" + } + ] } } } }, - "403": { - "description": "Forbidden." - }, "404": { - "description": "Database not found." + "description": "Database or folder not found" } } - } - }, - "/v1alpha/databases:upgrade-external": { + }, "post": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Upgrades an external database to the latest schema version. Only available to users in the System Administrator role.", - "operationId": "UpgradeDatabaseNotAddedToMi", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" + "summary": "Create a new Home Page File.", + "operationId": "CreateHomePageFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + }, + "description": { + "type": "string" + } + } + }, + "encoding": { + "file": { + "style": "form" + }, + "description": { + "style": "form" + } } } } }, "responses": { - "400": { - "description": "Bad request. Returned if connecting user is not a db_owner on the database.", + "201": { + "description": "Created", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "22ff6f81-e22b-4b95-ae0e-53dfd1150062" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpgradeDatabaseException" + "$ref": "#/components/schemas/GsaFileHeader" }, - "examples": { - "Example 1": { - "summary": "Insufficient permissions for a database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade a database to a new schema version by a user that does not have sufficient database permissions.", - "value": { - "message": "Failed to upgrade database - the connecting user must be a db_owner on the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "insufficientPermissions", - "statusCode": 400 - } - }, - "Example 2": { - "summary": "Unable to connect to a database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade a database to a new schema version, but user was unable to connect to the database.", - "value": { - "message": "Failed to upgrade database - could not connect to the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "unableToConnect", - "additionalInformation": "Unable to connect to the database using provided credentials.", - "statusCode": 400 - } - } + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "22ff6f81-e22b-4b95-ae0e-53dfd1150062" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "22ff6f81-e22b-4b95-ae0e-53dfd1150062" } } } }, - "200": { - "description": "OK." + "400": { + "description": "Bad request" }, "403": { - "description": "Forbidden." + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}:reload": { - "post": { + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}": { + "get": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Reloads a database. Only available to users in the System Administrator role.", - "operationId": "ReloadDatabase", + "summary": "Get the header information for a Home Page File", + "operationId": "GetHomePageFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "description": "Description of home page file.", + "extension": "html", + "dataLength": 12895, + "path": "HomePages", + "name": "home-page.html", + "guid": "7fa8b68a-510f-42d1-a563-84c04955ebfc" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSlimDatabase" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "description": "Description of home page file.", + "extension": "html", + "dataLength": 12895, + "path": "HomePages", + "name": "home-page.html", + "guid": "7fa8b68a-510f-42d1-a563-84c04955ebfc" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "description": "Description of home page file.", + "extension": "html", + "dataLength": 12895, + "path": "HomePages", + "name": "home-page.html", + "guid": "7fa8b68a-510f-42d1-a563-84c04955ebfc" } } } }, - "400": { - "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\", \"SchemaUpgradeRequired\" or \"SchemaDowngradeRequired\" state" - }, - "403": { - "description": "Forbidden." - }, "404": { - "description": "Database not found." + "description": "Database, folder or file not found" } } - } - }, - "/v1alpha/databases/{database-key}:lock": { - "post": { + }, + "patch": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Lock database", - "operationId": "LockDatabase", + "summary": "Update an existing Home Page File.", + "operationId": "UpdateHomePageFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database to lock", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFile" + }, + "examples": { + "Example 1": { + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", + "value": { + "name": "New File Name" + } + }, + "Example 2": { + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", + "value": { + "description": "New description for home page file." + } + }, + "Example 3": { + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", + "value": { + "guid": "4c5b387e-8bdf-4382-9533-95db95443178" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFile" + }, + "examples": { + "Example 1": { + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", + "value": { + "name": "New File Name" + } + }, + "Example 2": { + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", + "value": { + "description": "New description for home page file." + } + }, + "Example 3": { + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", + "value": { + "guid": "4c5b387e-8bdf-4382-9533-95db95443178" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFile" + }, + "examples": { + "Example 1": { + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", + "value": { + "name": "New File Name" + } + }, + "Example 2": { + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", + "value": { + "description": "New description for home page file." + } + }, + "Example 3": { + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", + "value": { + "guid": "4c5b387e-8bdf-4382-9533-95db95443178" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFile" + }, + "examples": { + "Example 1": { + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", + "value": { + "name": "New File Name" + } + }, + "Example 2": { + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", + "value": { + "description": "New description for home page file." + } + }, + "Example 3": { + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", + "value": { + "guid": "4c5b387e-8bdf-4382-9533-95db95443178" + } + } + } + } + } + }, "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "6425df76-3523-4778-920d-ef5a763b6c23" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabase" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "6425df76-3523-4778-920d-ef5a763b6c23" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "6425df76-3523-4778-920d-ef5a763b6c23" } } } }, "400": { - "description": "Bad request." + "description": "Bad request" }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database not found." + "description": "Database, folder or file not found" } } - } - }, - "/v1alpha/databases/{database-key}:unlock": { - "post": { + }, + "delete": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Unlock database", - "operationId": "UnlockDatabase", + "summary": "Delete a Home Page File.", + "operationId": "DeleteHomePageFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database to unlock", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabase" - } - } - } - }, - "400": { - "description": "Bad request." + "description": "Ok" }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database not found." + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}:outbound-links": { - "post": { + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:export": { + "get": { "tags": [ - "Schema - Databases" + "Schema - Home Pages" ], - "summary": "Get all link groups and tabular attributes pointing from the database, i.e. the source of the link is in the given database.\r\nMay include links where the target is in the same database, or where the target cannot be resolved (e.g. the target database is not loaded).", - "operationId": "GetOutboundLinks", + "summary": "Get Home Page File as a file", + "operationId": "ExportHomePageFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "type", - "in": "query", - "description": "The link types to include in the response. If not provided, all link types are included.", + "name": "file-guid", + "in": "path", + "required": true, "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - } + "type": "string", + "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, + "404": { + "description": "Database, folder or file not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:move": { + "post": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Move an existing Home Page File.", + "operationId": "MoveHomePageFile", + "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "folder-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLinksInfo" - }, - "example": { - "links": [ - { - "type": "recordLink", - "includeIndirectLinks": false, - "reverseName": "Training Exercise", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "displayNames": {}, - "name": "MaterialUniverse", - "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - }, - { - "type": "smartLink", - "forbidOrphans": false, - "referentialIntegrityModel": "manyToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "9bd8599e-36e0-4008-b52e-2f70b90c00a0" - }, - "attributeTarget": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "000001cb-0001-4fff-8fff-dd92ffff0000" - } - } - ], - "reverseName": "Smart Link to Training Record", - "reverseDisplayNames": { - "en": "en-Smart Link to Training Record", - "fr": "fr-Smart Link to Training Record" - }, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "displayNames": { - "en": "en-Smart Link to MaterialUniverse", - "fr": "fr-Smart Link to MaterialUniverse" - }, - "name": "Smart Link to MaterialUniverse", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - { - "type": "crossDatabaseLink", - "includeIndirectLinks": false, - "reverseName": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "linkTarget": { - "databaseGuid": "cecc62cd-8778-48cc-9588-f894788f8113", - "tableGuid": "ad023fe5-aaee-47da-a28c-248c3c16428c" - } - }, - "displayNames": {}, - "name": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", - "guid": "ca62b35a-03cd-4eae-b34c-a803e1ef07a8" - }, - { - "type": "tabularAttribute", - "targetAttribute": { - "guid": "00000099-0001-4fff-8fff-dd92ffff0000" - }, - "reverseName": "Environmental performances overview", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "displayNames": {}, - "name": "Environmental performances overview", - "guid": "2523a67a-6246-4c9e-8583-15b64d6290e5" - } - ] - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases:check-retarget-potential": { - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Check databases for retarget potential - whether there are any cross-database tabular attributes targeting them.", - "operationId": "CheckDatabasesForRetargetPotential", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "value": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "value": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "value": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "value": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } } } } }, "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDatabasesInfo" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "databases": [ - { - "key": "MI_Training", - "status": "Ok", - "isReadOnly": false, - "isLocked": false, - "name": "MI Training", - "guid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "versionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "indexInSync": true, - "schemaVersion": "2022.08.18.01" - } - ] + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "e8692dac-9834-4ac8-adb3-7fc556627a7e" } - } - } - }, - "400": { - "description": "Bad request." - } - } - } - }, - "/v1alpha/databases:retarget": { - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Retargets tabulars from the current database to a new one.", - "operationId": "RetargetTabulars", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRetargetResultsInfo" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "e8692dac-9834-4ac8-adb3-7fc556627a7e" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "e8692dac-9834-4ac8-adb3-7fc556627a7e" } } } }, "400": { - "description": "Bad request." + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database not found." + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/permission-category-access-controls": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections": { "get": { "tags": [ - "Schema - Databases" + "Schema - Layout Sections" ], - "summary": "Get permission-based access control settings for the database.\r\nReturns the access control for each permission in each category.", - "operationId": "GetDatabasePermissionCategoryAccessControls", + "summary": "Get all sections for a layout", + "operationId": "GetLayoutSections", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + }, + { + "name": "showFullDetail", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -48736,92 +40187,155 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaLayoutSectionsInfo" }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, + "examples": { + "Example 1": { + "summary": "Get 'slim' layout sections", + "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to false, which is the default value.", + "value": { + "layoutSections": [ { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "sectionDetailType": "slim", + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" }, - "canRead": true, - "canWrite": true + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" }, { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" + "sectionDetailType": "slim", + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" }, - "canRead": false, - "canWrite": false + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" } ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ + } + }, + "Example 2": { + "summary": "Get 'full' layout sections", + "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to true.", + "value": { + "layoutSections": [ { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "9a61ab0f-1336-488d-bf9d-1a1ff63e0dc9", + "name": "Price", + "guid": "01e7d124-efbf-4255-bfef-2bc4b52e5d02" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "14eed0a0-358c-4db0-ae2e-83a71838aa93", + "name": "Density", + "guid": "f8478dd3-8ced-4c1f-abd4-de707c3e0c54" + } + ], + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" }, - "canRead": true, - "canWrite": false + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" }, { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "floatFunctional", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "26a33e2a-603f-4e40-adb5-3fd75352f0ea", + "name": "Young's modulus", + "guid": "0a83713c-91f1-44d1-8c52-3a753e4094f0" + }, + { + "itemType": "attribute", + "attributeType": "range", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "93d98563-a6de-40d6-9796-cbbf0d489ef7", + "name": "Tensile strength", + "guid": "b364c961-8b56-4a62-a762-78c11187c938" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "c48e2034-0c87-4dfd-9905-611a290c9c91", + "name": "Shape factor", + "guid": "d742d901-aa95-49f5-b42a-6be4fbc0f73c" + } + ], + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" }, - "canRead": true, - "canWrite": true + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" } ] } - ] + } } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database, table or layout not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Databases" + "Schema - Layout Sections" ], - "summary": "Update permission-based access control settings for the database.\r\nSets the access control for the given permissions.", - "description": "\r\n\r\nCan also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation)", - "operationId": "UpdateDatabasePermissionCategoryAccessControls", + "summary": "Create a new layout section.", + "operationId": "CreateSection", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -48829,340 +40343,88 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateLayoutSection" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties (Guid)", + "guid": "78fc6fa8-6c74-4a56-a241-2fe78e45917c" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateLayoutSection" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties (Guid)", + "guid": "78fc6fa8-6c74-4a56-a241-2fe78e45917c" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateLayoutSection" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties (Guid)", + "guid": "78fc6fa8-6c74-4a56-a241-2fe78e45917c" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateLayoutSection" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "Additional Properties (Guid)", + "guid": "78fc6fa8-6c74-4a56-a241-2fe78e45917c" } } } @@ -49170,265 +40432,64 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaSlimLayoutSection" }, "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "sectionDetailType": "slim", + "displayNames": {}, + "name": "Additional Properties", + "guid": "224b1ba6-9ce3-45aa-85e3-3cc6d2482134" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 13": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '8def928c-e5cd-48ba-9df5-47c5597fa229', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID '8def928c-e5cd-48ba-9df5-47c5597fa229' does not exist.", - "reason": "noSuchCategory", - "categoryGuid": "8def928c-e5cd-48ba-9df5-47c5597fa229" - } - ] - } - }, - "Example 14": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID 'f08353f3-e986-4565-b1be-4405f309eb22' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID 'f08353f3-e986-4565-b1be-4405f309eb22' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "reason": "noSuchPermission", - "permissionGuid": "f08353f3-e986-4565-b1be-4405f309eb22", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - ] - } - }, - "Example 15": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "reason": "duplicateCategoryGuids", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ] - } - ] - } - }, - "Example 16": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "reason": "duplicatePermissionGuids", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ] - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database, table or layout not found" } } - } - }, - "/v1alpha/databases/{database-key}:resetVersionGuid": { - "post": { + }, + "put": { "tags": [ - "Schema - Databases" + "Schema - Layout Sections" ], - "summary": "Reset the database version guid. A version guid can optionally be specified, if not then a random guid is generated.", - "operationId": "ResetVersionGuid", + "summary": "Reorder the list of layout sections for a layout.", + "operationId": "ReorderSections", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "versionGuid", - "in": "query", - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimDatabase" - } - } + "type": "string" } }, - "400": { - "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\" or \"Unknown\" state" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found." - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types": { - "get": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Gets all discrete types for a given database.", - "operationId": "GetDiscreteTypes", - "parameters": [ { - "name": "database-key", + "name": "table-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypesInfo" - } - } + "format": "uuid" } }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Create a new discrete type.", - "operationId": "CreateDiscreteType", - "parameters": [ { - "name": "database-key", + "name": "layout-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -49436,577 +40497,286 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" + "$ref": "#/components/schemas/GsaReorderSectionsInfo" }, "examples": { "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", - "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" - } - }, - "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", - "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" - } - }, - "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isOrdered": false, - "discreteValues": [ + "layoutSections": [ + { + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, { - "name": "Value A" + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" }, { - "name": "Value B" + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" }, { - "name": "Value C" + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" } - ], - "name": "Discrete Type Name" + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" + "$ref": "#/components/schemas/GsaReorderSectionsInfo" }, "examples": { "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", - "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" - } - }, - "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", - "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" - } - }, - "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isOrdered": false, - "discreteValues": [ + "layoutSections": [ + { + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, { - "name": "Value A" + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" }, { - "name": "Value B" + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" }, { - "name": "Value C" + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" + }, + { + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" } - ], - "name": "Discrete Type Name" + ] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" + "$ref": "#/components/schemas/GsaReorderSectionsInfo" }, "examples": { "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", - "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" - } - }, - "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", - "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" - } - }, - "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isOrdered": false, - "discreteValues": [ + "layoutSections": [ + { + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, { - "name": "Value A" + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" }, { - "name": "Value B" + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" }, { - "name": "Value C" + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" } - ], - "name": "Discrete Type Name" + ] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" + "$ref": "#/components/schemas/GsaReorderSectionsInfo" }, "examples": { "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", - "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" - } - }, - "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", - "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" - } - }, - "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isOrdered": false, - "discreteValues": [ + "layoutSections": [ { - "name": "Value A" + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" }, { - "name": "Value B" + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" }, { - "name": "Value C" - } - ], - "name": "Discrete Type Name" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteType" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypeCreationException" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}": { - "get": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Gets a single discrete type.", - "operationId": "GetDiscreteType", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteType" - } - } - } - }, - "404": { - "description": "Database or discrete type not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Update discrete type.", - "operationId": "UpdateDiscreteType", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - }, - "examples": { - "Example 1": { - "summary": "Everything for a Discrete Type", - "description": "This example shows how to update all properties of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": false, - "discreteValues": [ - { - "type": "create", - "name": "New Value" - }, - { - "type": "create", - "name": "New Value with specific GUID", - "guid": "176840c4-08b3-407e-aae8-57265d84f1a3" - }, - { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" - }, - { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ], - "name": "Updated Name", - "guid": "c9d2ae5f-df5a-4d62-99c4-f1b4c5d01459" - } - }, - "Example 2": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Updated Name" - } - }, - "Example 3": { - "summary": "Update IsOrdered", - "description": "This example demonstrates how to update the 'IsOrdered' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": true - } - }, - "Example 4": { - "summary": "Update Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" - }, - { - "type": "create", - "name": "New Value with specific GUID", - "guid": "e76dd27e-f451-4410-8dae-88f566a1a822" - }, - { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" - }, - { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - }, - "examples": { - "Example 1": { - "summary": "Everything for a Discrete Type", - "description": "This example shows how to update all properties of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": false, - "discreteValues": [ - { - "type": "create", - "name": "New Value" - }, - { - "type": "create", - "name": "New Value with specific GUID", - "guid": "176840c4-08b3-407e-aae8-57265d84f1a3" - }, - { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" + "guid": "07124fac-3100-444f-ad5b-385decd9539f" }, { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ], - "name": "Updated Name", - "guid": "c9d2ae5f-df5a-4d62-99c4-f1b4c5d01459" - } - }, - "Example 2": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Updated Name" - } - }, - "Example 3": { - "summary": "Update IsOrdered", - "description": "This example demonstrates how to update the 'IsOrdered' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": true - } - }, - "Example 4": { - "summary": "Update Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" }, { - "type": "create", - "name": "New Value with specific GUID", - "guid": "e76dd27e-f451-4410-8dae-88f566a1a822" + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" }, { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" }, { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - }, - "examples": { - "Example 1": { - "summary": "Everything for a Discrete Type", - "description": "This example shows how to update all properties of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": false, - "discreteValues": [ - { - "type": "create", - "name": "New Value" + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" }, { - "type": "create", - "name": "New Value with specific GUID", - "guid": "176840c4-08b3-407e-aae8-57265d84f1a3" + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" }, { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" }, { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ], - "name": "Updated Name", - "guid": "c9d2ae5f-df5a-4d62-99c4-f1b4c5d01459" - } - }, - "Example 2": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Updated Name" - } - }, - "Example 3": { - "summary": "Update IsOrdered", - "description": "This example demonstrates how to update the 'IsOrdered' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": true - } - }, - "Example 4": { - "summary": "Update Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" }, { - "type": "create", - "name": "New Value with specific GUID", - "guid": "e76dd27e-f451-4410-8dae-88f566a1a822" + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" }, { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" }, { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - }, - "examples": { - "Example 1": { - "summary": "Everything for a Discrete Type", - "description": "This example shows how to update all properties of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": false, - "discreteValues": [ - { - "type": "create", - "name": "New Value" + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" }, { - "type": "create", - "name": "New Value with specific GUID", - "guid": "176840c4-08b3-407e-aae8-57265d84f1a3" + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" }, { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" }, { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ], - "name": "Updated Name", - "guid": "c9d2ae5f-df5a-4d62-99c4-f1b4c5d01459" - } - }, - "Example 2": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Updated Name" - } - }, - "Example 3": { - "summary": "Update IsOrdered", - "description": "This example demonstrates how to update the 'IsOrdered' property of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isOrdered": true - } - }, - "Example 4": { - "summary": "Update Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values of the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" }, { - "type": "create", - "name": "New Value with specific GUID", - "guid": "e76dd27e-f451-4410-8dae-88f566a1a822" + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" }, { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" }, { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" } ] } @@ -50017,130 +40787,247 @@ }, "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteType" + "$ref": "#/components/schemas/GsaLayoutSectionsInfo" + }, + "example": { + "layoutSections": [ + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" + }, + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Electrical Properties English Display Name", + "fr": "Electrical Properties French Display Name" + }, + "name": "Electrical Properties", + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Composition Overview English Display Name", + "fr": "Composition Overview French Display Name" + }, + "name": "Composition Overview", + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Composition detail (metals, ceramics and glasses) English Display Name", + "fr": "Composition detail (metals, ceramics and glasses) French Display Name" + }, + "name": "Composition detail (metals, ceramics and glasses)", + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Restricted substances English Display Name", + "fr": "Restricted substances French Display Name" + }, + "name": "Restricted substances", + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Further Information English Display Name", + "fr": "Further Information French Display Name" + }, + "name": "Further Information", + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Restricted substances English Display Name", + "fr": "Restricted substances French Display Name" + }, + "name": "Restricted substances", + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Notes English Display Name", + "fr": "Notes French Display Name" + }, + "name": "Notes", + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Material recycling: energy, CO2 and recycle fraction English Display Name", + "fr": "Material recycling: energy, CO2 and recycle fraction French Display Name" + }, + "name": "Material recycling: energy, CO2 and recycle fraction", + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Material processing: CO2 footprint English Display Name", + "fr": "Material processing: CO2 footprint French Display Name" + }, + "name": "Material processing: CO2 footprint", + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Material processing: energy English Display Name", + "fr": "Material processing: energy French Display Name" + }, + "name": "Material processing: energy", + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Eco-indicators for principal component English Display Name", + "fr": "Eco-indicators for principal component French Display Name" + }, + "name": "Eco-indicators for principal component", + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Primary material production: energy, CO2 and water English Display Name", + "fr": "Primary material production: energy, CO2 and water French Display Name" + }, + "name": "Primary material production: energy, CO2 and water", + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Geo-economic data for principal component English Display Name", + "fr": "Geo-economic data for principal component French Display Name" + }, + "name": "Geo-economic data for principal component", + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Durability: fluids and sunlight English Display Name", + "fr": "Durability: fluids and sunlight French Display Name" + }, + "name": "Durability: fluids and sunlight", + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Durability: flammability English Display Name", + "fr": "Durability: flammability French Display Name" + }, + "name": "Durability: flammability", + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Optical properties English Display Name", + "fr": "Optical properties French Display Name" + }, + "name": "Optical properties", + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Thermal properties English Display Name", + "fr": "Thermal properties French Display Name" + }, + "name": "Thermal properties", + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Bio-data English Display Name", + "fr": "Bio-data French Display Name" + }, + "name": "Bio-data", + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" + } + ] } } } }, "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypeUpdateException" - } - } - } + "description": "Bad request" }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database or discrete type not found." + "description": "Database, table, layout or layout section not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}": { + "get": { "tags": [ - "Schema - Discrete Types" + "Schema - Layout Sections" ], - "summary": "Delete discrete type, including all of its discrete values.", - "operationId": "DeleteDiscreteType", + "summary": "Get a layout section with a specified guid for a given layout.", + "operationId": "GetLayoutSection", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "discrete-type-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "400": { - "description": "Bad request. Discrete type in use by Attributes.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypeDeletionException" - }, - "example": { - "message": "Cannot delete Discrete Type with GUID '00000083-0006-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "entityType": "discreteType", - "entityGuid": "00000083-0006-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more attributes.", - "reason": "usage", - "referencedByType": "attribute", - "referencedBy": [ - { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - ] - } - ] - } - } - } - }, - "200": { - "description": "OK." - }, - "403": { - "description": "Forbidden." }, - "404": { - "description": "Database or discrete type not found." - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}:usages": { - "get": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Gets objects that are using this discrete type.", - "operationId": "GetAttributesForType", - "parameters": [ { - "name": "database-key", + "name": "layout-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "discrete-type-guid", + "name": "section-guid", "in": "path", "required": true, "schema": { @@ -50149,88 +41036,279 @@ } }, { - "name": "response-filters", + "name": "showFullDetail", "in": "query", - "description": "The discrete type usage types to include in the response. If none are provided, all types are included.", "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteTypeUsageType" - } + "type": "boolean" } - } - ], - "responses": { + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypeUsage" + "$ref": "#/components/schemas/GsaLayoutSection" }, - "example": { - "attributes": [ - { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" + "examples": { + "Example 1": { + "summary": "Get 'slim' layout section", + "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to false, which is the default value.", + "value": { + "detailType": "slim", + "displayNames": { + "de": "Testing Information German Display Name", + "fr": "Testing Information French Display Name" }, - "name": "Reinforcement architecture", - "guid": "b172b9b3-228c-4784-9eaa-66349442f930" + "name": "Testing Information", + "guid": "60b23725-6ca7-415d-98b1-f5d87380f14d" } - ], - "tabularColumns": [ - { - "tabularAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "Example 2": { + "summary": "Get 'full' layout section", + "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to true.", + "value": { + "detailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "shortText", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "5a933ae7-0e2d-4372-b63a-eaeed4f81969", + "name": "Form", + "guid": "0c6959c4-3317-48e2-91ef-4fd7a8de8261" }, - "name": "Lay-up sequence details", - "guid": "af6fc0e6-dfbb-4f51-aad3-79419cd5ee92" - }, - "columns": [ { - "name": "Ply/layer architecture", - "guid": "d0f981f1-9934-4518-af7e-f2a67573f0b0" + "itemType": "attribute", + "attributeType": "point", + "required": true, + "readOnly": false, + "metaAttributes": [ + { + "itemType": "attribute", + "attributeType": "longText", + "required": true, + "readOnly": false, + "underlyingEntityGuid": "1dc211fc-d7cf-4a52-a852-5f695e6b9391", + "name": "Sources", + "guid": "e65a3e22-1023-4d44-b64c-321298c4e310" + }, + { + "itemType": "attribute", + "attributeType": "shortText", + "required": true, + "readOnly": false, + "underlyingEntityGuid": "14177f29-2e10-4d83-b717-6def2931d433", + "name": "Notes", + "guid": "246db1a2-6451-45bb-bb01-6bd31ada5d9e" + } + ], + "underlyingEntityGuid": "545b4e5f-58bb-41fd-8e34-926f2b2983aa", + "name": "Chemical resistance", + "guid": "7ea0fdf5-6b56-4e31-b9a6-3d0d08e79554" + }, + { + "itemType": "link", + "linkType": "recordLink", + "targetDatabase": "3be72bae-16aa-4eca-bbf0-0f045ac0c68b", + "targetDatabaseVersion": "f483b8f4-9a2f-40e9-a1f9-d36c71bf7ad9", + "targetTable": "ac859714-6d62-4068-aabc-e48f746dbb39", + "forwards": true, + "underlyingEntityGuid": "a4b2076c-40eb-499a-bafd-3567cf9e839c", + "name": "Material Pedigree", + "guid": "ddd086e9-16ba-44b0-a617-0eaad5cf788d" + }, + { + "itemType": "attribute", + "attributeType": "link", + "required": false, + "readOnly": false, + "metaAttributes": [], + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "tabularColumnGuid": "0f6406ee-2b6e-44ee-b20f-2ffa37b84abf", + "name": "Offset Yield Stress", + "guid": "5834d027-724b-4393-b9b3-eb8325579602" + }, + { + "columnType": "localShortText", + "tabularColumnGuid": "ba3c8434-8b09-4ac9-9862-6f68440b8087", + "name": "Young's Modulus Notes", + "guid": "203bf0d7-9a6e-4232-91a8-72b00eb166b4" + } + ], + "underlyingEntityGuid": "91e0c991-f917-46b0-8bcd-661f48612a43", + "name": "Reference Characteristics", + "guid": "9b11ae7f-bbed-4765-93be-6f530941be9b" + }, + { + "itemType": "link", + "linkType": "associationChain", + "targetDatabase": "3be72bae-16aa-4eca-bbf0-0f045ac0c68b", + "targetDatabaseVersion": "f483b8f4-9a2f-40e9-a1f9-d36c71bf7ad9", + "targetTable": "d353f5cb-fcf9-4054-8402-00b3ecaa12a5", + "forwards": true, + "nextLink": { + "itemType": "link", + "linkType": "associationChain", + "targetDatabase": "3be72bae-16aa-4eca-bbf0-0f045ac0c68b", + "targetDatabaseVersion": "f483b8f4-9a2f-40e9-a1f9-d36c71bf7ad9", + "targetTable": "eb1b6ae0-d7cc-4448-b6a1-2985a319b501", + "forwards": false, + "underlyingEntityGuid": "4de094a7-391d-43ad-82da-c0cdff4d3dce", + "name": "Pedigree information", + "guid": "3dedb242-0900-48d7-a9a4-ebccaaeb3be5" + }, + "underlyingEntityGuid": "5eefec57-5193-4068-bdf8-4ef23a495844", + "name": "To Pedigree from Producers", + "guid": "1478a445-e2bd-4b73-8783-5aac10439d17" } - ] + ], + "displayNames": { + "de": "Testing Information German Display Name", + "fr": "Testing Information French Display Name" + }, + "name": "Testing Information", + "guid": "25325b02-e20f-406a-8b2c-9a71e4bedf29" } - ] + } } } } }, + "404": { + "description": "Database, table, layout or layout section not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Layout Sections" + ], + "summary": "Delete a layout section.", + "operationId": "DeleteSection", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "section-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, "400": { "description": "Bad request" }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or discrete type not found" + "description": "Database, table, layout or layout section not found" } } } }, - "/v1alpha/databases/{database-key}/discrete-types:query": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items": { "post": { "tags": [ - "Schema - Discrete Types" + "Schema - Layout Sections" ], - "summary": "Gets discrete types for a given database, populates the requested properties.", - "operationId": "QueryDiscreteTypes", + "summary": "Add a new layout item.", + "operationId": "CreateLayoutItem", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + }, + { + "name": "section-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], @@ -50238,252 +41316,400 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Fetch all discrete types with custom properties", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Surface Finish" - ] - } + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false + } + ] } }, "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ] + } + }, + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + } + }, + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "7d9ec4c9-6bf1-4609-a3b6-ae2732b24748", + "sourceTableGuid": "be435532-18bb-45e8-88cc-dfd86c1acb05", + "linkGroupGuid": "8775468c-def0-44a5-8d29-000746f3443f" + } + }, + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "029721ff-e57b-4bcb-907b-e1f2c0a4c425", + "tabularAttributeGuid": "911153ec-fecf-482a-b5fb-96b4f277f815" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "22189dfb-fabb-4448-94a1-993ec0afa5a2", + "tabularAttributeGuid": "84a0dc06-d0ca-4f4a-9a78-de7642f5c111" + } + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Fetch all discrete types with custom properties", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Surface Finish" - ] - } + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false + } + ] } }, "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ] + } + }, + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + } + }, + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "7d9ec4c9-6bf1-4609-a3b6-ae2732b24748", + "sourceTableGuid": "be435532-18bb-45e8-88cc-dfd86c1acb05", + "linkGroupGuid": "8775468c-def0-44a5-8d29-000746f3443f" + } + }, + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "029721ff-e57b-4bcb-907b-e1f2c0a4c425", + "tabularAttributeGuid": "911153ec-fecf-482a-b5fb-96b4f277f815" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "22189dfb-fabb-4448-94a1-993ec0afa5a2", + "tabularAttributeGuid": "84a0dc06-d0ca-4f4a-9a78-de7642f5c111" + } + ] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Fetch all discrete types with custom properties", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Surface Finish" - ] - } + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false + } + ] } }, "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ] + } + }, + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + } + }, + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "7d9ec4c9-6bf1-4609-a3b6-ae2732b24748", + "sourceTableGuid": "be435532-18bb-45e8-88cc-dfd86c1acb05", + "linkGroupGuid": "8775468c-def0-44a5-8d29-000746f3443f" + } + }, + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "029721ff-e57b-4bcb-907b-e1f2c0a4c425", + "tabularAttributeGuid": "911153ec-fecf-482a-b5fb-96b4f277f815" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "22189dfb-fabb-4448-94a1-993ec0afa5a2", + "tabularAttributeGuid": "84a0dc06-d0ca-4f4a-9a78-de7642f5c111" + } + ] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Fetch all discrete types with custom properties", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Surface Finish" - ] - } + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false + } + ] } }, "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ] + } + }, + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + } + }, + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "7d9ec4c9-6bf1-4609-a3b6-ae2732b24748", + "sourceTableGuid": "be435532-18bb-45e8-88cc-dfd86c1acb05", + "linkGroupGuid": "8775468c-def0-44a5-8d29-000746f3443f" + } + }, + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "029721ff-e57b-4bcb-907b-e1f2c0a4c425", + "tabularAttributeGuid": "911153ec-fecf-482a-b5fb-96b4f277f815" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "22189dfb-fabb-4448-94a1-993ec0afa5a2", + "tabularAttributeGuid": "84a0dc06-d0ca-4f4a-9a78-de7642f5c111" + } + ] } } } @@ -50491,12 +41717,115 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesInfo" + "$ref": "#/components/schemas/GsaNewLayoutItem" + }, + "examples": { + "Example 1": { + "summary": "Layout Attribute Item", + "description": "This example demonstrates the response to creating a new attribute layout item. It was created by adding the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": false, + "metaAttributes": null, + "tabularColumnGuids": null, + "guid": "a0c5c9b6-d2c0-4391-9369-797a99d4295b" + } + }, + "Example 2": { + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates the response to creating a new attribute layout item with a meta-attribute. It was created by adding the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "required": false, + "readOnly": false, + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": true, + "readOnly": false + } + ], + "tabularColumnGuids": null, + "guid": "ae7f8624-04d1-43af-981d-c1b4409a4d12" + } + }, + "Example 3": { + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates the response to creating a new tabular attribute layout item with specified tabular columns to include. It was created by adding the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include. ", + "value": { + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "required": false, + "readOnly": false, + "metaAttributes": null, + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ], + "guid": null + } + }, + "Example 4": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates the response to creating a new link group layout item. It was created by adding the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "recordLink", + "forwards": null, + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949", + "guid": null + } + }, + "Example 5": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates the response to creating a new smart link group layout item. It was created by adding the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66", + "guid": null + } + }, + "Example 6": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates the response to creating a new cross database link group layout item. It was created by adding a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "464fd238-6ef6-49e3-b6b7-8144cdfaeea9", + "sourceTableGuid": "cd6219a9-7935-4a3e-a748-b402ed448ea7", + "linkGroupGuid": "a181d1d9-5d1f-4cd4-8371-a9615bb9336c", + "guid": null + } + }, + "Example 7": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates the response to creating a new association chain layout item. It was created by adding a association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", + "tabularAttributeGuid": "ac6bcebc-2736-4afc-a405-ed8b4d79c821" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", + "tabularAttributeGuid": "522fe653-059d-4c68-bd87-508d114f9680" + } + ], + "guid": null + } + } } } } @@ -50504,33 +41833,60 @@ "400": { "description": "Bad request" }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database not found" + "description": "Database, table, layout or layout section not found" } } } }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items/{item-guid}": { + "delete": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Layout Sections" ], - "summary": "Gets all discrete values for a given discreteType, returned in order.", - "operationId": "GetDiscreteValues", + "summary": "Delete a layout item.", + "operationId": "DeleteItem", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "discrete-type-guid", + "name": "layout-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "section-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "item-guid", "in": "path", "required": true, "schema": { @@ -50541,40 +41897,135 @@ ], "responses": { "200": { - "description": "OK", + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table, layout, layout section or layout section item not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts": { + "get": { + "tags": [ + "Schema - Layouts" + ], + "summary": "Get all layouts for table", + "operationId": "GetLayouts", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "Optionally filter by application that the layout is applicable to.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" + "$ref": "#/components/schemas/GsaLayoutsInfo" + }, + "example": { + "layouts": [ + { + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": {}, + "name": "Metals", + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": {}, + "name": "Polymers", + "guid": "00007645-0009-4fff-8fff-dd92ffff0000" + } + ] } } } }, "404": { - "description": "Database or discrete type not found" + "description": "Database or table not found" } } }, "post": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Layouts" ], - "summary": "Create new discrete value. It will be added at the end.", - "operationId": "CreateDiscreteValue", + "summary": "Create a new layout.", + "operationId": "CreateLayout", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "discrete-type-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -50587,88 +42038,132 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Discrete Value 1" + "name": "Composite materials" } }, "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "New Discrete Value 2", - "guid": "45c11288-98bc-437a-acba-1350f7208400" + "name": "Composite materials (guid)", + "guid": "4f402df4-e80f-4f2b-a4ee-463666b043f9" + } + }, + "Example 3": { + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "value": { + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Composite materials (with applicable applications)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Discrete Value 1" + "name": "Composite materials" } }, "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "New Discrete Value 2", - "guid": "45c11288-98bc-437a-acba-1350f7208400" + "name": "Composite materials (guid)", + "guid": "4f402df4-e80f-4f2b-a4ee-463666b043f9" + } + }, + "Example 3": { + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "value": { + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Composite materials (with applicable applications)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Discrete Value 1" + "name": "Composite materials" } }, "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "New Discrete Value 2", - "guid": "45c11288-98bc-437a-acba-1350f7208400" + "name": "Composite materials (guid)", + "guid": "4f402df4-e80f-4f2b-a4ee-463666b043f9" + } + }, + "Example 3": { + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "value": { + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Composite materials (with applicable applications)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Discrete Value 1" + "name": "Composite materials" } }, "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "New Discrete Value 2", - "guid": "45c11288-98bc-437a-acba-1350f7208400" + "name": "Composite materials (guid)", + "guid": "4f402df4-e80f-4f2b-a4ee-463666b043f9" + } + }, + "Example 3": { + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "value": { + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Composite materials (with applicable applications)" } } } @@ -50681,49 +42176,259 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + "$ref": "#/components/schemas/GsaLayout" + }, + "example": { + "applicableApplications": [], + "displayNames": {}, + "name": "Ceramics", + "guid": "0c4aeaf7-c663-4491-bc0b-ca51f1d45988" } } } }, "400": { - "description": "Bad Request", + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}": { + "get": { + "tags": [ + "Schema - Layouts" + ], + "summary": "Get a layout with a specified guid for a given database and table.", + "operationId": "GetLayout", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "showFullDetail", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValueCreationException" + "$ref": "#/components/schemas/GsaLayout" + }, + "examples": { + "Example 1": { + "summary": "Layout with 'slim' sections", + "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to false, which is the default value.", + "value": { + "sections": [ + { + "sectionDetailType": "slim", + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" + }, + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + } + ], + "applicableApplications": [], + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 2": { + "summary": "Layout with 'full' sections", + "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to true.", + "value": { + "sections": [ + { + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "a65b2a27-75b3-4198-b851-c82ef8a92eec", + "name": "Price", + "guid": "44b46384-7430-439a-bc18-b8940ce73f8b" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "db64884e-6ddd-40d6-92a0-5929b1a3e564", + "name": "Density", + "guid": "5cf35f6a-54d7-4c27-bc88-e2e75865ed1f" + } + ], + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" + }, + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "floatFunctional", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "3a951d00-278e-4457-b3da-9af3d11bb685", + "name": "Young's modulus", + "guid": "d931796b-f2a7-4424-bab1-8cb1c9c682f2" + }, + { + "itemType": "attribute", + "attributeType": "range", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "28642f7e-7d05-4346-802f-25045ea383b3", + "name": "Tensile strength", + "guid": "1ee4ef0c-6631-4334-aa39-810e4b555628" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "fd1c299b-39c9-4ab1-84bf-8b5e3e4e8a00", + "name": "Shape factor", + "guid": "f3b922bf-7c41-4f2f-9c98-277dbbf07559" + } + ], + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + } + ], + "applicableApplications": [], + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + } } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or discrete type not found" + "description": "Database, table or layout not found" } } }, - "put": { + "patch": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Layouts" ], - "summary": "Replace the whole discrete value collection for a given discrete type.\r\nThis will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails.\r\nIf any 'update' discrete values are included in the request where the guid does not match an existing discrete value the operation will fail.\r\nIf any 'create' discrete values are included in the request body where the name matches an existing discrete value the operation will fail.", - "operationId": "ReplaceDiscreteValues", + "summary": "Update a layout.", + "operationId": "UpdateLayout", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "discrete-type-guid", + "name": "layout-guid", "in": "path", "required": true, "schema": { @@ -50736,132 +42441,132 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Replace Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values for the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" - }, - { - "type": "create", - "name": "New Value with specific GUID", - "guid": "065fe412-de1b-4df6-9264-7ba25b55a03f" - }, - { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" - }, - { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ] + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "882e2f63-a3b5-4d87-bdbe-eff0ef2b1c55" + } + }, + "Example 2": { + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "applicableApplications": null } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Replace Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values for the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" - }, - { - "type": "create", - "name": "New Value with specific GUID", - "guid": "065fe412-de1b-4df6-9264-7ba25b55a03f" - }, - { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" - }, - { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ] + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "882e2f63-a3b5-4d87-bdbe-eff0ef2b1c55" + } + }, + "Example 2": { + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "applicableApplications": null } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Replace Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values for the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" - }, - { - "type": "create", - "name": "New Value with specific GUID", - "guid": "065fe412-de1b-4df6-9264-7ba25b55a03f" - }, - { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" - }, - { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ] + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "882e2f63-a3b5-4d87-bdbe-eff0ef2b1c55" + } + }, + "Example 2": { + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "applicableApplications": null } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Replace Discrete Values", - "description": "This example demonstrates how to replace the set of discrete values for the 'Standard' discrete type (guid = 0000000c-0006-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "discreteValues": [ - { - "type": "create", - "name": "New Value" - }, - { - "type": "create", - "name": "New Value with specific GUID", - "guid": "065fe412-de1b-4df6-9264-7ba25b55a03f" - }, - { - "type": "update", - "guid": "00000032-0007-4fff-8fff-000cffff0000" - }, - { - "type": "update", - "guid": "00000033-0007-4fff-8fff-000cffff0000", - "name": "Modified name for very good" - } - ] + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "882e2f63-a3b5-4d87-bdbe-eff0ef2b1c55" + } + }, + "Example 2": { + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "applicableApplications": null } } } @@ -50874,51 +42579,45 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" + "$ref": "#/components/schemas/GsaLayout" + }, + "example": { + "applicableApplications": [], + "displayNames": {}, + "name": "Ceramics", + "guid": "3a95866b-e61e-40ed-9047-e0ddfd31e788" } } } }, "400": { - "description": "Bad Request. e.g. would delete a discrete value that is in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplaceDiscreteValuesException" - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or discrete type not found" + "description": "Database, table or layout not found" } } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values/{discrete-value-guid}": { - "get": { + }, + "delete": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Layouts" ], - "summary": "Gets specific discrete value for a given discreteType within a given database.", - "operationId": "GetDiscreteValue", + "summary": "Delete a layout.", + "operationId": "DeleteLayout", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "discrete-type-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -50927,7 +42626,7 @@ } }, { - "name": "discrete-value-guid", + "name": "layout-guid", "in": "path", "required": true, "schema": { @@ -50938,49 +42637,38 @@ ], "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" - } - } - } + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, discrete type or discrete value not found" + "description": "Database, table or layout not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:applications": { + "get": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Layouts" ], - "summary": "Update discrete value.", - "operationId": "UpdateDiscreteValue", + "summary": "Returns applications that are either MI Applications, or in use in layouts in this table.\r\nCan be used as applicable applications for layouts.", + "operationId": "Applications", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "discrete-value-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -50989,208 +42677,48 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - } - } - }, "responses": { "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" - } - } - } - }, - "400": { - "description": "Bad request.", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValueUpdateException" + "$ref": "#/components/schemas/GsaApplicationsInfo" + }, + "example": { + "applications": [ + "MI:Viewer", + "MI:Explore", + "MI:Materials Gateway", + "An Application" + ] } } } }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database, discrete type or discrete value not found." + "description": "Database or table not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/parameters": { + "get": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Parameters" ], - "summary": "Delete a single discrete value. It must not be used by any data, or the operation will fail.", - "operationId": "DeleteDiscreteValue", + "summary": "Get all parameters for a given database.", + "operationId": "GetParameters", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "discrete-value-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. Discrete value in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValueDeletionException" - }, - "example": { - "message": "Cannot delete Discrete Value with GUID '00000583-0007-4fff-8fff-0083ffff0000'.", - "code": "deletion", - "discreteValueGuid": "00000583-0007-4fff-8fff-0083ffff0000", - "errors": [ - { - "message": "The Discrete Value with name 'Unacceptable' is being used in one or more data items.", - "reason": "discreteValueUsedInData", - "discreteValueInUse": { - "name": "Unacceptable", - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - } - ] - } - } - } - }, - "200": { - "description": "OK." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, discrete type or discrete value not found." - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values:find-unused": { - "get": { - "tags": [ - "Schema - DiscreteTypes - DiscreteValues" - ], - "summary": "Find discrete values that are not in use by any data", - "operationId": "FindUnusedDiscreteValues", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" - } - } - } - }, - "400": { - "description": "Bad Request" - }, - "404": { - "description": "Database or discrete type not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/display-names/{language}": { - "get": { - "tags": [ - "Schema - Display Names" - ], - "summary": "Gets display names for all localized entities in the database, in the given language.", - "operationId": "GetAllDisplayNames", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "language", - "in": "path", - "required": true, - "schema": { - "type": "string" + "type": "string" } } ], @@ -51200,91 +42728,123 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDisplayNamesInfo" + "$ref": "#/components/schemas/GsaParametersInfo" }, - "example": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - null, - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "FPS (Consistent)", - null, - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "French display name for Value", - "fr", - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" + "examples": { + "Example 1": { + "summary": "A mix of parameters", + "description": "This example contains a mix of numeric and discrete parameters from the MI_Training database.", + "value": { + "parameters": [ + { + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + }, + { + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" + } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "isRestricted": false, + "values": [ + { + "type": "numeric", + "value": -1.0, + "guid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94" + }, + { + "type": "numeric", + "value": 0.0, + "guid": "00000022-000b-4fff-8fff-0022ffff0000" + } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/strain-ratio.html", + "defaultParameterValueGuid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94", + "displayNames": { + "en": "Strain Ratio", + "fr": "Rapport de contrainte" + }, + "name": "Strain Ratio", + "guid": "00000022-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "values": [ + { + "type": "discrete", + "name": "Mean", + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "type": "discrete", + "name": "A-basis", + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + { + "type": "discrete", + "name": "B-basis", + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + ], + "helpPath": "/help/basis.html", + "defaultParameterValueGuid": "21a27377-12eb-413c-bac4-d4ffceda39d1", + "displayNames": { + "en": "Basis", + "fr": "Base" + }, + "name": "Basis", + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } ] - ] + } } } } } }, - "403": { - "description": "Forbidden." - }, "404": { "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/display-names": { - "patch": { + }, + "post": { "tags": [ - "Schema - Display Names" + "Schema - Parameters" ], - "summary": "Updates display names for localized entities in the database.\r\nReturns the number of entities updated.", - "operationId": "ImportDisplayNames", + "summary": "Create a new parameter.", + "operationId": "CreateParameter", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -51292,285 +42852,604 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" + "$ref": "#/components/schemas/GsaCreateParameter" }, "examples": { "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] - } + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" + } + }, + "Example 2": { + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "value": { + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "2f322177-72fb-42fc-97fb-50b7a765c5d1" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "647ed4d7-0e59-468f-afc7-7101f55dfbd5" + } + }, + "Example 3": { + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "value": { + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" + } + }, + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "value": { + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" + } + }, + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "value": { + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" + "$ref": "#/components/schemas/GsaCreateParameter" }, "examples": { "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] - } + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" - }, - "examples": { - "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + }, + "Example 2": { + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] - } + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "2f322177-72fb-42fc-97fb-50b7a765c5d1" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "647ed4d7-0e59-468f-afc7-7101f55dfbd5" + } + }, + "Example 3": { + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "value": { + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" + } + }, + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "value": { + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" + } + }, + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "value": { + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" } } } }, - "application/*+json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" + "$ref": "#/components/schemas/GsaCreateParameter" }, "examples": { "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNamesResponse" + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" + } + }, + "Example 2": { + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "value": { + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "2f322177-72fb-42fc-97fb-50b7a765c5d1" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "647ed4d7-0e59-468f-afc7-7101f55dfbd5" + } + }, + "Example 3": { + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "value": { + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" + } + }, + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "value": { + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" + } + }, + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "value": { + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateParameter" + }, + "examples": { + "Example 1": { + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", + "value": { + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" + } + }, + "Example 2": { + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "value": { + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "2f322177-72fb-42fc-97fb-50b7a765c5d1" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "647ed4d7-0e59-468f-afc7-7101f55dfbd5" + } + }, + "Example 3": { + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "value": { + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" + } + }, + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "value": { + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" + } + }, + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "value": { + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" + } } } } - }, - "400": { - "description": "Bad Request.", + } + }, + "responses": { + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDisplayNamesImportException" + "$ref": "#/components/schemas/GsaParameter" }, - "examples": { - "Example 1": { - "summary": "Schema item not found", - "description": "A unit system could not be found with the provided name.", - "value": { - "message": "Cannot import display names.", - "code": "displayNamesImport", - "errors": [ - { - "message": "'UnitSystemName' in column 'Schema Object Name' was not found in the database.", - "reason": "schemaItemNotFound", - "rowIndex": 2, - "fieldValue": "CGSx", - "columnHeader": "Schema Object Name", - "itemType": "UnitSystemName" - } - ] - } + "example": { + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'headers' was not provided.", - "value": { - "message": "Grid: Required property 'headers' not found in JSON", - "code": "jsonSerialization" + "values": [ + { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + }, + { + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" } - } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/Strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" } } } }, + "400": { + "description": "Bad request" + }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { "description": "Database not found" @@ -51578,23 +43457,29 @@ } } }, - "/v1alpha/databases/{database-key}/exporters": { + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}": { "get": { "tags": [ - "Schema - Exporters" + "Schema - Parameters" ], - "summary": "Get All Exporter Folders", - "operationId": "GetExportersFolders", + "summary": "Get a parameter with a specified guid for a given database.", + "operationId": "GetParameter", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -51602,137 +43487,70 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - }, - { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "MI_Training", - "guid": "19cc65a2-f8bf-4989-9859-e883756290de" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - }, - { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "MI_Training", - "guid": "19cc65a2-f8bf-4989-9859-e883756290de" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "$ref": "#/components/schemas/GsaParameter" }, "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - }, - { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "MI_Training", - "guid": "19cc65a2-f8bf-4989-9859-e883756290de" - }, + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" + }, + "values": [ { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" }, { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" } - ] + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/Strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" } } } }, "404": { - "description": "Database not found" + "description": "Database or parameter not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - Exporters" + "Schema - Parameters" ], - "summary": "Create a new Exporters Folder.", - "operationId": "CreateExportersFolder", + "summary": "Update a parameter.", + "operationId": "UpdateParameter", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -51740,60 +43558,312 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "def3e6bb-a7d5-44f7-ad87-cee97c123524" + } + }, + "Example 2": { + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "3e5cf1c4-63b5-41a6-a1e8-81635cf187de" + } + }, + "Example 3": { + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", + "value": { + "type": "numeric", + "guid": "6ba9e86e-818c-47cd-bdb8-53162092cf07" + } + }, + "Example 4": { + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", + "value": { + "type": "discrete", + "name": "Strain (Updated)" + } + }, + "Example 5": { + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "value": { + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "guid": "f6f83a9c-596c-4232-86d8-a62268a8ee7a" + } + }, + "Example 6": { + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", + "value": { + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" - } + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "def3e6bb-a7d5-44f7-ad87-cee97c123524" + } + }, + "Example 2": { + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "3e5cf1c4-63b5-41a6-a1e8-81635cf187de" + } + }, + "Example 3": { + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", + "value": { + "type": "numeric", + "guid": "6ba9e86e-818c-47cd-bdb8-53162092cf07" + } + }, + "Example 4": { + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", + "value": { + "type": "discrete", + "name": "Strain (Updated)" + } + }, + "Example 5": { + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "value": { + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "guid": "f6f83a9c-596c-4232-86d8-a62268a8ee7a" + } + }, + "Example 6": { + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", + "value": { + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" + } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "def3e6bb-a7d5-44f7-ad87-cee97c123524" + } + }, + "Example 2": { + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "3e5cf1c4-63b5-41a6-a1e8-81635cf187de" + } + }, + "Example 3": { + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", + "value": { + "type": "numeric", + "guid": "6ba9e86e-818c-47cd-bdb8-53162092cf07" + } + }, + "Example 4": { + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", + "value": { + "type": "discrete", + "name": "Strain (Updated)" + } + }, + "Example 5": { + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "value": { + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "guid": "f6f83a9c-596c-4232-86d8-a62268a8ee7a" + } + }, + "Example 6": { + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", + "value": { + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "def3e6bb-a7d5-44f7-ad87-cee97c123524" + } + }, + "Example 2": { + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "3e5cf1c4-63b5-41a6-a1e8-81635cf187de" + } + }, + "Example 3": { + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", + "value": { + "type": "numeric", + "guid": "6ba9e86e-818c-47cd-bdb8-53162092cf07" + } + }, + "Example 4": { + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", + "value": { + "type": "discrete", + "name": "Strain (Updated)" + } + }, + "Example 5": { + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "value": { + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "guid": "f6f83a9c-596c-4232-86d8-a62268a8ee7a" + } + }, + "Example 6": { + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", + "value": { + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" } } } @@ -51801,195 +43871,150 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaParameter" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + }, + { + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" + } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/Strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" } } } }, "400": { - "description": "Bad request", + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or parameter not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Parameters" + ], + "summary": "Delete a parameter.", + "operationId": "DeleteParameter", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "400": { + "description": "Bad request. Parameter in use.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Folder with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter folder with name 'Abaqus' in the 'MI_Training' folder (GUID '19cc65a2-f8bf-4989-9859-e883756290de'), but there is already a folder with that name and parent.", - "value": { - "message": "Cannot create Exporter folder 'Abaqus'.", - "code": "folderCreation", - "name": "Abaqus", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Folder with name 'Abaqus' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "Abaqus", - "parentEntityType": "folder", - "entityType": "folder" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Folder with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter folder with name 'Abaqus' in the 'MI_Training' folder (GUID '19cc65a2-f8bf-4989-9859-e883756290de'), but there is already a folder with that name and parent.", - "value": { - "message": "Cannot create Exporter folder 'Abaqus'.", - "code": "folderCreation", - "name": "Abaqus", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Folder with name 'Abaqus' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "Abaqus", - "parentEntityType": "folder", - "entityType": "folder" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" + "$ref": "#/components/schemas/GsaParameterDeletionException" }, - "examples": { - "Example 1": { - "summary": "Folder with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter folder with name 'Abaqus' in the 'MI_Training' folder (GUID '19cc65a2-f8bf-4989-9859-e883756290de'), but there is already a folder with that name and parent.", - "value": { - "message": "Cannot create Exporter folder 'Abaqus'.", - "code": "folderCreation", - "name": "Abaqus", - "folderType": "exporter", - "errors": [ + "example": { + "message": "Cannot delete parameter 'Strain' (GUID = '00000005-000a-4fff-8fff-0000ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in one or more attributes.", + "reason": "usage", + "referencedByType": "attribute", + "referencedBy": [ { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Folder with name 'Abaqus' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "Abaqus", - "parentEntityType": "folder", - "entityType": "folder" - } - ] + "type": "floatFunctional", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Tensile strength with temperature", + "guid": "00000002-0001-4fff-8fff-dd92ffff0000" } ] } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } + ] } } } }, + "200": { + "description": "Ok" + }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database not found" + "description": "Database or parameter not found" } } } }, - "/v1alpha/databases/{database-key}/exporters:root-folder": { + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}:usages": { "get": { "tags": [ - "Schema - Exporters" + "Schema - Parameters" ], - "summary": "Get Root Exporters Folder", - "operationId": "GetExportersRootFolder", + "summary": "Get attributes which currently use the given parameter.", + "operationId": "GetObjectsUsingParameter", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -51997,68 +44022,46 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "$ref": "#/components/schemas/GsaSlimObjects" } } } }, "404": { - "description": "Database not found" + "description": "Database or parameter not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}": { + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values/{parameter-value-guid}": { "get": { "tags": [ - "Schema - Exporters" + "Schema - Parameters" ], - "summary": "Get Exporters Folder", - "operationId": "GetExportersFolder", + "summary": "Get a parameter value with a specified guid for a given database for a given parameter.", + "operationId": "GetParameterValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "parameter-value-guid", "in": "path", "required": true, "schema": { @@ -52071,69 +44074,49 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaParameterValue" }, "example": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database, parameter or parameter value not found" } } }, "patch": { "tags": [ - "Schema - Exporters" + "Schema - Parameters" ], - "summary": "Update an existing Exporters Folder.", - "operationId": "UpdateExportersFolder", + "summary": "Update a parameter value.", + "operationId": "UpdateParameterValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "parameter-value-guid", "in": "path", "required": true, "schema": { @@ -52146,84 +44129,136 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateParameterValue" }, "examples": { "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "bac27307-b5f2-4845-bca4-327a2c2dfaac" } }, "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Mean (Updated)", + "guid": "66c20174-6317-4fef-92a6-be9109c8160d" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", "value": { - "guid": "604d28db-f8d6-47c5-abc3-82ef091688ed" + "type": "numeric", + "guid": "ffda4a3b-0a11-4e02-ad09-ff12977e1285" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateParameterValue" }, "examples": { "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "bac27307-b5f2-4845-bca4-327a2c2dfaac" } }, "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", "value": { - "guid": "604d28db-f8d6-47c5-abc3-82ef091688ed" + "type": "discrete", + "name": "Mean (Updated)", + "guid": "66c20174-6317-4fef-92a6-be9109c8160d" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "value": { + "type": "numeric", + "guid": "ffda4a3b-0a11-4e02-ad09-ff12977e1285" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateParameterValue" }, "examples": { "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "bac27307-b5f2-4845-bca4-327a2c2dfaac" } }, "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Mean (Updated)", + "guid": "66c20174-6317-4fef-92a6-be9109c8160d" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", "value": { - "guid": "604d28db-f8d6-47c5-abc3-82ef091688ed" + "type": "numeric", + "guid": "ffda4a3b-0a11-4e02-ad09-ff12977e1285" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateParameterValue" }, "examples": { "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "bac27307-b5f2-4845-bca4-327a2c2dfaac" } }, "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Mean (Updated)", + "guid": "66c20174-6317-4fef-92a6-be9109c8160d" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", "value": { - "guid": "604d28db-f8d6-47c5-abc3-82ef091688ed" + "type": "numeric", + "guid": "ffda4a3b-0a11-4e02-ad09-ff12977e1285" } } } @@ -52234,259 +44269,55 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaParameterValue" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root Exporter folder.", - "value": { - "message": "Cannot update Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderUpdate", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root Exporter folder.", - "value": { - "message": "Cannot update Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderUpdate", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root Exporter folder.", - "value": { - "message": "Cannot update Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderUpdate", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - } - } + "description": "Bad request. Parameter in use." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database or folder not found" + "description": "Database, parameter or parameter value not found" } } }, "delete": { "tags": [ - "Schema - Exporters" + "Schema - Parameters" ], - "summary": "Delete an Exporter Folder.", - "operationId": "DeleteExportersFolder", + "summary": "Delete a parameter value.", + "operationId": "DeleteParameterValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "parameter-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root Exporter folder.", - "value": { - "message": "Cannot delete Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderDeletion", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root Exporter folder.", - "value": { - "message": "Cannot delete Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderDeletion", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root Exporter folder.", - "value": { - "message": "Cannot delete Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderDeletion", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:child-folders": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get Child Exporters Folders", - "operationId": "GetExportersChildFolders", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } }, { - "name": "folder-guid", + "name": "parameter-value-guid", "in": "path", "required": true, "schema": { @@ -52496,160 +44327,63 @@ } ], "responses": { - "200": { - "description": "Ok", + "400": { + "description": "Bad request. Parameter in use.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "$ref": "#/components/schemas/GsaParameterValueDeletionException" }, "example": { - "folders": [ - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, + "message": "Cannot delete parameter value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1').", + "code": 400, + "errors": [ { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" + "message": "It is being used in one or more parameters as a default value.", + "reason": "usage", + "referencedByType": "defaultParameterValue", + "referencedBy": [ + { + "name": "Basis", + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] } ] } } } }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters:re-fetch": { - "post": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Re-fetch the Exporter Files.", - "operationId": "RefetchExporters", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaExporterRefetchInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaExporterRefetchInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaExporterRefetchInfo" - } - } - } - }, - "400": { - "description": "Bad request" + "description": "Ok" }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database not found" + "description": "Database, parameter or parameter value not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:move": { + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values": { "post": { "tags": [ - "Schema - Exporters" + "Schema - Parameters" ], - "summary": "Move an existing Exporter Folder.", - "operationId": "MoveExportersFolder", + "summary": "Create a new parameter value.", + "operationId": "CreateParameterValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "parameter-guid", "in": "path", "required": true, "schema": { @@ -52662,56 +44396,96 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateParameterValue" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateParameterValue" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateParameterValue" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateParameterValue" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" } } } @@ -52719,416 +44493,83 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaParameterValue" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root Exporter folder.", - "value": { - "message": "Cannot move Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderMove", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root Exporter folder.", - "value": { - "message": "Cannot move Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderMove", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root Exporter folder.", - "value": { - "message": "Cannot move Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderMove", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - } - } + "description": "Bad request. Parameter in use." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database or folder not found" + "description": "Database or parameter not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files": { + "/v1alpha/profiles": { "get": { "tags": [ - "Schema - Exporters" - ], - "summary": "Get the Exporter Files in a Folder", - "operationId": "GetExportersFiles", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Schema - Profiles" ], + "summary": "Get AllProfilesInfo", + "operationId": "GetProfiles", "responses": { "200": { "description": "Ok", "content": { - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" + "$ref": "#/components/schemas/GsaAllProfilesInfo" }, "example": { - "files": [ + "profiles": [ { - "name": "exporter-1.exp", - "guid": "99c31027-0f78-4d88-8ffd-7824b203c51f" + "key": "MI_Training", + "isImplicit": true, + "name": "MI Training" }, { - "name": "no-transform.xslt", - "guid": "a9156c51-21ea-492b-94e3-b5bd2d8b1124" - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "exporter-1.exp", - "guid": "99c31027-0f78-4d88-8ffd-7824b203c51f" + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" }, { - "name": "no-transform.xslt", - "guid": "a9156c51-21ea-492b-94e3-b5bd2d8b1124" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "exporter-1.exp", - "guid": "99c31027-0f78-4d88-8ffd-7824b203c51f" + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Composites" }, { - "name": "no-transform.xslt", - "guid": "a9156c51-21ea-492b-94e3-b5bd2d8b1124" - } - ] - } - } - } - }, - "404": { - "description": "Database or folder not found" - } - } - }, - "post": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Create a new Exporter File.", - "operationId": "CreateExportersFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" - } - } - }, - "encoding": { - "file": { - "style": "form" - }, - "description": { - "style": "form" - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "c0a10eac-a4b9-4746-b6de-ce6b58daa2c2" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "c0a10eac-a4b9-4746-b6de-ce6b58daa2c2" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "c0a10eac-a4b9-4746-b6de-ce6b58daa2c2" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter file with name 'AbaqusFunctions.xsl' in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff'), but there is already a file with that name and parent.", - "value": { - "message": "Cannot create Exporter file 'AbaqusFunctions.xsl'.", - "code": "fileCreation", - "name": "AbaqusFunctions.xsl", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "entityType": "file" - } - ] - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter file with name 'AbaqusFunctions.xsl' in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff'), but there is already a file with that name and parent.", - "value": { - "message": "Cannot create Exporter file 'AbaqusFunctions.xsl'.", - "code": "fileCreation", - "name": "AbaqusFunctions.xsl", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "entityType": "file" - } - ] - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter file with name 'AbaqusFunctions.xsl' in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff'), but there is already a file with that name and parent.", - "value": { - "message": "Cannot create Exporter file 'AbaqusFunctions.xsl'.", - "code": "fileCreation", - "name": "AbaqusFunctions.xsl", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "entityType": "file" - } - ] - } - ] + "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Additive Manufacturing" } + ], + "defaultProfile": { + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" } } } @@ -53136,485 +44577,515 @@ }, "403": { "description": "Forbidden" - }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get the header information for an Exporter File", - "operationId": "GetExporterFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "955d8a25-9677-4d4c-8929-30f95bae81df" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "955d8a25-9677-4d4c-8929-30f95bae81df" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "955d8a25-9677-4d4c-8929-30f95bae81df" - } - } - } - }, - "404": { - "description": "Database, folder or file not found" } } }, "patch": { "tags": [ - "Schema - Exporters" - ], - "summary": "Update an existing Exporter File.", - "operationId": "UpdateExportersFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Schema - Profiles" ], + "summary": "Update AllProfilesInfo", + "operationId": "UpdateAllProfilesInfo", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "name": "New File Name" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "description": "New description for Exporter file." + "defaultProfile": null } }, "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", "value": { - "guid": "f6fa8441-68d6-415e-9de2-27695cd6a126" + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] + } + }, + "Example 4": { + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "value": { + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ], + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "name": "New File Name" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "description": "New description for Exporter file." + "defaultProfile": null } }, "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "value": { + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] + } + }, + "Example 4": { + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", "value": { - "guid": "f6fa8441-68d6-415e-9de2-27695cd6a126" + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ], + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "name": "New File Name" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "description": "New description for Exporter file." + "defaultProfile": null } }, "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "value": { + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] + } + }, + "Example 4": { + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", "value": { - "guid": "f6fa8441-68d6-415e-9de2-27695cd6a126" + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ], + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "name": "New File Name" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "description": "New description for Exporter file." + "defaultProfile": null } }, "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", "value": { - "guid": "f6fa8441-68d6-415e-9de2-27695cd6a126" - } - } - } - } - } - }, - "responses": { + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] + } + }, + "Example 4": { + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "value": { + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ], + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + } + } + } + } + } + }, + "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "a6d0f3fd-19d7-4226-b21d-4dace05c5c39" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "a6d0f3fd-19d7-4226-b21d-4dace05c5c39" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaAllProfilesInfo" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "a6d0f3fd-19d7-4226-b21d-4dace05c5c39" + "profiles": [ + { + "key": "MI_Training", + "isImplicit": true, + "name": "MI Training" + }, + { + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" + }, + { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Composites" + }, + { + "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Additive Manufacturing" + } + ], + "defaultProfile": { + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" + } } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Profile not found" + } + } + }, + "post": { + "tags": [ + "Schema - Profiles" + ], + "summary": "Create a new profile", + "operationId": "CreateProfile", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateProfile" + }, + "examples": { + "Example 1": { + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", + "value": { + "name": "MI:Training Processes" + } }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename an Exporter file in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff') to have name 'AbaqusFunctions.xsl', but there is already a file with that name and parent.", - "value": { - "message": "Cannot update Exporter file with GUID 'dad130ff-00c4-45f4-a654-6374b2aa1488'.", - "code": "fileUpdate", - "fileGuid": "dad130ff-00c4-45f4-a654-6374b2aa1488", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "entityType": "file" - } - ] - } - ] - } + "Example 2": { + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "MI:Training Processes", + "guid": "2ebfc775-be3c-443a-9639-ef0bf4e86c98" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "6c615061-2958-4f21-9778-65756a8665f0" } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateProfile" }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" + "examples": { + "Example 1": { + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", + "value": { + "name": "MI:Training Processes" + } }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename an Exporter file in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff') to have name 'AbaqusFunctions.xsl', but there is already a file with that name and parent.", - "value": { - "message": "Cannot update Exporter file with GUID 'dad130ff-00c4-45f4-a654-6374b2aa1488'.", - "code": "fileUpdate", - "fileGuid": "dad130ff-00c4-45f4-a654-6374b2aa1488", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "entityType": "file" - } - ] - } - ] - } + "Example 2": { + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "MI:Training Processes", + "guid": "2ebfc775-be3c-443a-9639-ef0bf4e86c98" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "6c615061-2958-4f21-9778-65756a8665f0" } } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateProfile" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" + "examples": { + "Example 1": { + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", + "value": { + "name": "MI:Training Processes" + } }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename an Exporter file in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff') to have name 'AbaqusFunctions.xsl', but there is already a file with that name and parent.", - "value": { - "message": "Cannot update Exporter file with GUID 'dad130ff-00c4-45f4-a654-6374b2aa1488'.", - "code": "fileUpdate", - "fileGuid": "dad130ff-00c4-45f4-a654-6374b2aa1488", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "reason": "nameAlreadyExists", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "entityType": "file" - } - ] - } - ] - } + "Example 2": { + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "MI:Training Processes", + "guid": "2ebfc775-be3c-443a-9639-ef0bf4e86c98" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "6c615061-2958-4f21-9778-65756a8665f0" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateProfile" + }, + "examples": { + "Example 1": { + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", + "value": { + "name": "MI:Training Processes" + } + }, + "Example 2": { + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "MI:Training Processes", + "guid": "2ebfc775-be3c-443a-9639-ef0bf4e86c98" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "6c615061-2958-4f21-9778-65756a8665f0" } } } } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, folder or file not found" } - } - }, - "delete": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Delete an Exporter File.", - "operationId": "DeleteExportersFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaProfile" + }, + "example": { + "description": "#markdown\r\nFor metals-oriented users.", + "homepageUrl": "TrainingProfiles/MITrainingMetals", + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" + } + ], + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" + } + } } }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" + "400": { + "description": "Bad request" }, "403": { "description": "Forbidden" - }, - "404": { - "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:export": { + "/v1alpha/profiles/{profile-guid}": { "get": { "tags": [ - "Schema - Exporters" + "Schema - Profiles" ], - "summary": "Get Exporter folder and contents as a zip file", - "operationId": "ExportExportersFolder", + "summary": "Get individual profile", + "operationId": "GetProfile", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", + "name": "profile-guid", "in": "path", "required": true, "schema": { @@ -53627,108 +45098,55 @@ "200": { "description": "Ok", "content": { - "application/zip": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaProfile" + }, + "example": { + "description": "#markdown\r\nFor metals-oriented users.", + "homepageUrl": "TrainingProfiles/MITrainingMetals", + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" + } + ], + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" } } - }, - "x-is-file": true - }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:export": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get Exporter File as a file", - "operationId": "ExportExportersFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" } }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Profile not found" } } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:move": { - "post": { + }, + "patch": { "tags": [ - "Schema - Exporters" + "Schema - Profiles" ], - "summary": "Move an existing Exporter File.", - "operationId": "MoveExportersFile", + "summary": "Update a profile", + "operationId": "UpdateProfile", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", + "name": "profile-guid", "in": "path", "required": true, "schema": { @@ -53741,56 +45159,144 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaUpdateProfile" }, "examples": { "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "guid": "dacea49a-7ea0-4aad-9e17-cabfb82ba11d" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveFile" - }, - "examples": { - "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + }, + "Example 2": { + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "name": "MI:Training Metals (Updated)" + } + }, + "Example 3": { + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "value": { + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "4ce8c3e8-4522-46ec-92b3-0c08db6a320a", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateProfile" + }, + "examples": { + "Example 1": { + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "dacea49a-7ea0-4aad-9e17-cabfb82ba11d" + } + }, + "Example 2": { + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "name": "MI:Training Metals (Updated)" + } + }, + "Example 3": { + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "value": { + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "4ce8c3e8-4522-46ec-92b3-0c08db6a320a", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaUpdateProfile" }, "examples": { "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "guid": "dacea49a-7ea0-4aad-9e17-cabfb82ba11d" + } + }, + "Example 2": { + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "name": "MI:Training Metals (Updated)" + } + }, + "Example 3": { + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "value": { + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "4ce8c3e8-4522-46ec-92b3-0c08db6a320a", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaUpdateProfile" }, "examples": { "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "guid": "dacea49a-7ea0-4aad-9e17-cabfb82ba11d" + } + }, + "Example 2": { + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "name": "MI:Training Metals (Updated)" + } + }, + "Example 3": { + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "value": { + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "4ce8c3e8-4522-46ec-92b3-0c08db6a320a", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" } } } @@ -53801,163 +45307,58 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "4dea705b-6856-4e32-96c5-add1cfafa152" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "4dea705b-6856-4e32-96c5-add1cfafa152" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaProfile" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "4dea705b-6856-4e32-96c5-add1cfafa152" + "description": "#markdown\r\nFor metals-oriented users.", + "homepageUrl": "TrainingProfiles/MITrainingMetals", + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" + } + ], + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '5d5b33de-3762-4652-90cd-df9ccd14f552', but there is no Exporter folder with that GUID.", - "value": { - "message": "Cannot move Exporter file with GUID 'ccfb44a6-d5a3-4c43-bf9f-258671eb636c'.", - "code": "fileMove", - "fileGuid": "ccfb44a6-d5a3-4c43-bf9f-258671eb636c", - "folderType": "exporter", - "errors": [ - { - "message": "A Exporter folder with GUID '5d5b33de-3762-4652-90cd-df9ccd14f552' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "5d5b33de-3762-4652-90cd-df9ccd14f552", - "folderType": "exporter", - "databaseKey": "MI_Training" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '5d5b33de-3762-4652-90cd-df9ccd14f552', but there is no Exporter folder with that GUID.", - "value": { - "message": "Cannot move Exporter file with GUID 'ccfb44a6-d5a3-4c43-bf9f-258671eb636c'.", - "code": "fileMove", - "fileGuid": "ccfb44a6-d5a3-4c43-bf9f-258671eb636c", - "folderType": "exporter", - "errors": [ - { - "message": "A Exporter folder with GUID '5d5b33de-3762-4652-90cd-df9ccd14f552' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "5d5b33de-3762-4652-90cd-df9ccd14f552", - "folderType": "exporter", - "databaseKey": "MI_Training" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '5d5b33de-3762-4652-90cd-df9ccd14f552', but there is no Exporter folder with that GUID.", - "value": { - "message": "Cannot move Exporter file with GUID 'ccfb44a6-d5a3-4c43-bf9f-258671eb636c'.", - "code": "fileMove", - "fileGuid": "ccfb44a6-d5a3-4c43-bf9f-258671eb636c", - "folderType": "exporter", - "errors": [ - { - "message": "A Exporter folder with GUID '5d5b33de-3762-4652-90cd-df9ccd14f552' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "5d5b33de-3762-4652-90cd-df9ccd14f552", - "folderType": "exporter", - "databaseKey": "MI_Training" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Profile not found" } } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:descendants": { - "get": { + }, + "delete": { "tags": [ - "Schema - Exporters" + "Schema - Profiles" ], - "summary": "Returns file information for all descendants of an Exporter folder.", - "operationId": "GetExporterDescendants", + "summary": "Delete a profile", + "operationId": "DeleteProfile", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", + "name": "profile-guid", "in": "path", "required": true, "schema": { @@ -53968,84 +45369,36 @@ ], "responses": { "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - } - } + "description": "Ok" + }, + "400": { + "description": "Bad request. Profile is set as default." + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Profile not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions": { + "/v1alpha/profiles/{profile-guid}/profile-tables": { "get": { "tags": [ - "Schema - Expressions" + "Schema - ProfileTables" ], - "summary": "Get all expressions for table", - "operationId": "GetExpressions", + "summary": "Get all profile tables of given profile", + "operationId": "GetProfileTables", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", + "name": "profile-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { @@ -54054,59 +45407,50 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExpressionsInfo" + "$ref": "#/components/schemas/GsaProfileTablesInfo" }, - "examples": { - "Example 1": { - "summary": "Get all expressions", - "description": "This example demonstrates the response to getting all expressions from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "expressions": [ - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ] + "example": { + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" } - } + ] } } } }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or table not found" + "description": "Profile not found" } } }, "post": { "tags": [ - "Schema - Expressions" + "Schema - ProfileTables" ], - "summary": "Create a new expression.", - "operationId": "CreateExpression", + "summary": "Create a new profile table", + "operationId": "CreateProfileTable", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", + "name": "profile-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } @@ -54115,140 +45459,140 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaCreateProfileTable" }, "examples": { "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" } }, "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "a3714c19-91d1-44fe-b3c0-ad068186054f" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "dccbb44c-f13c-4f86-b155-796a778f23ea" } }, "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "name": "Simple expression with specified unit" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "43874a6a-48fb-4628-aa2b-6af94de71689" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaCreateProfileTable" }, "examples": { "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" } }, "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "a3714c19-91d1-44fe-b3c0-ad068186054f" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "dccbb44c-f13c-4f86-b155-796a778f23ea" } }, "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "name": "Simple expression with specified unit" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "43874a6a-48fb-4628-aa2b-6af94de71689" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaCreateProfileTable" }, "examples": { "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" } }, "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "a3714c19-91d1-44fe-b3c0-ad068186054f" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "dccbb44c-f13c-4f86-b155-796a778f23ea" } }, "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "name": "Simple expression with specified unit" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "43874a6a-48fb-4628-aa2b-6af94de71689" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaCreateProfileTable" }, "examples": { "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" } }, "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "a3714c19-91d1-44fe-b3c0-ad068186054f" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "dccbb44c-f13c-4f86-b155-796a778f23ea" } }, "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "name": "Simple expression with specified unit" + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "43874a6a-48fb-4628-aa2b-6af94de71689" } } } @@ -54261,88 +45605,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExpression" + "$ref": "#/components/schemas/GsaProfileTable" }, - "examples": { - "Example 2": { - "summary": "Get expression", - "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeDependencies": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Young's modulus", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue strength at 10^7 cycles", - "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Elongation", - "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - } - ], - "constantDependencies": [], - "parameterDependencies": [ - { - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "name": "Stress Ratio", - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - ], - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - } + "example": { + "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", + "subsetFallbackHint": "Metals", + "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", + "layoutFallbackHint": "Metals", + "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "Design Data" } } } @@ -54354,73 +45628,36 @@ "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Profile not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}": { + "/v1alpha/profiles/{profile-guid}/profile-tables/{profile-table-guid}": { "get": { "tags": [ - "Schema - Expressions" + "Schema - ProfileTables" ], - "summary": "Get an expression with a specified guid for a given database and table.", - "operationId": "GetExpression", + "summary": "Get individual profile table", + "operationId": "GetProfileTable", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", + "name": "profile-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "expression-guid", + "name": "profile-table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { @@ -54429,128 +45666,48 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExpression" + "$ref": "#/components/schemas/GsaProfileTable" }, - "examples": { - "Example 1": { - "summary": "Get expression", - "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeDependencies": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Young's modulus", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue strength at 10^7 cycles", - "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Elongation", - "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - } - ], - "constantDependencies": [], - "parameterDependencies": [ - { - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "name": "Stress Ratio", - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - ], - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - } + "example": { + "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", + "subsetFallbackHint": "Metals", + "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", + "layoutFallbackHint": "Metals", + "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "Design Data" } } } }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table or expression not found" + "description": "Profile or profile table not found" } } }, "patch": { "tags": [ - "Schema - Expressions" + "Schema - ProfileTables" ], - "summary": "Update an expression.", - "operationId": "UpdateExpression", + "summary": "Update a profile table", + "operationId": "UpdateProfileTable", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", + "name": "profile-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "expression-guid", + "name": "profile-table-guid", "in": "path", "required": true, "schema": { @@ -54563,104 +45720,124 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaUpdateProfileTable" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "ab88edde-6ec4-4e8b-b01f-5c1b78caa212" + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "dc9fbddd-34e8-4830-b412-586d98ada997" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "Fatigue Model (Updated)" + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "310a539f-97e6-4dfd-a077-c9bfb8ab1fd1" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaUpdateProfileTable" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "ab88edde-6ec4-4e8b-b01f-5c1b78caa212" + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "dc9fbddd-34e8-4830-b412-586d98ada997" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "Fatigue Model (Updated)" + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "310a539f-97e6-4dfd-a077-c9bfb8ab1fd1" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaUpdateProfileTable" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "ab88edde-6ec4-4e8b-b01f-5c1b78caa212" + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "dc9fbddd-34e8-4830-b412-586d98ada997" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "Fatigue Model (Updated)" + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "310a539f-97e6-4dfd-a077-c9bfb8ab1fd1" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaUpdateProfileTable" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "ab88edde-6ec4-4e8b-b01f-5c1b78caa212" + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "dc9fbddd-34e8-4830-b412-586d98ada997" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "Fatigue Model (Updated)" + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "310a539f-97e6-4dfd-a077-c9bfb8ab1fd1" } } } @@ -54673,88 +45850,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExpression" + "$ref": "#/components/schemas/GsaProfileTable" }, - "examples": { - "Example 3": { - "summary": "Get expression", - "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeDependencies": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Young's modulus", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue strength at 10^7 cycles", - "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Elongation", - "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - } - ], - "constantDependencies": [], - "parameterDependencies": [ - { - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "name": "Stress Ratio", - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - ], - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - } + "example": { + "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", + "subsetFallbackHint": "Metals", + "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", + "layoutFallbackHint": "Metals", + "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "Design Data" } } } @@ -54766,41 +45873,28 @@ "description": "Forbidden" }, "404": { - "description": "Database, table or expression not found" + "description": "Profile or profile table not found" } } }, "delete": { "tags": [ - "Schema - Expressions" + "Schema - ProfileTables" ], - "summary": "Delete an expression.", - "operationId": "DeleteExpression", + "summary": "Delete a profile table", + "operationId": "DeleteProfileTable", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", + "name": "profile-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "expression-guid", + "name": "profile-table-guid", "in": "path", "required": true, "schema": { @@ -54813,55 +45907,62 @@ "200": { "description": "Ok" }, - "400": { - "description": "Bad request" - }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or expression not found" + "description": "Profile or profile table not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}/permission-category-access-controls": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups": { "get": { "tags": [ - "Schema - Expressions" + "Schema - Record Link Groups" ], - "summary": "Get permission-based access control settings for a given expression.\r\nReturns the access control for each permission in each category.", - "operationId": "GetExpressionPermissionCategoryAccessControls", + "summary": "Get all record link groups pointing from this table.", + "operationId": "GetRecordLinkGroups", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "expression-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -54871,108 +45972,71 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaRecordLinkGroupsInfo" }, "example": { - "categoryAccessControls": [ + "recordLinkGroups": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] + "identity": 115, + "type": "static", + "reverseName": "Training Exercise", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "MaterialUniverse", + "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" }, { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" + "identity": 3, + "type": "dynamic", + "reverseName": "Smart Link to Training Record", + "reverseDisplayNames": { + "en": "en-Smart Link to Training Record", + "fr": "fr-Smart Link to Training Record" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "displayNames": { + "en": "en-Smart Link to MaterialUniverse", + "fr": "fr-Smart Link to MaterialUniverse" + }, + "name": "Smart Link to MaterialUniverse", + "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + }, + { + "identity": 1, + "type": "crossDatabase", + "reverseName": "Second Training Database And Table - MI Training Exercise for Import", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "MI Training Exercise for Import - Second Training Database And Table", + "guid": "8e248be7-3abf-4b4e-8c9d-09a054aa4540" } ] } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table or expression not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or table not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Expressions" + "Schema - Record Link Groups" ], - "summary": "Update permission-based access control settings for a given expression.\r\nSets the access control for the given permissions.", - "description": "\r\n\r\nCan also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation)", - "operationId": "UpdateExpressionPermissionCategoryAccessControls", + "summary": "Create a new record link group.", + "operationId": "CreateRecordLinkGroup", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "expression-guid", - "in": "path", "required": true, "schema": { "type": "string", @@ -54984,340 +46048,444 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "value": { + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" + } + }, + "Example 2": { + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "value": { + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "37324729-0b72-41b1-8d33-fae468c275a7" + } + }, + "Example 3": { + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "3027d81d-fca5-46b4-a0b1-c8f81eb56498" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" + } + }, + "Example 4": { + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "16a98393-4329-47a2-84f9-99a287f90eec", + "tableGuid": "1774acc3-7f1f-4d87-a6c3-af97d68a83c8" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "c6a0b3a6-7615-4aab-992f-b3829f235ca0" + } + }, + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", "value": { - "categoryAccessControls": [ + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } - ] + ], + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "categoryAccessControls": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } - ] + ], + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "0dce913b-e7c9-458b-9b59-edc0e772c8ed" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "value": { + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" + } + }, + "Example 2": { + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "value": { + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "37324729-0b72-41b1-8d33-fae468c275a7" + } + }, + "Example 3": { + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "3027d81d-fca5-46b4-a0b1-c8f81eb56498" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" + } + }, + "Example 4": { + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", "value": { - "categoryAccessControls": [ + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "16a98393-4329-47a2-84f9-99a287f90eec", + "tableGuid": "1774acc3-7f1f-4d87-a6c3-af97d68a83c8" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "c6a0b3a6-7615-4aab-992f-b3829f235ca0" + } + }, + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "value": { + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } - ] + ], + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "categoryAccessControls": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } - ] + ], + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "0dce913b-e7c9-458b-9b59-edc0e772c8ed" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "value": { + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" + } + }, + "Example 2": { + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "value": { + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "37324729-0b72-41b1-8d33-fae468c275a7" + } + }, + "Example 3": { + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "3027d81d-fca5-46b4-a0b1-c8f81eb56498" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" + } + }, + "Example 4": { + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "16a98393-4329-47a2-84f9-99a287f90eec", + "tableGuid": "1774acc3-7f1f-4d87-a6c3-af97d68a83c8" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "c6a0b3a6-7615-4aab-992f-b3829f235ca0" + } + }, + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", "value": { - "categoryAccessControls": [ + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } - ] + ], + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "categoryAccessControls": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } - ] + ], + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "0dce913b-e7c9-458b-9b59-edc0e772c8ed" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "value": { + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" + } + }, + "Example 2": { + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "value": { + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "37324729-0b72-41b1-8d33-fae468c275a7" + } + }, + "Example 3": { + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "3027d81d-fca5-46b4-a0b1-c8f81eb56498" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" + } + }, + "Example 4": { + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "16a98393-4329-47a2-84f9-99a287f90eec", + "tableGuid": "1774acc3-7f1f-4d87-a6c3-af97d68a83c8" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "c6a0b3a6-7615-4aab-992f-b3829f235ca0" + } + }, + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", "value": { - "categoryAccessControls": [ + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } - ] + ], + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "categoryAccessControls": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } - ] + ], + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "0dce913b-e7c9-458b-9b59-edc0e772c8ed" } } } @@ -55325,172 +46493,201 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true + "examples": { + "Example 4": { + "summary": "Static record link group", + "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", + "value": { + "type": "static", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "identity": 125, + "reverseName": "Fatigue Statistical Data", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Fatigue Test Data", + "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 17": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '6c83930f-69f0-45b8-90ea-8b8220961684', but the permission category does not exist.", + }, + "Example 5": { + "summary": "Cross database record link group", + "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID '6c83930f-69f0-45b8-90ea-8b8220961684' does not exist.", - "reason": "noSuchCategory", - "categoryGuid": "6c83930f-69f0-45b8-90ea-8b8220961684" + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "linkTarget": { + "databaseGuid": "36d7ece4-9b05-4e8a-9cd5-34fe1308f83a", + "tableGuid": "98fd2a3b-6de4-44f4-a707-6e3c31181a70" } - ] + }, + "identity": 1, + "reverseName": "MI Training - MaterialUniverse", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Different database - different table", + "guid": "67eeae7d-c5c0-4779-8af5-e6ee619bc283" } }, - "Example 18": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '8551abba-7961-485b-9a9c-8b34b625a2bc' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '8551abba-7961-485b-9a9c-8b34b625a2bc' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "reason": "noSuchPermission", - "permissionGuid": "8551abba-7961-485b-9a9c-8b34b625a2bc", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - ] - } - }, - "Example 19": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", + "Example 6": { + "summary": "Dynamic record link group", + "description": "This example demonstrates the returned value from getting a 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "reason": "duplicateCategoryGuids", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ] + "attributeSource": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + }, + "attributeTarget": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + } } - ] - } - }, - "Example 20": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "reason": "duplicatePermissionGuids", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ] + ], + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" } - ] + }, + "identity": 8, + "reverseName": "Further panel information", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Tensile test data", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or expression not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or table not found" } } } }, - "/v1alpha/standard-names": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}/{record-link-group-type}": { "get": { "tags": [ - "Schema - Global Standard Names" + "Schema - Record Link Groups" ], - "summary": "Gets all standard names from all databases, optionally filtered by the provided 'name' query parameter.", - "operationId": "GetGlobalStandardNames", + "summary": "Get individual record link group", + "operationId": "GetRecordLinkGroup", "parameters": [ { - "name": "name", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-link-group-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-link-group-type", + "in": "path", + "description": "The record link group type.", + "required": true, + "schema": { + "enum": [ + "static", + "dynamic", + "crossDatabase" + ], + "type": "string" + } + }, + { + "name": "mode", "in": "query", - "description": "Standard name to match. Optional.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { + "enum": [ + "read", + "write" + ], "type": "string" } } @@ -55501,423 +46698,486 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNamesInfo" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, - "example": { - "standardNames": [ - { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "0000013c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" + "examples": { + "Example 1": { + "summary": "Static record link group", + "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", + "value": { + "type": "static", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" } - ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Density", - "guid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd" - }, - { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + }, + "identity": 125, + "reverseName": "Fatigue Statistical Data", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Fatigue Test Data", + "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" + } + }, + "Example 2": { + "summary": "Cross database record link group", + "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "0° tension strength - normalized", - "guid": "5ec32efe-85d0-4ed2-8036-a8dea3f2127d" + "linkTarget": { + "databaseGuid": "e5233549-7ae6-4686-bba9-95f81239b9db", + "tableGuid": "77f85573-2fe1-4476-a057-1d1e4196c59c" } - ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + }, + "identity": 1, + "reverseName": "MI Training - MaterialUniverse", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Different database - different table", + "guid": "e6c2e655-9d08-4ac8-b6b2-928e7ad24135" } - ] - } - } - } - } - } - } - }, - "/v1alpha/standard-names:search": { - "post": { - "tags": [ - "Schema - Global Standard Names" - ], - "summary": "Find all standard names from all databases that match one of the names provided in the request.", - "operationId": "FindGlobalStandardNames", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardNamesInfo" - }, - "example": { - "standardNames": [ - { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "0000013c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" - }, + }, + "Example 3": { + "summary": "Dynamic record link group", + "description": "This example demonstrates the returned value from getting a 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", + "value": { + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" + "attributeSource": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" + "attributeTarget": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + } } ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Density", - "guid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd" - }, - { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "0° tension strength - normalized", - "guid": "5ec32efe-85d0-4ed2-8036-a8dea3f2127d" + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" } - ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + }, + "identity": 8, + "reverseName": "Further panel information", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Tensile test data", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" } - ] + } } } } + }, + "404": { + "description": "Database, table or record link group not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders": { - "get": { + }, + "delete": { "tags": [ - "Schema - Help Files" + "Schema - Record Link Groups" ], - "summary": "Get All Help File Folders", - "operationId": "GetHelpFolders", + "summary": "Delete a record link group.", + "operationId": "DeleteRecordLinkGroup", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + }, + { + "name": "record-link-group-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-link-group-type", + "in": "path", + "description": "The record link group type.", + "required": true, + "schema": { + "enum": [ + "static", + "dynamic", + "crossDatabase" + ], + "type": "string" } } ], "responses": { "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - }, - { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - }, - { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - }, - { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] - } - } - } + "description": "Ok" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, table or record link group not found" } } - }, - "post": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}": { + "patch": { "tags": [ - "Schema - Help Files" + "Schema - Record Link Groups" ], - "summary": "Create a new Help File Folder.", - "operationId": "CreateHelpFolder", + "summary": "Update record link group.", + "operationId": "UpdateRecordLinkGroup", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" - }, + }, + { + "name": "record-link-group-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" + }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "type": "static", + "guid": "01b65b08-f231-4161-8bf0-758cd62afb95" + } + }, + "Example 2": { + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" + } + }, + "Example 3": { + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "9fd99f8e-dbce-42d6-9023-6c082646b256" + } + }, + "Example 4": { + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "0f1ebab5-0ffb-49ed-bf01-fdea780a381f" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ + { + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + }, + { + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + } + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "d0d879a7-f7a9-4d9a-a195-9a9dc22cf4ff" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "type": "static", + "guid": "01b65b08-f231-4161-8bf0-758cd62afb95" + } + }, + "Example 2": { + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" + } + }, + "Example 3": { + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "9fd99f8e-dbce-42d6-9023-6c082646b256" + } + }, + "Example 4": { + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "0f1ebab5-0ffb-49ed-bf01-fdea780a381f" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ + { + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + }, + { + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + } + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "d0d879a7-f7a9-4d9a-a195-9a9dc22cf4ff" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "type": "static", + "guid": "01b65b08-f231-4161-8bf0-758cd62afb95" + } + }, + "Example 2": { + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" + } + }, + "Example 3": { + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "9fd99f8e-dbce-42d6-9023-6c082646b256" + } + }, + "Example 4": { + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "0f1ebab5-0ffb-49ed-bf01-fdea780a381f" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ + { + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + }, + { + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + } + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "d0d879a7-f7a9-4d9a-a195-9a9dc22cf4ff" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "type": "static", + "guid": "01b65b08-f231-4161-8bf0-758cd62afb95" + } + }, + "Example 2": { + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" + } + }, + "Example 3": { + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "9fd99f8e-dbce-42d6-9023-6c082646b256" + } + }, + "Example 4": { + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "0f1ebab5-0ffb-49ed-bf01-fdea780a381f" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ + { + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + }, + { + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + } + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "d0d879a7-f7a9-4d9a-a195-9a9dc22cf4ff" } } } @@ -55925,171 +47185,147 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage folder with name ''.", + "Example 7": { + "summary": "Static record link group", + "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", "value": { - "message": "Cannot create HelpPage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" + "type": "static", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" } - ] + }, + "identity": 125, + "reverseName": "Fatigue Statistical Data", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Fatigue Test Data", + "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" } }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage folder with name ''.", + "Example 8": { + "summary": "Cross database record link group", + "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", "value": { - "message": "Cannot create HelpPage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "linkTarget": { + "databaseGuid": "bf7c69c1-c830-4808-a13e-4e5f98e2e924", + "tableGuid": "e0f44f67-ea8e-4b6b-9776-90d5c1cdfc7b" } - ] + }, + "identity": 1, + "reverseName": "MI Training - MaterialUniverse", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Different database - different table", + "guid": "35a50fa6-58a4-4a43-8d8d-625c6e71b9df" } }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage folder with name ''.", + "Example 9": { + "summary": "Dynamic record link group", + "description": "This example demonstrates the returned value from getting a 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", "value": { - "message": "Cannot create HelpPage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "helpPage", - "errors": [ + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" + "attributeSource": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + }, + "attributeTarget": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + } } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" + ], + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + } + }, + "identity": 8, + "reverseName": "Further panel information", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Tensile test data", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, table or record link group not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders:root-folder": { + "/v1alpha/databases/{database-key}/replacement-strings": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Replacement Strings" ], - "summary": "Get Root Help File Folder", - "operationId": "GetHelpRootFolder", + "summary": "Get all replacement strings", + "operationId": "GetReplacementStrings", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which replacement strings will be searched for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -56097,37 +47333,17 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaReplacementStringsInfo" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "replacementStrings": [ + { + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" + } + ] } } } @@ -56136,105 +47352,222 @@ "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}": { - "get": { + }, + "post": { "tags": [ - "Schema - Help Files" + "Schema - Replacement Strings" ], - "summary": "Get Help File Folder", - "operationId": "GetHelpFolder", + "summary": "Create a new replacement string.", + "operationId": "CreateReplacementString", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", + "description": "Database in which replacement string will be created", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - } + "requestBody": { + "description": "Replacement string to add to database", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } }, - "example": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "2dec7ae2-56aa-412c-a0fa-36abc703942d" + } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" }, - "text/json": { + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } + }, + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "2dec7ae2-56aa-412c-a0fa-36abc703942d" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" + }, + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } + }, + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "2dec7ae2-56aa-412c-a0fa-36abc703942d" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" + }, + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } + }, + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "2dec7ae2-56aa-412c-a0fa-36abc703942d" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaReplacementString" }, "example": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or folder not found" + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/replacement-strings/{replacement-string-guid}": { + "get": { + "tags": [ + "Schema - Replacement Strings" + ], + "summary": "Get individual replacement string", + "operationId": "GetReplacementString", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which replacement string will be searched for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "replacement-string-guid", + "in": "path", + "description": "Guid of requested replacement string", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaReplacementString" + }, + "example": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" + } + } + } + }, + "404": { + "description": "Database or replacement string not found" } } }, "patch": { "tags": [ - "Schema - Help Files" + "Schema - Replacement Strings" ], - "summary": "Update an existing Help File Folder.", - "operationId": "UpdateHelpFolder", + "summary": "Update a replacement string.", + "operationId": "UpdateReplacementString", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which replacement string will be search for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "replacement-string-guid", "in": "path", + "description": "Guid of replacement string to update", "required": true, "schema": { "type": "string", @@ -56243,87 +47576,124 @@ } ], "requestBody": { + "description": "Replacement string data to be updated", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "db27f164-78c1-4385-84ae-4c8bd77201a5" } }, "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "value": { + "name": "New name for replacement string" + } + }, + "Example 3": { + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "guid": "a9894aea-eff3-4158-abce-9209f6e9224d" + "value": "New value for replacement string" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "db27f164-78c1-4385-84ae-4c8bd77201a5" } }, "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "value": { + "name": "New name for replacement string" + } + }, + "Example 3": { + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "guid": "a9894aea-eff3-4158-abce-9209f6e9224d" + "value": "New value for replacement string" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "db27f164-78c1-4385-84ae-4c8bd77201a5" } }, "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "value": { + "name": "New name for replacement string" + } + }, + "Example 3": { + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "guid": "a9894aea-eff3-4158-abce-9209f6e9224d" + "value": "New value for replacement string" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "New Folder Name" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "db27f164-78c1-4385-84ae-4c8bd77201a5" } }, "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "value": { + "name": "New name for replacement string" + } + }, + "Example 3": { + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "guid": "a9894aea-eff3-4158-abce-9209f6e9224d" + "value": "New value for replacement string" } } } @@ -56334,144 +47704,49 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaReplacementString" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HelpPage folder.", - "value": { - "message": "Cannot update HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderUpdate", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HelpPage folder.", - "value": { - "message": "Cannot update HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderUpdate", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HelpPage folder.", - "value": { - "message": "Cannot update HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderUpdate", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or replacement string not found" } } }, "delete": { "tags": [ - "Schema - Help Files" + "Schema - Replacement Strings" ], - "summary": "Delete a Help File Folder.", - "operationId": "DeleteHelpFolder", + "summary": "Delete a replacement string", + "operationId": "DeleteReplacementString", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which replacement string will be search for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "replacement-string-guid", "in": "path", + "description": "Guid of replacement string to delete", "required": true, "schema": { "type": "string", @@ -56480,118 +47755,32 @@ } ], "responses": { - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HelpPage folder.", - "value": { - "message": "Cannot delete HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderDeletion", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HelpPage folder.", - "value": { - "message": "Cannot delete HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderDeletion", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HelpPage folder.", - "value": { - "message": "Cannot delete HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderDeletion", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - } - } - }, "200": { "description": "Ok" }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database or folder not found" + "description": "Database or replacement string not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:child-folders": { + "/v1alpha/databases/{database-key}/standard-names": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Standard Names" ], - "summary": "Get Child Help File Folders", - "operationId": "GetHelpChildFolders", + "summary": "Gets all standard names for a given database.", + "operationId": "GetStandardNames", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -56599,109 +47788,31 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] + "$ref": "#/components/schemas/GsaStandardNamesInfo" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:move": { + }, "post": { "tags": [ - "Schema - Help Files" + "Schema - Standard Names" ], - "summary": "Move an existing Help File Folder.", - "operationId": "MoveHelpFolder", + "summary": "Create a new standard name", + "operationId": "CreateStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -56709,56 +47820,324 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateStandardName" }, "examples": { "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" - }, - "examples": { - "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + }, + "Example 2": { + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + }, + "Example 3": { + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "value": { + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" + } + }, + "Example 4": { + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "value": { + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "206f7d13-56a6-4b84-9f07-159be64ab383" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateStandardName" }, "examples": { "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" + } + }, + "Example 2": { + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "value": { + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" + } + }, + "Example 3": { + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "value": { + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" + } + }, + "Example 4": { + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "value": { + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "206f7d13-56a6-4b84-9f07-159be64ab383" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateStandardName" + }, + "examples": { + "Example 1": { + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" + } + }, + "Example 2": { + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "value": { + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" + } + }, + "Example 3": { + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "value": { + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" + } + }, + "Example 4": { + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "value": { + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "206f7d13-56a6-4b84-9f07-159be64ab383" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateStandardName" }, "examples": { "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" + } + }, + "Example 2": { + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "value": { + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" + } + }, + "Example 3": { + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "value": { + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" + } + }, + "Example 4": { + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "value": { + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "206f7d13-56a6-4b84-9f07-159be64ab383" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" } } } @@ -56766,148 +48145,46 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "$ref": "#/components/schemas/GsaStandardName" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HelpPage folder.", - "value": { - "message": "Cannot move HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderMove", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HelpPage folder.", - "value": { - "message": "Cannot move HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderMove", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HelpPage folder.", - "value": { - "message": "Cannot move HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderMove", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files": { + "/v1alpha/databases/{database-key}/standard-names/{standard-name-guid}": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Standard Names" ], - "summary": "Get Files in a Folder", - "operationId": "GetHelpFiles", + "summary": "Gets a standard name for a given database and guid.", + "operationId": "GetStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "standard-name-guid", "in": "path", "required": true, "schema": { @@ -56920,84 +48197,35 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - }, - { - "name": "Atomic_volume.html", - "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - }, - { - "name": "Atomic_volume.html", - "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - }, - { - "name": "Atomic_volume.html", - "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" - } - ] + "$ref": "#/components/schemas/GsaStandardName" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database or standard name not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - Help Files" + "Schema - Standard Names" ], - "summary": "Create a new Help File.", - "operationId": "CreateHelpFile", + "summary": "Edit a standard name", + "operationId": "UpdateStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "standard-name-guid", "in": "path", "required": true, "schema": { @@ -57008,284 +48236,376 @@ ], "requestBody": { "content": { - "multipart/form-data": { + "application/json-patch+json": { "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" - } - } + "$ref": "#/components/schemas/GsaUpdateStandardName" }, - "encoding": { - "file": { - "style": "form" + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "name": "Density (Updated)" + } }, - "description": { - "style": "form" - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "guid": "742ddd66-93be-478e-aa2a-6f6c42564708" + } }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "d8fdb688-f06c-4095-9f1c-eedca90cce95" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] + } }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "d8fdb688-f06c-4095-9f1c-eedca90cce95" + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] + } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateStandardName" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "name": "Density (Updated)" + } }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "d8fdb688-f06c-4095-9f1c-eedca90cce95" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "guid": "742ddd66-93be-478e-aa2a-6f6c42564708" + } }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage file with name ''.", - "value": { - "message": "Cannot create HelpPage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] + } + }, + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] } } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateStandardName" }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "name": "Density (Updated)" + } }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage file with name ''.", - "value": { - "message": "Cannot create HelpPage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "guid": "742ddd66-93be-478e-aa2a-6f6c42564708" + } + }, + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] + } + }, + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] } } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateStandardName" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "examples": { + "Example 1": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "name": "Density (Updated)" + } }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage file with name ''.", - "value": { - "message": "Cannot create HelpPage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "guid": "742ddd66-93be-478e-aa2a-6f6c42564708" + } + }, + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] } + }, + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaStandardName" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database or standard name not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}": { - "get": { + }, + "delete": { "tags": [ - "Schema - Help Files" + "Schema - Standard Names" ], - "summary": "Get header information for a help file", - "operationId": "GetHelpFile", + "summary": "Delete a standard name.", + "operationId": "DeleteStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "standard-name-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database or standard name not found." + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets": { + "get": { + "tags": [ + "Schema - Subsets" + ], + "summary": "Get all subsets for table", + "operationId": "GetSubsets", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "file-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", - "description": "Description of Abrasion-rate file.", - "extension": "html", - "dataLength": 5090, - "path": "Help Pages\\html\\attributenotes\\en\\material", - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", - "description": "Description of Abrasion-rate file.", - "extension": "html", - "dataLength": 5090, - "path": "Help Pages\\html\\attributenotes\\en\\material", - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaSubsetsInfo" }, "example": { - "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", - "description": "Description of Abrasion-rate file.", - "extension": "html", - "dataLength": 5090, - "path": "Help Pages\\html\\attributenotes\\en\\material", - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + "subsets": [ + { + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": {}, + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": {}, + "name": "Polymers", + "guid": "00007645-0010-4fff-8fff-dd92ffff0000" + } + ] } } } }, "404": { - "description": "Database, folder or file not found" + "description": "Database or table not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Help Files" + "Schema - Subsets" ], - "summary": "Update an existing Help File.", - "operationId": "UpdateHelpFile", + "summary": "Create a new subset.", + "operationId": "CreateSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "file-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -57298,112 +48618,128 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New File Name" + "name": "Alloys" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "description": "New description for help file." + "name": "Alloys (guid)", + "guid": "76c68dec-7baf-49d4-b484-5eb477a2faba" } }, "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "guid": "b9df9901-3365-400e-afca-58cf42829b7d" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New File Name" + "name": "Alloys" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "description": "New description for help file." + "name": "Alloys (guid)", + "guid": "76c68dec-7baf-49d4-b484-5eb477a2faba" } }, "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "guid": "b9df9901-3365-400e-afca-58cf42829b7d" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New File Name" + "name": "Alloys" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "description": "New description for help file." + "name": "Alloys (guid)", + "guid": "76c68dec-7baf-49d4-b484-5eb477a2faba" } }, "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "guid": "b9df9901-3365-400e-afca-58cf42829b7d" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "New File Name" + "name": "Alloys" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "description": "New description for help file." + "name": "Alloys (guid)", + "guid": "76c68dec-7baf-49d4-b484-5eb477a2faba" } }, "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "guid": "b9df9901-3365-400e-afca-58cf42829b7d" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } @@ -57411,271 +48747,93 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "dd8f27ad-c82b-4195-a573-ad34e675c5e6" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "dd8f27ad-c82b-4195-a573-ad34e675c5e6" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaSubset" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "dd8f27ad-c82b-4195-a573-ad34e675c5e6" + "associatedLayout": { + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "displayNames": {}, + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid FIle name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HelpPage file to ''.", - "value": { - "message": "Cannot update HelpPage file with GUID '411bc5f9-663d-47f7-b197-bd03aa5018cc'.", - "code": "fileUpdate", - "fileGuid": "411bc5f9-663d-47f7-b197-bd03aa5018cc", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid FIle name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HelpPage file to ''.", - "value": { - "message": "Cannot update HelpPage file with GUID '411bc5f9-663d-47f7-b197-bd03aa5018cc'.", - "code": "fileUpdate", - "fileGuid": "411bc5f9-663d-47f7-b197-bd03aa5018cc", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid FIle name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HelpPage file to ''.", - "value": { - "message": "Cannot update HelpPage file with GUID '411bc5f9-663d-47f7-b197-bd03aa5018cc'.", - "code": "fileUpdate", - "fileGuid": "411bc5f9-663d-47f7-b197-bd03aa5018cc", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, folder or file not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Help Files" - ], - "summary": "Delete a Help File.", - "operationId": "DeleteHelpFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:export": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Subsets" ], - "summary": "Get help folder and contents as a zip file", - "operationId": "ExportHelpFolder", + "summary": "Get a subset with a specified guid for a given database and table.", + "operationId": "GetSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:export": { - "get": { - "tags": [ - "Schema - Help Files" - ], - "summary": "Get help file as a file", - "operationId": "ExportHelpFile", - "parameters": [ { - "name": "database-key", + "name": "subset-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "file-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -57683,42 +48841,51 @@ "200": { "description": "Ok", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaSubset" + }, + "example": { + "associatedLayout": { + "displayNames": { + "en": "Ceramics Layout English Display Name", + "fr": "Ceramics Layout French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" } } - }, - "x-is-file": true + } }, "404": { - "description": "Database, folder or file not found" + "description": "Database, table or subset not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:move": { - "post": { + }, + "patch": { "tags": [ - "Schema - Help Files" + "Schema - Subsets" ], - "summary": "Move an existing Help File.", - "operationId": "MoveHelpFile", + "summary": "Update a subset.", + "operationId": "UpdateSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -57727,7 +48894,7 @@ } }, { - "name": "file-guid", + "name": "subset-guid", "in": "path", "required": true, "schema": { @@ -57740,56 +48907,164 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "f3d9a075-210d-418a-8a55-0320fdab7d4b" + } + }, + "Example 2": { + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } + } + }, + "Example 4": { + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": null } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "f3d9a075-210d-418a-8a55-0320fdab7d4b" + } + }, + "Example 2": { + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } + } + }, + "Example 4": { + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": null } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "f3d9a075-210d-418a-8a55-0320fdab7d4b" + } + }, + "Example 2": { + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } + } + }, + "Example 4": { + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": null } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "f3d9a075-210d-418a-8a55-0320fdab7d4b" + } + }, + "Example 2": { + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Ceramics (Updated)" + } + }, + "Example 3": { + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } + } + }, + "Example 4": { + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "associatedLayout": null } } } @@ -57800,361 +49075,269 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5dfbd06d-3577-4f3b-afbb-bc2ece831495" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5dfbd06d-3577-4f3b-afbb-bc2ece831495" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaSubset" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5dfbd06d-3577-4f3b-afbb-bc2ece831495" + "associatedLayout": { + "displayNames": { + "en": "Ceramics Layout English Display Name", + "fr": "Ceramics Layout French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '6bbd7e19-3e51-46d8-be03-3da797698f41', but there is no HelpPage folder with that GUID.", - "value": { - "message": "Cannot move HelpPage file with GUID 'dbcba947-f2c9-4656-9cea-c50cbc3f105e'.", - "code": "fileMove", - "fileGuid": "dbcba947-f2c9-4656-9cea-c50cbc3f105e", - "folderType": "helpPage", - "errors": [ - { - "message": "A HelpPage folder with GUID '6bbd7e19-3e51-46d8-be03-3da797698f41' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "6bbd7e19-3e51-46d8-be03-3da797698f41", - "folderType": "helpPage", - "databaseKey": "MI_Training" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '6bbd7e19-3e51-46d8-be03-3da797698f41', but there is no HelpPage folder with that GUID.", - "value": { - "message": "Cannot move HelpPage file with GUID 'dbcba947-f2c9-4656-9cea-c50cbc3f105e'.", - "code": "fileMove", - "fileGuid": "dbcba947-f2c9-4656-9cea-c50cbc3f105e", - "folderType": "helpPage", - "errors": [ - { - "message": "A HelpPage folder with GUID '6bbd7e19-3e51-46d8-be03-3da797698f41' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "6bbd7e19-3e51-46d8-be03-3da797698f41", - "folderType": "helpPage", - "databaseKey": "MI_Training" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '6bbd7e19-3e51-46d8-be03-3da797698f41', but there is no HelpPage folder with that GUID.", - "value": { - "message": "Cannot move HelpPage file with GUID 'dbcba947-f2c9-4656-9cea-c50cbc3f105e'.", - "code": "fileMove", - "fileGuid": "dbcba947-f2c9-4656-9cea-c50cbc3f105e", - "folderType": "helpPage", - "errors": [ - { - "message": "A HelpPage folder with GUID '6bbd7e19-3e51-46d8-be03-3da797698f41' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "6bbd7e19-3e51-46d8-be03-3da797698f41", - "folderType": "helpPage", - "databaseKey": "MI_Training" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Database, table or subset not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:descendants": { - "get": { + }, + "delete": { "tags": [ - "Schema - Help Files" + "Schema - Subsets" ], - "summary": "Returns file information for all descendants of a Help File folder.", - "operationId": "GetHelpFileDescendants", + "summary": "Delete a subset.", + "operationId": "DeleteSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - } - } }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/help-folders:validate": { - "post": { - "tags": [ - "Schema - Help Files" - ], - "summary": "Verify that help pages exist for all attributes and parameters that have help paths defined.\r\nReturns schema entity and help path if the help path does not match an existing help page.", - "operationId": "ValidateHelpPaths", - "parameters": [ { - "name": "database-key", + "name": "subset-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaHelpPathsValidationResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaHelpPathsValidationResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaHelpPathsValidationResponse" - } - } - } + "description": "Ok" + }, + "400": { + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, table or subset not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:add-to-subset": { + "post": { "tags": [ - "Schema - Home Pages" + "Schema - Subsets" ], - "summary": "Get All Home Page Folders", - "operationId": "GetHomePageFolders", + "summary": "Add a record history to a subset.", + "operationId": "AddToSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "subset-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - }, - { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "46652066-8386-4248-b948-a8016aaabab2" - } - ] - } + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false + } }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - }, - { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "46652066-8386-4248-b948-a8016aaabab2" - } - ] + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true + } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false + } }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - }, - { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "46652066-8386-4248-b948-a8016aaabab2" - } - ] + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + }, + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false + } + }, + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + }, + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false + } + }, + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true + } } } } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, table or subset not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:remove-from-subset": { "post": { "tags": [ - "Schema - Home Pages" + "Schema - Subsets" ], - "summary": "Create a new Home Page Folder.", - "operationId": "CreateHomePageFolder", + "summary": "Remove a record history, and all of its descendants, from a subset.", + "operationId": "RemoveFromSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "subset-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -58162,60 +49345,56 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" } } } @@ -58223,245 +49402,59 @@ } }, "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - } - } + "200": { + "description": "OK" }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage folder with name ''.", - "value": { - "message": "Cannot create HomePage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage folder with name ''.", - "value": { - "message": "Cannot create HomePage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage folder with name ''.", - "value": { - "message": "Cannot create HomePage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, table or subset not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders:root-folder": { + "/v1alpha/databases/{database-key}/tables": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Get Root Home Page Folder", - "operationId": "GetHomePageRootFolder", + "summary": "Get all tables", + "operationId": "GetTables", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - } - } + "type": "string" } }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}": { - "get": { - "tags": [ - "Schema - Home Pages" - ], - "summary": "Get Home Page Folder", - "operationId": "GetHomePageFolder", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "folder-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -58469,74 +49462,61 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "2bba5f94-027a-412f-9b13-aa4800478551" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "2bba5f94-027a-412f-9b13-aa4800478551" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaTablesInfo" }, "example": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "2bba5f94-027a-412f-9b13-aa4800478551" + "tables": [ + { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "tableTypes": [ + "Universe", + "Material" + ], + "displayNames": { + "en": "MaterialUniverse English Display Name", + "fr": "MaterialUniverse French Display Name" + }, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "tableTypes": [ + "Design" + ], + "displayNames": {}, + "name": "Design Data", + "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" + } + ] } } } }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Update an existing Home Page Folder.", - "operationId": "UpdateHomePageFolder", + "summary": "Create a new table.", + "operationId": "CreateTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -58544,84 +49524,140 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaCreateTable" }, "examples": { "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", "value": { - "name": "New Folder Name" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" } }, "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "2fd40e53-4a7d-46f9-a827-14b5da001eec" + } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", "value": { - "guid": "abcd4a87-dff0-450a-846b-c4c0128f87d3" + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaCreateTable" }, "examples": { "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", "value": { - "name": "New Folder Name" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" } }, "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "2fd40e53-4a7d-46f9-a827-14b5da001eec" + } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", "value": { - "guid": "abcd4a87-dff0-450a-846b-c4c0128f87d3" + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaCreateTable" }, "examples": { "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", "value": { - "name": "New Folder Name" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" } }, "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "guid": "abcd4a87-dff0-450a-846b-c4c0128f87d3" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "2fd40e53-4a7d-46f9-a827-14b5da001eec" } - } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "value": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaCreateTable" }, "examples": { "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", "value": { - "name": "New Folder Name" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" } }, "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "2fd40e53-4a7d-46f9-a827-14b5da001eec" + } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", "value": { - "guid": "abcd4a87-dff0-450a-846b-c4c0128f87d3" + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" } } } @@ -58629,117 +49665,28 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaTable" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "versionState": "unversioned", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "tableTypes": [], + "displayNames": {}, + "name": "Material Universe", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HomePage folder.", - "value": { - "message": "Cannot update HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderUpdate", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HomePage folder.", - "value": { - "message": "Cannot update HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderUpdate", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HomePage folder.", - "value": { - "message": "Cannot update HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderUpdate", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" @@ -58748,148 +49695,55 @@ "description": "Database not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}": { + "get": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Delete a Home Page Folder.", - "operationId": "DeleteHomePageFolder", + "summary": "Get a table with a specified guid for a given database.", + "operationId": "GetTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HomePage folder.", - "value": { - "message": "Cannot delete HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderDeletion", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HomePage folder.", - "value": { - "message": "Cannot delete HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderDeletion", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HomePage folder.", - "value": { - "message": "Cannot delete HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderDeletion", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:child-folders": { - "get": { - "tags": [ - "Schema - Home Pages" - ], - "summary": "Get Child Home Page Folders", - "operationId": "GetHomePageChildFolders", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "folder-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -58897,83 +49751,111 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "c1b4f02f-660b-477b-98fb-aaa7910bab86" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "$ref": "#/components/schemas/GsaTable" }, "example": { - "folders": [ + "defaultSubset": { + "name": "All bulk materials", + "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" + }, + "subsets": [ { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "c1b4f02f-660b-477b-98fb-aaa7910bab86" + "name": "Aerospace materials", + "guid": "0000fc72-0010-4fff-8fff-dd92ffff0000" + }, + { + "name": "All bulk materials", + "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" + }, + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + }, + { + "name": "Polymers", + "guid": "00007645-0010-4fff-8fff-dd92ffff0000" } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ + ], + "defaultLayout": { + "name": "All Attributes", + "guid": "384f9abe-0581-434d-a976-86952282207a" + }, + "layouts": [ { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "c1b4f02f-660b-477b-98fb-aaa7910bab86" + "name": "Aerospace materials", + "guid": "0000fc72-0009-4fff-8fff-dd92ffff0000" + }, + { + "name": "All Attributes", + "guid": "384f9abe-0581-434d-a976-86952282207a" + }, + { + "name": "All bulk materials", + "guid": "0000b1c5-0009-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + { + "name": "Metals", + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + { + "name": "Polymers", + "guid": "00007645-0009-4fff-8fff-dd92ffff0000" } - ] + ], + "versionState": "unversioned", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "displayNames": { + "en": "MaterialUniverse English Display Name", + "fr": "MaterialUniverse French Display Name" + }, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database or table not found" } } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:move": { - "post": { + }, + "patch": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Move an existing Home Page Folder.", - "operationId": "MoveHomePageFolder", + "summary": "Update a table.", + "operationId": "UpdateTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -58986,58 +49868,246 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateTable" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aebb45c7-78dc-4323-8a18-76f3e177c7ff" + } + }, + "Example 2": { + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": null + } + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": null } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateTable" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aebb45c7-78dc-4323-8a18-76f3e177c7ff" + } + }, + "Example 2": { + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": null + } + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": null } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateTable" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aebb45c7-78dc-4323-8a18-76f3e177c7ff" + } + }, + "Example 2": { + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": null + } + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": null } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateTable" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" - } - } + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aebb45c7-78dc-4323-8a18-76f3e177c7ff" + } + }, + "Example 2": { + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": null + } + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": null + } + } } } } @@ -59046,145 +50116,69 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaTable" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HomePage folder.", - "value": { - "message": "Cannot move HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderMove", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HomePage folder.", - "value": { - "message": "Cannot move HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderMove", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] + "defaultSubset": { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + }, + "subsets": [ + { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HomePage folder.", - "value": { - "message": "Cannot move HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderMove", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] + ], + "defaultLayout": { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + }, + "layouts": [ + { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" } - } + ], + "versionState": "unreleased", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database or table not found" } } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files": { - "get": { + }, + "delete": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Get the Home Page Files in a Folder", - "operationId": "GetHomePageFiles", + "summary": "Delete a table.", + "operationId": "DeleteTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -59194,87 +50188,68 @@ } ], "responses": { - "200": { - "description": "Ok", + "400": { + "description": "Bad request. Table in use.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "home-page-1.html", - "guid": "331360d4-0f8f-4d3f-89ad-5b6fcd599927" - }, - { - "name": "home-page-2.html", - "guid": "5ce1927c-194a-4265-af9e-fc796a1076ae" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "home-page-1.html", - "guid": "331360d4-0f8f-4d3f-89ad-5b6fcd599927" - }, - { - "name": "home-page-2.html", - "guid": "5ce1927c-194a-4265-af9e-fc796a1076ae" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" + "$ref": "#/components/schemas/GsaTableDeletionException" }, "example": { - "files": [ - { - "name": "home-page-1.html", - "guid": "331360d4-0f8f-4d3f-89ad-5b6fcd599927" - }, + "message": "Cannot delete table 'Restricted Substances' (GUID = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f').", + "code": 400, + "errors": [ { - "name": "home-page-2.html", - "guid": "5ce1927c-194a-4265-af9e-fc796a1076ae" + "message": "It is being used in one or more tabular attributes.", + "reason": "usage", + "referencedByType": "tabularAttribute", + "referencedBy": [ + { + "type": "tabular", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ] } ] } } } }, + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden." + }, "404": { - "description": "Database or folder not found" + "description": "Database or table not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}:release": { "post": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Create a new Home Page File.", - "operationId": "CreateHomePageFile", + "summary": "Releases the table. Table must be version-controlled and unreleased.", + "operationId": "ReleaseTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -59283,149 +50258,77 @@ } } ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" - } - } - }, - "encoding": { - "file": { - "style": "form" - }, - "description": { - "style": "form" - } - } - } - } - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "16428dad-ae9c-4323-8f6d-c5c278ba1176" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "16428dad-ae9c-4323-8f6d-c5c278ba1176" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaTable" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "16428dad-ae9c-4323-8f6d-c5c278ba1176" + "defaultSubset": { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + }, + "subsets": [ + { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + } + ], + "defaultLayout": { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + }, + "layouts": [ + { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + } + ], + "versionState": "released", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" } } } }, "400": { - "description": "Bad request", + "description": "Bad request. Table is not unreleased, or table is not version controlled.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage file with name ''.", - "value": { - "message": "Cannot create HomePage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "$ref": "#/components/schemas/GsaReleaseTableVersionControlException" }, "examples": { "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage file with name ''.", + "summary": "Invalid version state.", + "description": "A table can only be released if it is currently unreleased.", "value": { - "message": "Cannot create HomePage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "homePage", + "message": "Cannot release table with GUID 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'.", + "code": 400, "errors": [ { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" + "message": "Invalid version state 'Released'.", + "reason": "invalidVersionState", + "versionState": "released" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage file with name ''.", + }, + "Example 2": { + "summary": "Table is not version controlled.", "value": { - "message": "Cannot create HomePage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "homePage", + "message": "Cannot release table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "code": 400, "errors": [ { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" + "message": "Table is not version controlled.", + "reason": "notVersioned" } ] } @@ -59438,41 +50341,29 @@ "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}:enable-version-control": { + "post": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Get the header information for a Home Page File", - "operationId": "GetHomePageFile", + "summary": "Enable version control on the table. This cannot be undone.\r\nAfter this method has been called all records and data in the table are in an unreleased state.\r\nThis means that read users will not be able to see any records unless they are subsequently released.", + "operationId": "EnableVersionControl", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "file-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -59485,75 +50376,71 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "description": "Description of home page file.", - "extension": "html", - "dataLength": 12895, - "path": "HomePages", - "name": "home-page.html", - "guid": "1baeacca-31db-4c54-942d-494aaef9fb5e" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "description": "Description of home page file.", - "extension": "html", - "dataLength": 12895, - "path": "HomePages", - "name": "home-page.html", - "guid": "1baeacca-31db-4c54-942d-494aaef9fb5e" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaTable" }, "example": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "description": "Description of home page file.", - "extension": "html", - "dataLength": 12895, - "path": "HomePages", - "name": "home-page.html", - "guid": "1baeacca-31db-4c54-942d-494aaef9fb5e" + "defaultSubset": { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + }, + "subsets": [ + { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + } + ], + "defaultLayout": { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + }, + "layouts": [ + { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + } + ], + "versionState": "unreleased", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" } } } }, + "400": { + "description": "Bad request. Table is already versioned." + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, folder or file not found" + "description": "Database or table not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}:inbound-links": { + "post": { "tags": [ - "Schema - Home Pages" + "Schema - Tables" ], - "summary": "Update an existing Home Page File.", - "operationId": "UpdateHomePageFile", + "summary": "Get all record link groups and tabular attributes pointing towards the table.", + "operationId": "GetInboundLinks", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -59562,125 +50449,399 @@ } }, { - "name": "file-guid", - "in": "path", - "required": true, + "name": "type", + "in": "query", + "description": "The link types to include in the response. If not provided, all link types are included.", "schema": { - "type": "string", - "format": "uuid" + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaLinkAttributeType" + } + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaLinksInfo" + }, + "example": { + "links": [ + { + "identity": 115, + "type": "recordLink", + "reverseName": "Training Exercise", + "reverseDisplayNames": {}, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } + }, + "displayNames": {}, + "name": "MaterialUniverse", + "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + }, + { + "identity": 3, + "type": "dynamicLink", + "reverseName": "Smart Link to Training Record", + "reverseDisplayNames": { + "en": "en-Smart Link to Training Record", + "fr": "fr-Smart Link to Training Record" + }, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } + }, + "displayNames": { + "en": "en-Smart Link to MaterialUniverse", + "fr": "fr-Smart Link to MaterialUniverse" + }, + "name": "Smart Link to MaterialUniverse", + "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + }, + { + "identity": 1, + "type": "crossDatabaseLink", + "reverseName": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", + "reverseDisplayNames": {}, + "linkInfo": { + "linkSource": { + "databaseGuid": "8d180ab0-1186-4a15-bae1-1a06dd3890a9", + "databaseVersionGuid": "eed1bfe0-ebb6-4c81-84a4-69235e4ba5ce", + "tableGuid": "a970b892-0098-48d4-b9c2-29d80c9ed7f1" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } + }, + "displayNames": {}, + "name": "Cross database link group : Second Training Database And Table - MI Training MaterialUniverse", + "guid": "733989fa-150e-4dcd-9f53-736b1de03526" + }, + { + "identity": 8944, + "type": "tabularAttribute", + "reverseName": "Environmental performances overview", + "reverseDisplayNames": {}, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } + }, + "displayNames": {}, + "name": "Environmental performances overview", + "guid": "2523a67a-6246-4c9e-8583-15b64d6290e5" + } + ] + } + } + } + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables:query": { + "post": { + "tags": [ + "Schema - Tables" + ], + "summary": "Gets tables for a given database, populates the requested properties.", + "operationId": "QueryTables", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryTablesRequest" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Fetch all tables with custom properties", "value": { - "name": "New File Name" + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true + }, + "defaultLayout": { + "name": true, + "guid": true + }, + "subsets": { + "name": true, + "guid": true + }, + "defaultSubset": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Fetch table with name \"MaterialUniverse\"", "value": { - "guid": "9be96999-2d0e-4927-a0fb-26956e7fcdcd" + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaQueryTablesRequest" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Fetch all tables with custom properties", "value": { - "name": "New File Name" + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true + }, + "defaultLayout": { + "name": true, + "guid": true + }, + "subsets": { + "name": true, + "guid": true + }, + "defaultSubset": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Fetch table with name \"MaterialUniverse\"", "value": { - "guid": "9be96999-2d0e-4927-a0fb-26956e7fcdcd" + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaQueryTablesRequest" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Fetch all tables with custom properties", "value": { - "name": "New File Name" + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true + }, + "defaultLayout": { + "name": true, + "guid": true + }, + "subsets": { + "name": true, + "guid": true + }, + "defaultSubset": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Fetch table with name \"MaterialUniverse\"", "value": { - "guid": "9be96999-2d0e-4927-a0fb-26956e7fcdcd" + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaQueryTablesRequest" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Fetch all tables with custom properties", "value": { - "name": "New File Name" + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true + }, + "defaultLayout": { + "name": true, + "guid": true + }, + "subsets": { + "name": true, + "guid": true + }, + "defaultSubset": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Fetch table with name \"MaterialUniverse\"", "value": { - "guid": "9be96999-2d0e-4927-a0fb-26956e7fcdcd" + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } } } } @@ -59691,263 +50852,151 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "12def148-33ae-4455-80ac-7cb69da60bfd" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "12def148-33ae-4455-80ac-7cb69da60bfd" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "12def148-33ae-4455-80ac-7cb69da60bfd" + "$ref": "#/components/schemas/GsaQueryTablesInfo" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HomePage file to ''.", - "value": { - "message": "Cannot update HomePage file with GUID '19831af9-b1ea-4085-b2a8-fee3fdd20ec8'.", - "code": "fileUpdate", - "fileGuid": "19831af9-b1ea-4085-b2a8-fee3fdd20ec8", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HomePage file to ''.", - "value": { - "message": "Cannot update HomePage file with GUID '19831af9-b1ea-4085-b2a8-fee3fdd20ec8'.", - "code": "fileUpdate", - "fileGuid": "19831af9-b1ea-4085-b2a8-fee3fdd20ec8", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HomePage file to ''.", - "value": { - "message": "Cannot update HomePage file with GUID '19831af9-b1ea-4085-b2a8-fee3fdd20ec8'.", - "code": "fileUpdate", - "fileGuid": "19831af9-b1ea-4085-b2a8-fee3fdd20ec8", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "reason": "fileName", - "name": "" - } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, folder or file not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Home Pages" - ], - "summary": "Delete a Home Page File.", - "operationId": "DeleteHomePageFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" + "description": "Bad request" }, "404": { - "description": "Database, folder or file not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/unit-conversions": { + "post": { "tags": [ - "Schema - Home Pages" + "Schema - Units" ], - "summary": "Get Home Page folder and contents as a zip file", - "operationId": "ExportHomePageFolder", + "summary": "Gets all the equivalent units and their conversion factors for the specified source units,\r\nincluding any errors that occurred.", + "operationId": "GetUnitConversions", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "404": { - "description": "Database or folder not found" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" + }, + "examples": { + "Example 1": { + "summary": "Convert units", + "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", + "value": { + "sourceUnits": [ + { + "sourceUnitSymbol": "K", + "targetUnitSymbol": "°F" + } + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" + }, + "examples": { + "Example 1": { + "summary": "Convert units", + "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", + "value": { + "sourceUnits": [ + { + "sourceUnitSymbol": "K", + "targetUnitSymbol": "°F" + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" + }, + "examples": { + "Example 1": { + "summary": "Convert units", + "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", + "value": { + "sourceUnits": [ + { + "sourceUnitSymbol": "K", + "targetUnitSymbol": "°F" + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" + }, + "examples": { + "Example 1": { + "summary": "Convert units", + "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", + "value": { + "sourceUnits": [ + { + "sourceUnitSymbol": "K", + "targetUnitSymbol": "°F" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUnitConversionsInfo" + } + } + } } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:export": { + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - Units" ], - "summary": "Get Home Page File as a file", - "operationId": "ExportHomePageFile", + "summary": "Get equivalent units (one per unit system)", + "operationId": "GetUnitEquivalents", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "file-guid", + "name": "unit-guid", "in": "path", "required": true, "schema": { @@ -59960,42 +51009,46 @@ "200": { "description": "Ok", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaUnitEquivalentsInfo" } } - }, - "x-is-file": true + } }, "404": { - "description": "Database, folder or file not found" + "description": "Database or unit not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:move": { + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units/unit-system/{unit-system-guid}/equivalent-unit/{equivalent-unit-guid}:set-equivalent-unit": { "post": { "tags": [ - "Schema - Home Pages" + "Schema - Units" ], - "summary": "Move an existing Home Page File.", - "operationId": "MoveHomePageFile", + "summary": "Set the equivalent unit for a given unit system", + "operationId": "SetUnitEquivalent", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "unit-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "unit-system-guid", "in": "path", "required": true, "schema": { @@ -60004,7 +51057,7 @@ } }, { - "name": "file-guid", + "name": "equivalent-unit-guid", "in": "path", "required": true, "schema": { @@ -60013,227 +51066,130 @@ } } ], + "responses": { + "200": { + "description": "Ok" + }, + "404": { + "description": "Database, unit system, unit or equivalent unit not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/units": { + "get": { + "tags": [ + "Schema - Units" + ], + "summary": "Get all units", + "operationId": "GetUnits", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUnitsInfo" + } + } + } + }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Units" + ], + "summary": "Create a new unit.", + "operationId": "CreateUnit", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" - }, - "examples": { - "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", - "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" - } - } + "$ref": "#/components/schemas/GsaCreateUnit" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" - }, - "examples": { - "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", - "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" - } - } + "$ref": "#/components/schemas/GsaCreateUnit" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" - }, - "examples": { - "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", - "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" - } - } + "$ref": "#/components/schemas/GsaCreateUnit" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" - }, - "examples": { - "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", - "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" - } - } + "$ref": "#/components/schemas/GsaCreateUnit" } } } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "eea63ab3-7cbe-43f5-9e5c-4dc008f85545" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "eea63ab3-7cbe-43f5-9e5c-4dc008f85545" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "eea63ab3-7cbe-43f5-9e5c-4dc008f85545" + "$ref": "#/components/schemas/GsaUnit" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '80caf3a8-7ec6-4b29-bdce-c3682d7d7789', but there is no HomePage folder with that GUID.", - "value": { - "message": "Cannot move HomePage file with GUID 'd0f25056-6244-4d11-b5ce-1a693aa45d9d'.", - "code": "fileMove", - "fileGuid": "d0f25056-6244-4d11-b5ce-1a693aa45d9d", - "folderType": "homePage", - "errors": [ - { - "message": "A HomePage folder with GUID '80caf3a8-7ec6-4b29-bdce-c3682d7d7789' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "80caf3a8-7ec6-4b29-bdce-c3682d7d7789", - "folderType": "homePage", - "databaseKey": "MI_Training" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '80caf3a8-7ec6-4b29-bdce-c3682d7d7789', but there is no HomePage folder with that GUID.", - "value": { - "message": "Cannot move HomePage file with GUID 'd0f25056-6244-4d11-b5ce-1a693aa45d9d'.", - "code": "fileMove", - "fileGuid": "d0f25056-6244-4d11-b5ce-1a693aa45d9d", - "folderType": "homePage", - "errors": [ - { - "message": "A HomePage folder with GUID '80caf3a8-7ec6-4b29-bdce-c3682d7d7789' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "80caf3a8-7ec6-4b29-bdce-c3682d7d7789", - "folderType": "homePage", - "databaseKey": "MI_Training" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '80caf3a8-7ec6-4b29-bdce-c3682d7d7789', but there is no HomePage folder with that GUID.", - "value": { - "message": "Cannot move HomePage file with GUID 'd0f25056-6244-4d11-b5ce-1a693aa45d9d'.", - "code": "fileMove", - "fileGuid": "d0f25056-6244-4d11-b5ce-1a693aa45d9d", - "folderType": "homePage", - "errors": [ - { - "message": "A HomePage folder with GUID '80caf3a8-7ec6-4b29-bdce-c3682d7d7789' does not exist in database MI_Training.", - "reason": "noSuchNewParent", - "folderGuid": "80caf3a8-7ec6-4b29-bdce-c3682d7d7789", - "folderType": "homePage", - "databaseKey": "MI_Training" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:descendants": { + "/v1alpha/databases/{database-key}/units/{unit-guid}": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - Units" ], - "summary": "Returns file information for all descendants of a Home Page folder.", - "operationId": "GetHomePageDescendants", + "summary": "Get individual units", + "operationId": "GetUnit", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "unit-guid", "in": "path", "required": true, "schema": { @@ -60246,97 +51202,196 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" + "$ref": "#/components/schemas/GsaUnit" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database or unit not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections": { - "get": { + }, + "patch": { "tags": [ - "Schema - Layout Sections" + "Schema - Units" ], - "summary": "Get all sections for a layout", - "operationId": "GetLayoutSections", + "summary": "Update unit.", + "operationId": "UpdateUnit", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "unit-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUnit" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUnit" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUnit" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUnit" + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUnit" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, + "404": { + "description": "Database or unit not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Units" + ], + "summary": "Delete unit.", + "operationId": "DeleteUnit", + "parameters": [ { - "name": "layout-guid", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "unit-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or unit not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/units/{unit-guid}:compatible-units": { + "get": { + "tags": [ + "Schema - Units" + ], + "summary": "Get compatible units for unit", + "operationId": "GetCompatibleUnits", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "showFullDetail", - "in": "query", + "name": "unit-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUnitsInfo" + } + } } }, + "404": { + "description": "Database or unit not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/units/{unit-guid}:usages": { + "get": { + "tags": [ + "Schema - Units" + ], + "summary": "Get all usages of unit", + "operationId": "GetUnitUsages", + "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "unit-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -60346,165 +51401,63 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayoutSectionsInfo" - }, - "examples": { - "Example 1": { - "summary": "Get 'slim' layout sections", - "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "layoutSections": [ - { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ] - } - }, - "Example 2": { - "summary": "Get 'full' layout sections", - "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to true.", - "value": { - "layoutSections": [ - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "36ba7e8c-2737-472d-bf53-5d231b7feb4d", - "displayNames": {}, - "name": "Price", - "guid": "b176b98c-53b5-4224-8733-8d69fefcfc20" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "73ba6933-ca04-4f5d-b123-ed553c17e6e9", - "displayNames": {}, - "name": "Density", - "guid": "cb76d650-a1d8-4059-9155-95abc7520b87" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "floatFunctional", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "1150a9e8-4450-4481-b21a-5215178cae85", - "displayNames": {}, - "name": "Young's modulus", - "guid": "f8c34290-6504-4df4-a377-954772d0654c" - }, - { - "itemType": "attribute", - "attributeType": "range", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "80e8efb0-633c-4700-a87c-538f325423ee", - "displayNames": {}, - "name": "Tensile strength", - "guid": "aec12ffa-56a3-4026-9486-2f1e861b88aa" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "398a6477-5e33-408d-832b-6ee4b1fa36bd", - "displayNames": {}, - "name": "Shape factor", - "guid": "3e11cca1-a0d2-4bc1-b20a-5be627c68772" - } - ], - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ] - } - } + "$ref": "#/components/schemas/GsaUnitUsage" } } } }, "404": { - "description": "Database, table or layout not found" + "description": "Database or unit not found" } } - }, - "post": { + } + }, + "/v1alpha/databases/{database-key}/unit-systems": { + "get": { "tags": [ - "Schema - Layout Sections" + "Schema - Units" ], - "summary": "Create a new layout section.", - "operationId": "CreateSection", + "summary": "Get all unit systems in the database", + "operationId": "GetUnitSystems", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUnitSystemsInfo" + } + } } }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Units" + ], + "summary": "Create a new unit system.", + "operationId": "CreateUnitSystem", + "parameters": [ { - "name": "layout-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -60512,88 +51465,60 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" + "$ref": "#/components/schemas/GsaCreateUnitSystem" }, "examples": { "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Additional Properties" - } - }, - "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Unit System", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { - "name": "Additional Properties (Guid)", - "guid": "8e55481b-118f-4805-9f49-7a084d04d98d" + "name": "Hawaiian common", + "guid": "5065dde7-6771-4948-9faa-4c096a3b10d7" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" + "$ref": "#/components/schemas/GsaCreateUnitSystem" }, "examples": { "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Additional Properties" - } - }, - "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Unit System", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { - "name": "Additional Properties (Guid)", - "guid": "8e55481b-118f-4805-9f49-7a084d04d98d" + "name": "Hawaiian common", + "guid": "5065dde7-6771-4948-9faa-4c096a3b10d7" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" + "$ref": "#/components/schemas/GsaCreateUnitSystem" }, "examples": { "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Additional Properties" - } - }, - "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Unit System", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { - "name": "Additional Properties (Guid)", - "guid": "8e55481b-118f-4805-9f49-7a084d04d98d" + "name": "Hawaiian common", + "guid": "5065dde7-6771-4948-9faa-4c096a3b10d7" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" + "$ref": "#/components/schemas/GsaCreateUnitSystem" }, "examples": { "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Additional Properties" - } - }, - "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Unit System", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { - "name": "Additional Properties (Guid)", - "guid": "8e55481b-118f-4805-9f49-7a084d04d98d" + "name": "Hawaiian common", + "guid": "5065dde7-6771-4948-9faa-4c096a3b10d7" } } } @@ -60606,13 +51531,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSlimLayoutSection" - }, - "example": { - "sectionDetailType": "slim", - "displayNames": {}, - "name": "Additional Properties", - "guid": "db88c017-5810-4e17-90b0-edab9afb2a69" + "$ref": "#/components/schemas/GsaUnitSystem" } } } @@ -60624,41 +51543,70 @@ "description": "Forbidden" }, "404": { - "description": "Database, table or layout not found" + "description": "Database not found" } } - }, - "put": { + } + }, + "/v1alpha/databases/{database-key}/unit-systems/{unit-system-guid}": { + "get": { "tags": [ - "Schema - Layout Sections" + "Schema - Units" ], - "summary": "Reorder the list of layout sections for a layout.", - "operationId": "ReorderSections", + "summary": "Get an individual unit system", + "operationId": "GetUnitSystem", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "unit-system-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUnitSystem" + } + } + } + }, + "404": { + "description": "Database or unit system not found" + } + } + }, + "patch": { + "tags": [ + "Schema - Units" + ], + "summary": "Update a unit system.", + "operationId": "UpdateUnitSystem", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "layout-guid", + "name": "unit-system-guid", "in": "path", "required": true, "schema": { @@ -60671,288 +51619,116 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" + "$ref": "#/components/schemas/GsaUpdateUnitSystem" }, "examples": { "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a unit system", + "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "name": "UK Imperial (Updated)", + "guid": "c8ef95d4-036d-4923-a582-d7fd269f5b8b" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "UK Imperial (Updated)" + } + }, + "Example 3": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "guid": "1fb881f6-77b7-48df-af17-3fcc9380f004" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" + "$ref": "#/components/schemas/GsaUpdateUnitSystem" }, "examples": { "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a unit system", + "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "name": "UK Imperial (Updated)", + "guid": "c8ef95d4-036d-4923-a582-d7fd269f5b8b" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "UK Imperial (Updated)" + } + }, + "Example 3": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "guid": "1fb881f6-77b7-48df-af17-3fcc9380f004" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" + "$ref": "#/components/schemas/GsaUpdateUnitSystem" }, "examples": { "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a unit system", + "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "name": "UK Imperial (Updated)", + "guid": "c8ef95d4-036d-4923-a582-d7fd269f5b8b" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "UK Imperial (Updated)" + } + }, + "Example 3": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "guid": "1fb881f6-77b7-48df-af17-3fcc9380f004" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" + "$ref": "#/components/schemas/GsaUpdateUnitSystem" }, "examples": { "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a unit system", + "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "name": "UK Imperial (Updated)", + "guid": "c8ef95d4-036d-4923-a582-d7fd269f5b8b" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "UK Imperial (Updated)" + } + }, + "Example 3": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "guid": "1fb881f6-77b7-48df-af17-3fcc9380f004" } } } @@ -60965,191 +51741,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayoutSectionsInfo" - }, - "example": { - "layoutSections": [ - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Electrical Properties English Display Name", - "fr": "Electrical Properties French Display Name" - }, - "name": "Electrical Properties", - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Composition Overview English Display Name", - "fr": "Composition Overview French Display Name" - }, - "name": "Composition Overview", - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Composition detail (metals, ceramics and glasses) English Display Name", - "fr": "Composition detail (metals, ceramics and glasses) French Display Name" - }, - "name": "Composition detail (metals, ceramics and glasses)", - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Restricted substances English Display Name", - "fr": "Restricted substances French Display Name" - }, - "name": "Restricted substances", - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Further Information English Display Name", - "fr": "Further Information French Display Name" - }, - "name": "Further Information", - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Restricted substances English Display Name", - "fr": "Restricted substances French Display Name" - }, - "name": "Restricted substances", - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Notes English Display Name", - "fr": "Notes French Display Name" - }, - "name": "Notes", - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Material recycling: energy, CO2 and recycle fraction English Display Name", - "fr": "Material recycling: energy, CO2 and recycle fraction French Display Name" - }, - "name": "Material recycling: energy, CO2 and recycle fraction", - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Material processing: CO2 footprint English Display Name", - "fr": "Material processing: CO2 footprint French Display Name" - }, - "name": "Material processing: CO2 footprint", - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Material processing: energy English Display Name", - "fr": "Material processing: energy French Display Name" - }, - "name": "Material processing: energy", - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Eco-indicators for principal component English Display Name", - "fr": "Eco-indicators for principal component French Display Name" - }, - "name": "Eco-indicators for principal component", - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Primary material production: energy, CO2 and water English Display Name", - "fr": "Primary material production: energy, CO2 and water French Display Name" - }, - "name": "Primary material production: energy, CO2 and water", - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Geo-economic data for principal component English Display Name", - "fr": "Geo-economic data for principal component French Display Name" - }, - "name": "Geo-economic data for principal component", - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Durability: fluids and sunlight English Display Name", - "fr": "Durability: fluids and sunlight French Display Name" - }, - "name": "Durability: fluids and sunlight", - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Durability: flammability English Display Name", - "fr": "Durability: flammability French Display Name" - }, - "name": "Durability: flammability", - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Optical properties English Display Name", - "fr": "Optical properties French Display Name" - }, - "name": "Optical properties", - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Thermal properties English Display Name", - "fr": "Thermal properties French Display Name" - }, - "name": "Thermal properties", - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Bio-data English Display Name", - "fr": "Bio-data French Display Name" - }, - "name": "Bio-data", - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "$ref": "#/components/schemas/GsaUnitSystem" } } } @@ -61161,70 +51753,80 @@ "description": "Forbidden" }, "404": { - "description": "Database, table, layout or layout section not found" + "description": "Database or unit system not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}": { - "get": { + }, + "delete": { "tags": [ - "Schema - Layout Sections" + "Schema - Units" ], - "summary": "Get a layout section with a specified guid for a given layout.", - "operationId": "GetLayoutSection", + "summary": "Delete a unit system.", + "operationId": "DeleteUnitSystem", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "unit-system-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or unit system not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-identity}:search": { + "post": { + "tags": [ + "Search" + ], + "summary": "Runs a search against a given database and table identity", + "operationId": "DatabaseSearchInTableWithIdentity", + "parameters": [ { - "name": "layout-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "section-guid", + "name": "table-identity", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "showFullDetail", - "in": "query", - "schema": { - "type": "boolean" + "type": "integer", + "format": "int32" } }, { "name": "mode", "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { "enum": [ "read", @@ -61236,7 +51838,7 @@ { "name": "X-Ansys-VC-Mode", "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -61246,3114 +51848,3208 @@ } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLayoutSection" - }, - "examples": { - "Example 1": { - "summary": "Get 'slim' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "detailType": "slim", - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" - }, - "name": "Testing Information", - "guid": "4debaddb-f694-40ce-8ab2-9c02157d3e2a" - } - }, - "Example 2": { - "summary": "Get 'full' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to true.", - "value": { - "detailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "7ded497d-2b33-4feb-9d19-4dd82d7841d0", - "displayNames": {}, - "name": "Form", - "guid": "9a830f3d-3baf-48cd-b204-8d964a65400e" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [ - { - "itemType": "attribute", - "attributeType": "longText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "b7348767-bccc-4478-8987-42f6244ec474", - "displayNames": {}, - "name": "Sources", - "guid": "d36b32cb-ace1-4efa-b29f-02467038b87d" - }, - { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "2a128ef4-1ab0-478f-ae93-ab7c97bb34a1", - "displayNames": {}, - "name": "Notes", - "guid": "eef7bc11-8c1a-4fa6-8931-b705d0454f62" - } - ], - "underlyingEntityGuid": "25722b7c-b175-422c-8d7b-5ba4b621983b", - "displayNames": {}, - "name": "Chemical resistance", - "guid": "efc4bf28-73ae-4e7a-9e8e-bd97eea76c7f" - }, - { - "itemType": "link", - "linkType": "recordLink", - "targetDatabase": "845667a4-645b-4dae-8d52-c03866009d1c", - "targetDatabaseVersion": "8dfb685b-a344-47ee-9e82-fc6ee91da711", - "targetTable": "b7622b32-1e22-4d6d-a654-4776a707362d", - "forwards": true, - "underlyingEntityGuid": "e57beb0a-3df4-4cd7-ab86-066ce95a5874", - "displayNames": {}, - "name": "Material Pedigree", - "guid": "bddcd683-9be1-41d4-a5d8-59599eda50ba" - }, - { - "itemType": "attribute", - "attributeType": "link", - "required": false, - "readOnly": false, - "metaAttributes": [], - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "tabularColumnGuid": "7585d7cd-ed2a-4cf1-afb1-67f6719e63fe", - "name": "Offset Yield Stress", - "guid": "e5c47a2e-182e-4137-ad26-d65873bcc0a1" - }, - { - "columnType": "localShortText", - "tabularColumnGuid": "518e8b39-cd8f-4822-b53f-45e8cb6ab268", - "name": "Young's Modulus Notes", - "guid": "69a348df-f99e-4fea-a67c-a85996068f2e" - } - ], - "underlyingEntityGuid": "15ab1713-d26c-4b05-be64-a4a594bbb502", - "displayNames": {}, - "name": "Reference Characteristics", - "guid": "39046a34-56e7-4ea1-b244-01018499a482" - }, - { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "845667a4-645b-4dae-8d52-c03866009d1c", - "targetDatabaseVersion": "8dfb685b-a344-47ee-9e82-fc6ee91da711", - "targetTable": "9dac2698-f7a9-4360-9365-b6f36bef7c90", - "forwards": true, - "nextLink": { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "845667a4-645b-4dae-8d52-c03866009d1c", - "targetDatabaseVersion": "8dfb685b-a344-47ee-9e82-fc6ee91da711", - "targetTable": "2c831235-b77c-4b0a-9096-160ef60de5cd", - "forwards": false, - "underlyingEntityGuid": "906fd603-49e0-40e5-b235-f8b8d201077c", - "displayNames": {}, - "name": "Pedigree information", - "guid": "bfffa240-4f95-4e19-8307-3d5702e24f50" - }, - "underlyingEntityGuid": "f6b383ab-5d69-4850-8ae6-b17ea38792c8", - "displayNames": {}, - "name": "To Pedigree from Producers", - "guid": "6db08e33-9356-4883-a40d-d06c9866507d" - } - ], - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" - }, - "name": "Testing Information", - "guid": "f26b36b5-40bf-414f-aed1-1b8f7b5ec2ef" - } - } - } - } - } - }, - "404": { - "description": "Database, table, layout or layout section not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Update a layout section.", - "operationId": "UpdateSection", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" - } - }, - "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" + "sortDirection": "ascending", + "type": "relevance" } ] } }, - "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 2": { + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" + "localColumns": { + "filterOn": "none" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" - }, - "examples": { - "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 3": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 4": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" + "localColumns": { + "filterOn": "none" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" - }, - "examples": { - "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" + "criterion": { + "innerCriterion": { + "type": "integer" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" - }, - "examples": { - "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFullLayoutSection" - }, - "example": { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "discrete", - "required": false, - "readOnly": false, - "underlyingEntityGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "displayNames": {}, - "name": "Base", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - } - ], - "name": "Composition overview", - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, layout or section not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Delete a layout section.", - "operationId": "DeleteSection", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, layout or layout section not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections/{section-guid}": { - "get": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Get a layout section with a specified guid.", - "operationId": "GetLayoutSectionWithoutLayout", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "showFullDetail", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLayoutSection" }, - "examples": { - "Example 3": { - "summary": "Get 'slim' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "detailType": "slim", - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" - }, - "name": "Testing Information", - "guid": "8011611e-a5de-47d2-ad53-28e1f9704716" - } - }, - "Example 4": { - "summary": "Get 'full' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to true.", - "value": { - "detailType": "full", - "sectionItems": [ + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", + "value": { + "criterion": { + "all": [], + "any": [ { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "bacd785d-fcc0-44e5-ba81-32dce28f818e", - "displayNames": {}, - "name": "Form", - "guid": "55695f7b-839d-4798-aaf7-e97657e24f74" + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [ + "all": [ { - "itemType": "attribute", - "attributeType": "longText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "08f80785-d4cc-4eaa-b4b1-a4e5d05b711a", - "displayNames": {}, - "name": "Sources", - "guid": "d9d04a6e-4d99-4a93-886f-fd214c220593" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "e93d3971-1bf6-438e-9832-fcb38c57f65b", - "displayNames": {}, - "name": "Notes", - "guid": "2cd9403e-53dc-415a-910c-bab27ee035fb" + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" } ], - "underlyingEntityGuid": "2eb63154-e93a-4423-8661-0842ab666399", - "displayNames": {}, - "name": "Chemical resistance", - "guid": "106107c1-cdce-4fe8-9e6b-ca14dcec97ff" - }, + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", + "value": { + "criterion": { + "all": [], + "any": [ { - "itemType": "link", - "linkType": "recordLink", - "targetDatabase": "10be6d4f-9f18-4608-b7a3-6263b33e2cc2", - "targetDatabaseVersion": "8db7ec98-e388-453c-93e2-95bcaa66b13d", - "targetTable": "529be615-e880-4f47-a31b-a1452472f10f", - "forwards": true, - "underlyingEntityGuid": "6075d5f7-f6fa-4678-a3b9-dcbfb4a6cfaf", - "displayNames": {}, - "name": "Material Pedigree", - "guid": "5db0ae68-a554-4820-82ed-6ebddaa22af9" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, { - "itemType": "attribute", - "attributeType": "link", - "required": false, - "readOnly": false, - "metaAttributes": [], - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "tabularColumnGuid": "33230e9f-14ee-4a4a-8d6a-69938c8bd9a5", - "name": "Offset Yield Stress", - "guid": "67e56810-bbb8-4ab1-8940-41b0e0d10298" - }, - { - "columnType": "localShortText", - "tabularColumnGuid": "78eaa004-e417-40f8-bb1d-f2bdb11fb2fa", - "name": "Young's Modulus Notes", - "guid": "a6d49f71-6e3e-46f8-8839-9d2698bd9b09" - } - ], - "underlyingEntityGuid": "640b3a2b-ef2e-4653-9bb9-c617a44f3647", - "displayNames": {}, - "name": "Reference Characteristics", - "guid": "fe678aea-bb71-4c10-a758-e6b7f31dd247" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "10be6d4f-9f18-4608-b7a3-6263b33e2cc2", - "targetDatabaseVersion": "8db7ec98-e388-453c-93e2-95bcaa66b13d", - "targetTable": "d12e3e89-4aa0-44d5-9c28-dc27f876fdfc", - "forwards": true, - "nextLink": { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "10be6d4f-9f18-4608-b7a3-6263b33e2cc2", - "targetDatabaseVersion": "8db7ec98-e388-453c-93e2-95bcaa66b13d", - "targetTable": "855f9dbf-1444-4a99-a0dc-0fed3cf0a1ee", - "forwards": false, - "underlyingEntityGuid": "302a6c94-fd0d-40e2-844f-3f8a5507fd01", - "displayNames": {}, - "name": "Pedigree information", - "guid": "c8fed872-85e3-4a7b-a934-612f835b0e21" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" }, - "underlyingEntityGuid": "ed92f861-4d36-4d7e-bfa5-28b14bdee9e0", - "displayNames": {}, - "name": "To Pedigree from Producers", - "guid": "353fa6ee-774f-4b66-96d6-f601a4169f02" + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } ], - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" - }, - "name": "Testing Information", - "guid": "6f95a5d4-a8f8-4a70-a078-9dc0a084e7bb" - } - } - } - } - } - }, - "404": { - "description": "Database, table or layout section not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Update a layout section.", - "operationId": "UpdateSectionWithoutLayout", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" - }, - "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" - } - }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", - "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, + "none": [], + "type": "boolean" + }, + "sortCriteria": [ { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } ] } }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" - }, - "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" - } }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "criterion": { + "recordListIdentifiers": [ + "c912786a-e302-466b-8d0f-308acd9514cf", + "3e444512-57d9-4795-a0ee-cf001a3fec8d" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" - }, - "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", + }, + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "name": "Custom Properties" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" - }, - "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", + }, + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "name": "Custom Properties" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFullLayoutSection" }, - "example": { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "discrete", - "required": false, - "readOnly": false, - "underlyingEntityGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "displayNames": {}, - "name": "Base", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - } - ], - "name": "Composition overview", - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or section not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items": { - "post": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Add a new layout item.", - "operationId": "CreateLayoutItem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" - }, - "examples": { - "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false - } - ] + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ] + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "68eab4c9-f3b1-484b-94c2-8e9be3d074be", - "sourceTableGuid": "2609792d-8d21-4b30-a04e-6d48ec5ac573", - "linkGroupGuid": "708500d4-142f-4789-b6a0-67c7329e3499" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "35d692fb-a394-4807-91ce-a52d78ea8eb8", - "tabularAttributeGuid": "fe18cb84-18b6-487f-861f-ff1444eb3af1" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" }, + "type": "text" + }, + "sortCriteria": [ { - "forwards": false, - "sourceDatabaseVersionGuid": "999c1b3e-3e95-476e-a8f8-024aae9fe50b", - "tabularAttributeGuid": "21bf7c62-1fc1-4a57-81a5-f4e8a4850d2c" + "sortDirection": "ascending", + "type": "relevance" } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" - }, - "examples": { - "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false + "sortDirection": "ascending", + "type": "relevance" } ] } }, - "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", - "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ] - } - }, - "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - }, - "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - } - }, - "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "68eab4c9-f3b1-484b-94c2-8e9be3d074be", - "sourceTableGuid": "2609792d-8d21-4b30-a04e-6d48ec5ac573", - "linkGroupGuid": "708500d4-142f-4789-b6a0-67c7329e3499" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "35d692fb-a394-4807-91ce-a52d78ea8eb8", - "tabularAttributeGuid": "fe18cb84-18b6-487f-861f-ff1444eb3af1" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "999c1b3e-3e95-476e-a8f8-024aae9fe50b", - "tabularAttributeGuid": "21bf7c62-1fc1-4a57-81a5-f4e8a4850d2c" - } - ] + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } }, - "text/json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false - } - ] + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ] + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" + } + ] } }, "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "68eab4c9-f3b1-484b-94c2-8e9be3d074be", - "sourceTableGuid": "2609792d-8d21-4b30-a04e-6d48ec5ac573", - "linkGroupGuid": "708500d4-142f-4789-b6a0-67c7329e3499" + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "35d692fb-a394-4807-91ce-a52d78ea8eb8", - "tabularAttributeGuid": "fe18cb84-18b6-487f-861f-ff1444eb3af1" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "999c1b3e-3e95-476e-a8f8-024aae9fe50b", - "tabularAttributeGuid": "21bf7c62-1fc1-4a57-81a5-f4e8a4850d2c" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" - }, - "examples": { - "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false - } - ] + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } ] } }, - "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - }, - "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - } - }, - "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "68eab4c9-f3b1-484b-94c2-8e9be3d074be", - "sourceTableGuid": "2609792d-8d21-4b30-a04e-6d48ec5ac573", - "linkGroupGuid": "708500d4-142f-4789-b6a0-67c7329e3499" - } - }, - "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "35d692fb-a394-4807-91ce-a52d78ea8eb8", - "tabularAttributeGuid": "fe18cb84-18b6-487f-861f-ff1444eb3af1" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "forwards": false, - "sourceDatabaseVersionGuid": "999c1b3e-3e95-476e-a8f8-024aae9fe50b", - "tabularAttributeGuid": "21bf7c62-1fc1-4a57-81a5-f4e8a4850d2c" + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" }, - "examples": { - "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates the response to creating a new attribute layout item. It was created by adding the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": false, - "metaAttributes": null, - "tabularColumnGuids": null, - "guid": "d79d9030-2623-4d4d-a141-95595cd0447d" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates the response to creating a new attribute layout item with a meta-attribute. It was created by adding the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false, - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": true, - "readOnly": false - } - ], - "tabularColumnGuids": null, - "guid": "fdfe7f50-00dd-4f89-b2fa-56f9fee29b1e" - } - }, - "Example 3": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates the response to creating a new tabular attribute layout item with specified tabular columns to include. It was created by adding the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include. ", - "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "required": false, - "readOnly": false, - "metaAttributes": null, - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ], - "guid": null - } - }, - "Example 4": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates the response to creating a new link group layout item. It was created by adding the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "forwards": null, - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949", - "guid": null - } - }, - "Example 5": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates the response to creating a new smart link group layout item. It was created by adding the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66", - "guid": null - } - }, - "Example 6": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates the response to creating a new cross database link group layout item. It was created by adding a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "89399c3b-eaf5-4211-a457-0871401ee7c0", - "sourceTableGuid": "41b37aa7-e832-417d-bdd4-9d329bbc7d47", - "linkGroupGuid": "197b6485-3d8c-4433-aa75-f3cb462ca47e", - "guid": null - } - }, - "Example 7": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates the response to creating a new association chain layout item. It was created by adding a association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", - "tabularAttributeGuid": "e59c3c35-cd5f-408c-b182-394704fb33b0" - }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", - "tabularAttributeGuid": "9b716e48-ceb0-4ef6-a136-631d62cadcb5" - } - ], - "guid": null - } - } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, layout or layout section not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items/{item-guid}": { - "delete": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Delete a layout item.", - "operationId": "DeleteItem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "item-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, layout, layout section or layout section item not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections:query": { - "post": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Query all layout sections for table, optionally filter layout sections returned", - "operationId": "QueryLayoutSections", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "application", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cascadeFilter", - "in": "query", - "description": "If cascadeFilter is true, we apply the filter to the returned layout items, as well as filtering the layout sections themselves.", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" - }, - "examples": { - "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "recordListIdentifiers": [ + "c912786a-e302-466b-8d0f-308acd9514cf", + "3e444512-57d9-4795-a0ee-cf001a3fec8d" + ], + "type": "recordListMember" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [] } }, - "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [] } }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } + "sortCriteria": [] } }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } + "sortCriteria": [] } }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } + "sortCriteria": [] } }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID '0e1ebc3f-e99f-4dbb-80e1-b0f827829228'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'b6a45861-8cf2-427c-99d5-8b66d1847c8e'.", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "0e1ebc3f-e99f-4dbb-80e1-b0f827829228", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "b6a45861-8cf2-427c-99d5-8b66d1847c8e", - "forwards": false - } - } + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" - }, - "examples": { - "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + }, + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" }, - "displayNames": true, - "name": true, - "guid": true + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [] } }, - "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [] } }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } + "sortCriteria": [] } }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } + "sortCriteria": [] } }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } + "sortCriteria": [] } }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID '0e1ebc3f-e99f-4dbb-80e1-b0f827829228'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'b6a45861-8cf2-427c-99d5-8b66d1847c8e'.", + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "0e1ebc3f-e99f-4dbb-80e1-b0f827829228", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "b6a45861-8cf2-427c-99d5-8b66d1847c8e", - "forwards": false - } - } + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" - }, - "examples": { - "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + }, + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" }, - "displayNames": true, - "name": true, - "guid": true + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [] } }, - "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [] } }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } + "sortCriteria": [] } }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" } + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 } } }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" } - } + ] } }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID '0e1ebc3f-e99f-4dbb-80e1-b0f827829228'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'b6a45861-8cf2-427c-99d5-8b66d1847c8e'.", + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "0e1ebc3f-e99f-4dbb-80e1-b0f827829228", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "b6a45861-8cf2-427c-99d5-8b66d1847c8e", - "forwards": false - } - } + "sortCriteria": [] + } + }, + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } }, - "application/*+json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - "displayNames": true, - "name": true, - "guid": true + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" }, - "filter": { - "name": "General Properties" - } + "sortCriteria": [] } }, "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } + "sortCriteria": [] } }, "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } + "sortCriteria": [] } }, "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } - } + ] } }, "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID '0e1ebc3f-e99f-4dbb-80e1-b0f827829228'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'b6a45861-8cf2-427c-99d5-8b66d1847c8e'.", + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "0e1ebc3f-e99f-4dbb-80e1-b0f827829228", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "b6a45861-8cf2-427c-99d5-8b66d1847c8e", - "forwards": false - } - } + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsInfo" }, - "examples": { - "Example 1": { - "summary": "Query layout sections with custom properties", - "description": "This example demonstrates the response to querying layout sections with custom properties.", - "value": { - "layoutSections": [ + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", + "value": { + "criterion": { + "all": [ { - "sectionItems": [ - { - "underlyingEntityGuid": "8ac625ac-7dcc-400b-b841-3feca4be8795", - "itemType": "attribute", - "name": "Price", - "guid": "8ab8f173-5536-4091-a4ee-106605b9b4bd" - }, - { - "underlyingEntityGuid": "3962c66c-0086-4647-998c-8ac771f8ab3a", - "itemType": "attribute", - "name": "Density", - "guid": "4e5111bd-fb97-45e5-94d7-4e25cadbabdf" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" + "innerCriterion": { + "type": "longText" }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - } - ] - } - }, - "Example 2": { - "summary": "Query layout sections with name and GUID", - "description": "This example demonstrates the response to querying layout sections with name and GUID properties only.", - "value": { - "layoutSections": [ + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, { - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } - ] - } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts": { - "get": { - "tags": [ - "Schema - Layouts" - ], - "summary": "Get all layouts for table", - "operationId": "GetLayouts", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "application", - "in": "query", - "description": "Optionally filter by application that the layout is applicable to.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLayoutsInfo" }, - "example": { - "layouts": [ - { - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", + "value": { + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - { - "displayNames": {}, - "name": "Metals", - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - { - "displayNames": {}, - "name": "Polymers", - "guid": "00007645-0009-4fff-8fff-dd92ffff0000" - } - ] - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - }, - "post": { - "tags": [ - "Schema - Layouts" - ], - "summary": "Create a new layout.", - "operationId": "CreateLayout", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" - }, - "examples": { - "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Composite materials" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "name": "Composite materials (guid)", - "guid": "29ee17a7-58fd-4ba6-8f1b-c2c4d600cbc2" + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Composite materials (with applicable applications)" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "sections": [ - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, - { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - } + "criterion": { + "innerCriterion": { + "all": [ + "red" ], - "name": "General Properties" + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, - { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - ], - "name": "Additional Properties" + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } - ], - "name": "Composite materials" + ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" - }, - "examples": { - "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "name": "Composite materials" + "criterion": { + "recordListIdentifiers": [ + "c912786a-e302-466b-8d0f-308acd9514cf", + "3e444512-57d9-4795-a0ee-cf001a3fec8d" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "name": "Composite materials (guid)", - "guid": "29ee17a7-58fd-4ba6-8f1b-c2c4d600cbc2" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Composite materials (with applicable applications)" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "sections": [ - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, - { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - } - ], - "name": "General Properties" - }, - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, - { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - ], - "name": "Additional Properties" - } - ], - "name": "Composite materials" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" - }, - "examples": { - "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "name": "Composite materials" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "name": "Composite materials (guid)", - "guid": "29ee17a7-58fd-4ba6-8f1b-c2c4d600cbc2" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", + "value": { + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", + "value": { + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", + "value": { + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", + "value": { + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", + "value": { + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } ], - "name": "Composite materials (with applicable applications)" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "sections": [ + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, + "sortDirection": "ascending", + "type": "relevance" + } + ] + } + }, + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", + "value": { + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" } ], - "name": "General Properties" + "type": "floatFunctionalData" }, - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" } ], - "name": "Additional Properties" - } - ], - "name": "Composite materials" + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "name": "Composite materials" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "name": "Composite materials (guid)", - "guid": "29ee17a7-58fd-4ba6-8f1b-c2c4d600cbc2" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Composite materials (with applicable applications)" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "sections": [ - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, - { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - } - ], - "name": "General Properties" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" }, - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, - { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - ], - "name": "Additional Properties" - } - ], - "name": "Composite materials" + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLayout" }, - "example": { - "applicableApplications": [], - "displayNames": {}, - "name": "Ceramics", - "guid": "345869e9-d46f-4cff-8dd1-efc1797f0429" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}": { - "get": { - "tags": [ - "Schema - Layouts" - ], - "summary": "Get a layout with a specified guid for a given database and table.", - "operationId": "GetLayout", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "showFullDetail", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLayout" + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", + "value": { + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" + } + ] + } }, - "examples": { - "Example 1": { - "summary": "Layout with 'slim' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "sections": [ + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", + "value": { + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", + "value": { + "criterion": { + "all": [ { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" + "innerCriterion": { + "type": "longText" }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", + "value": { + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 2": { - "summary": "Layout with 'full' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to true.", - "value": { - "sections": [ + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", + "value": { + "criterion": { + "all": [], + "any": [ { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "d62a5443-b864-4bcc-bc89-33f9531ca8c3", - "displayNames": {}, - "name": "Price", - "guid": "6500b04b-cf2c-4f87-aafa-0387c8eba584" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "530db2d3-5360-434f-91d6-fb5c5d4436a4", - "displayNames": {}, - "name": "Density", - "guid": "c5597a90-4741-4ad9-afa4-9528706d24d2" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" + "value": "steel", + "attributes": { + "filterOn": "all" }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "floatFunctional", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "267d390f-60df-4c27-8e9f-537087aa9402", - "displayNames": {}, - "name": "Young's modulus", - "guid": "02bb107d-c696-4760-957e-230e803cd4f0" - }, + "all": [ { - "itemType": "attribute", - "attributeType": "range", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "d989da79-c397-4f32-9ef8-48cf5d8c81c6", - "displayNames": {}, - "name": "Tensile strength", - "guid": "bcf562dc-cadf-4a05-b138-8fe727690e7e" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "89ec1f8a-0994-4353-8b76-42db4a6ca4dc", - "displayNames": {}, - "name": "Shape factor", - "guid": "2478620c-0e60-4efe-b61e-486e7f46000b" + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" } ], - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + "any": [], + "none": [], + "type": "boolean" } ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - } - }, - "404": { - "description": "Database, table or layout not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Layouts" - ], - "summary": "Update a layout.", - "operationId": "UpdateLayout", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" - }, - "examples": { - "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Ceramics (Updated)", - "guid": "02f18031-3fc7-4036-9df6-67c2b67df078" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "name": "Ceramics (Updated)" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "applicableApplications": null + "criterion": { + "recordListIdentifiers": [ + "c912786a-e302-466b-8d0f-308acd9514cf", + "3e444512-57d9-4795-a0ee-cf001a3fec8d" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" - }, - "examples": { - "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Ceramics (Updated)", - "guid": "02f18031-3fc7-4036-9df6-67c2b67df078" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "name": "Ceramics (Updated)" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "applicableApplications": null + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" - }, - "examples": { - "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Ceramics (Updated)", - "guid": "02f18031-3fc7-4036-9df6-67c2b67df078" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "name": "Ceramics (Updated)" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "applicableApplications": null + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" - }, - "examples": { - "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", + "value": { + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", + "value": { + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", + "value": { + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", + "value": { + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } ], - "name": "Ceramics (Updated)", - "guid": "02f18031-3fc7-4036-9df6-67c2b67df078" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "name": "Ceramics (Updated)" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, - "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "applicableApplications": null + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } @@ -64362,400 +55058,69 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayout" - }, - "example": { - "applicableApplications": [], - "displayNames": {}, - "name": "Ceramics", - "guid": "0827895d-a269-45c9-95e1-e94ed30be1b9" + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" } } } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}:search": { + "post": { "tags": [ - "Schema - Layouts" + "Search" ], - "summary": "Delete a layout.", - "operationId": "DeleteLayout", + "summary": "Runs a search against a given database and table guid", + "operationId": "DatabaseSearchInTableWithGuid", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "layout-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request" }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/searchable-items": { - "get": { - "tags": [ - "Schema - Layouts" - ], - "summary": "Return the identifiers of items that should be included in a free text search over a specific layout", - "operationId": "GetSearchableItemsInLayout", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GrantaMISearchFreeTextIdentifiers" - }, - "examples": { - "Example 3": { - "summary": "Layout with 'slim' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "sections": [ - { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 4": { - "summary": "Layout with 'full' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to true.", - "value": { - "sections": [ - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "20c06c0c-5cdc-4894-bb61-a6aa4f2ac2e9", - "displayNames": {}, - "name": "Price", - "guid": "b2333db7-6c29-49b8-ac43-9fbfaaff051b" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "5e81f916-1eba-4999-bcda-6d965bffa6ad", - "displayNames": {}, - "name": "Density", - "guid": "d000734c-2a49-44d0-b74d-3a527b4e45d6" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "floatFunctional", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "cb0a4554-fcdd-4aab-a4d7-20025059dfd2", - "displayNames": {}, - "name": "Young's modulus", - "guid": "9e98f9b0-2c68-49be-8a85-65d1fed8c234" - }, - { - "itemType": "attribute", - "attributeType": "range", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "fb502114-c1e1-4fd4-99d9-28a7c0690c02", - "displayNames": {}, - "name": "Tensile strength", - "guid": "3cad37f2-2e0b-4367-b709-a8b844a0f4f8" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "2130379b-c2da-4414-85bb-a3ef1f25fb63", - "displayNames": {}, - "name": "Shape factor", - "guid": "ea418ada-eb1f-4539-b992-f4f05ffd1f0b" - } - ], - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - } - } - } - } - }, - "404": { - "description": "Database, table or layout not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:applications": { - "get": { - "tags": [ - "Schema - Layouts" - ], - "summary": "Returns applications that are either MI Applications, or in use in layouts in this table.\r\nCan be used as applicable applications for layouts.", - "operationId": "Applications", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaApplicationsInfo" - }, - "example": { - "applications": [ - "MI:Viewer", - "MI:Explore", - "MI:Materials Gateway", - "An Application" - ] - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:query": { - "post": { - "tags": [ - "Schema - Layouts" - ], - "summary": "Query all layouts for table, optionally filter layouts returned", - "operationId": "QueryLayouts", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", @@ -64763,3662 +55128,3210 @@ ], "type": "string" } - }, - { - "name": "application", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cascadeFilter", - "in": "query", - "description": "If cascadeFilter is true, we apply the filter to the returned layout sections and items, as well as filtering the layouts themselves.", - "schema": { - "type": "boolean" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { - "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", + "Example 31": { + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - "displayNames": true, - "name": true, - "guid": true + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - "filter": { - "sections": { - "name": "General Properties" + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" } - } + ] } }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", + "Example 32": { + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 } - } - } + ], + "type": "text" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "Example 33": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } + "sortCriteria": [] } }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", + "Example 34": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } + "sortCriteria": [] } }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "Example 35": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } - } + ] } }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID 'f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'f2b76bc7-5fd7-438d-b7a9-f0be01721c55'.", + "Example 36": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "f2b76bc7-5fd7-438d-b7a9-f0be01721c55", - "forwards": false - } - } - } + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" - }, - "examples": { - "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", + }, + "Example 37": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" }, - "filter": { - "sections": { - "name": "General Properties" - } - } + "sortCriteria": [] } }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", + "Example 38": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - "displayNames": true, - "name": true, - "guid": true + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" - } - } - } + "sortCriteria": [] } }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "Example 39": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" } - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + ], + "none": [], + "type": "boolean" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } + "sortCriteria": [] } }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "Example 40": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } - } + ] } }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID 'f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'f2b76bc7-5fd7-438d-b7a9-f0be01721c55'.", + "Example 41": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "f2b76bc7-5fd7-438d-b7a9-f0be01721c55", - "forwards": false - } + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } - } + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" - }, - "examples": { - "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", + }, + "Example 42": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "recordListIdentifiers": [ + "c06f99d2-48e3-41d6-8941-f5a03c543d5f", + "5f193496-fb65-4453-af78-d75a0b9e35b5" + ], + "type": "recordListMember" }, - "filter": { - "sections": { - "name": "General Properties" - } - } + "sortCriteria": [] } }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", + "Example 43": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" - } - } - } + "sortCriteria": [] } }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "Example 44": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } + "sortCriteria": [] } }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", + "Example 45": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } + "sortCriteria": [] } }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "Example 46": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } + "sortCriteria": [] } }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID 'f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'f2b76bc7-5fd7-438d-b7a9-f0be01721c55'.", + "Example 47": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "f2b76bc7-5fd7-438d-b7a9-f0be01721c55", - "forwards": false - } - } - } + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" - }, - "examples": { - "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", + }, + "Example 48": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" }, - "displayNames": true, - "name": true, - "guid": true + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "filter": { - "sections": { - "name": "General Properties" - } - } + "sortCriteria": [] } }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", + "Example 49": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" }, - "displayNames": true, - "name": true, - "guid": true + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" }, - "displayNames": true, - "name": true, - "guid": true + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" - } - } - } + "sortCriteria": [] } }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "Example 50": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } + "sortCriteria": [] } }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", + "Example 51": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } + "sortCriteria": [] } }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", + "Example 52": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } + "sortCriteria": [] } }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID 'f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID 'f2b76bc7-5fd7-438d-b7a9-f0be01721c55'.", + "Example 53": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "f05a9cf3-12cf-4cb2-8e50-ab5cbf10ab45", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "f2b76bc7-5fd7-438d-b7a9-f0be01721c55", - "forwards": false - } - } - } + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsInfo" }, - "examples": { - "Example 1": { - "summary": "Query layouts with custom properties", - "description": "This example demonstrates the response to querying layouts with custom properties.", - "value": { - "layouts": [ - { - "sections": [ - { - "sectionItems": [ - { - "underlyingEntityGuid": "03225512-57af-43e9-99ec-d3c859be5d07", - "itemType": "attribute", - "name": "Price", - "guid": "4a38cc7b-ddc6-4640-86f8-a76075d08d3e" - }, - { - "underlyingEntityGuid": "cb84251b-f094-48db-97de-8f770cf10154", - "itemType": "attribute", - "name": "Density", - "guid": "decd351f-f3a6-4a42-8c5f-cf1239cbb638" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionItems": [], - "displayNames": {}, - "name": "Further information", - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - } - ], - "displayNames": {}, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - ] - } - }, - "Example 2": { - "summary": "Query layouts with name and GUID", - "description": "This example demonstrates the response to querying layouts with name and GUID properties only.", - "value": { - "layouts": [ - { - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "Metals", - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "Polymers", - "guid": "00007645-0009-4fff-8fff-dd92ffff0000" - } - ] - } + "Example 54": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/parameters": { - "get": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Get all parameters for a given database.", - "operationId": "GetParameters", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParametersInfo" }, - "examples": { - "Example 1": { - "summary": "A mix of parameters", - "description": "This example contains a mix of numeric and discrete parameters from the MI_Training database.", - "value": { - "parameters": [ - { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - }, - { - "type": "numeric", - "value": 1.0, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "isRestricted": false, - "values": [ - { - "type": "numeric", - "value": -1.0, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94" - }, - { - "type": "numeric", - "value": 0.0, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "00000022-000b-4fff-8fff-0022ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94", - "displayNames": { - "en": "Strain Ratio", - "fr": "Rapport de contrainte" + "Example 55": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" }, - "name": "Strain Ratio", - "guid": "00000022-000a-4fff-8fff-0000ffff0000" + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - { - "type": "discrete", - "values": [ - { - "type": "discrete", - "name": "Mean", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "type": "discrete", - "name": "A-basis", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "B-basis", - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - ], - "defaultParameterValueGuid": "21a27377-12eb-413c-bac4-d4ffceda39d1", - "displayNames": { - "en": "Basis", - "fr": "Base" - }, - "name": "Basis", - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Create a new parameter.", - "operationId": "CreateParameter", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" - }, - "examples": { - "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", - "value": { - "values": [ - { - "type": "discrete", - "name": "Red" + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "Example 56": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "fa13eb8a-7357-457a-9922-47825dab31bf" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "81892cfb-a177-4f1f-8c77-f39312f639ad" + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "Example 57": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - { - "value": 2015.0, - "type": "numeric" + "localColumns": { + "filterOn": "all" }, + "type": "text" + }, + "sortCriteria": [ { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" + "sortDirection": "ascending", + "type": "relevance" } ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "Example 58": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" - }, - { - "value": 20.0, - "type": "numeric" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "value": 30.0, - "type": "numeric", - "name": "Big box" + "sortDirection": "ascending", + "type": "relevance" } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" + ] } }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "Example 59": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" }, - { - "value": 20.0, - "type": "numeric" + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 60": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" }, - { - "value": 30.0, - "type": "numeric", - "name": "Hot" - } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { - "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", + "Example 31": { + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "values": [ - { - "type": "discrete", - "name": "Red" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" }, + "type": "text" + }, + "sortCriteria": [ { - "type": "discrete", - "name": "Green" + "sortDirection": "ascending", + "type": "relevance" } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" + ] } }, - "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "Example 32": { + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "fa13eb8a-7357-457a-9922-47825dab31bf" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "81892cfb-a177-4f1f-8c77-f39312f639ad" + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "Example 33": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" }, - { - "value": 2015.0, - "type": "numeric" + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" }, - { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" + "type": "text" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "Example 34": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" }, - { - "value": 20.0, - "type": "numeric" + "localColumns": { + "filterOn": "none" }, - { - "value": 30.0, - "type": "numeric", - "name": "Big box" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "Example 35": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" - }, - { - "value": 20.0, - "type": "numeric" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "value": 30.0, - "type": "numeric", - "name": "Hot" + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" - }, - "examples": { - "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", + }, + "Example 36": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "values": [ - { - "type": "discrete", - "name": "Red" + "criterion": { + "innerCriterion": { + "type": "integer" }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "Example 37": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "fa13eb8a-7357-457a-9922-47825dab31bf" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "81892cfb-a177-4f1f-8c77-f39312f639ad" + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "Example 38": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" - }, - { - "value": 2015.0, - "type": "numeric" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "Example 39": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Big box" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" + "sortCriteria": [] } }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "Example 40": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" - }, - { - "value": 20.0, - "type": "numeric" - }, + "sortCriteria": [ { - "value": 30.0, - "type": "numeric", - "name": "Hot" + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" - }, - "examples": { - "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", + }, + "Example 41": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "values": [ - { - "type": "discrete", - "name": "Red" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "type": "discrete", - "name": "Green" + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" + ] } }, - "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "Example 42": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "fa13eb8a-7357-457a-9922-47825dab31bf" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "81892cfb-a177-4f1f-8c77-f39312f639ad" + "criterion": { + "recordListIdentifiers": [ + "c06f99d2-48e3-41d6-8941-f5a03c543d5f", + "5f193496-fb65-4453-af78-d75a0b9e35b5" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "Example 43": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" - }, - { - "value": 2015.0, - "type": "numeric" - }, - { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "Example 44": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Big box" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" + "sortCriteria": [] } }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "Example 45": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Hot" - } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameter" }, - "example": { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + "Example 46": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", + "value": { + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" }, - { - "type": "numeric", - "value": 1.0, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterCreationException" - }, - "examples": { - "Example 1": { - "summary": "No parameter values", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a parameter with name 'Color', but did not provide any parameter values. At least one parameter value is required.", - "value": { - "message": "Cannot create Parameter 'Color'.", - "code": "parameterCreation", - "name": "Color", - "errors": [ - { - "message": "No Parameter Values provided", - "reason": "noParameterValues" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for creating a numeric parameter", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a parameter with name 'Outside Temperature'. The unit GUID provided did not match any known unit. The parameter scaleType was set to 'logarithmic' but one of the parameter values is less than or equal to zero.", - "value": { - "message": "Cannot create Parameter 'Outside Temperature'.", - "code": "parameterCreation", - "name": "Outside Temperature", - "errors": [ - { - "message": "Could not find Unit with GUID 'f1bb75a1-555d-4e00-aad2-5acd60975f52'.", - "reason": "noSuchUnit", - "guid": "f1bb75a1-555d-4e00-aad2-5acd60975f52" - }, - { - "message": "Parameter Value is not valid.", - "reason": "parameterValue", - "errors": [ - { - "message": "For a log-scale Parameter, all values must be greater than zero.", - "reason": "logScaleNegative" - } - ] - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateNumericParameter: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "sortCriteria": [] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}": { - "get": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Get a parameter with a specified guid for a given database.", - "operationId": "GetParameter", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameter" }, - "example": { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - }, - { - "type": "numeric", - "value": 1.0, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" - } - } - } - }, - "404": { - "description": "Database or parameter not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Update a parameter.", - "operationId": "UpdateParameter", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", + "Example 47": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "6f8fb656-9786-48e2-8ecd-832accc4dedd" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", + "Example 48": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "01ffd341-e851-40e0-9c06-25ba584aac91" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", + "Example 49": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "type": "numeric", - "guid": "73ef8f41-af69-4e53-a11d-5ac7151be2c0" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", + "Example 50": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "type": "discrete", - "name": "Strain (Updated)" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "Example 51": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "guid": "d01f6d80-d03e-40d1-9ea3-6e7a6e138ea7" + "sortCriteria": [] } }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", + "Example 52": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "type": "numeric", - "unit": null + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", + "Example 53": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + "Example 54": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" }, - { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", - "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "6f8fb656-9786-48e2-8ecd-832accc4dedd" - } - }, - "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", - "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "01ffd341-e851-40e0-9c06-25ba584aac91" + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", + "Example 55": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "type": "numeric", - "guid": "73ef8f41-af69-4e53-a11d-5ac7151be2c0" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", + "Example 56": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "type": "discrete", - "name": "Strain (Updated)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "Example 57": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - "guid": "d01f6d80-d03e-40d1-9ea3-6e7a6e138ea7" + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", + "Example 58": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "type": "numeric", - "unit": null + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", + "Example 59": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + "Example 60": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" }, - { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - ] + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { - "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", + "Example 31": { + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "6f8fb656-9786-48e2-8ecd-832accc4dedd" - } - }, - "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", - "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "01ffd341-e851-40e0-9c06-25ba584aac91" - } - }, - "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", - "value": { - "type": "numeric", - "guid": "73ef8f41-af69-4e53-a11d-5ac7151be2c0" - } - }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", - "value": { - "type": "discrete", - "name": "Strain (Updated)" + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "Example 32": { + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" }, - "guid": "d01f6d80-d03e-40d1-9ea3-6e7a6e138ea7" + "sortCriteria": [] } }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", + "Example 33": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "type": "numeric", - "unit": null + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", + "Example 34": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + "Example 35": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", - "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "6f8fb656-9786-48e2-8ecd-832accc4dedd" - } - }, - "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", - "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "01ffd341-e851-40e0-9c06-25ba584aac91" - } - }, - "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", - "value": { - "type": "numeric", - "guid": "73ef8f41-af69-4e53-a11d-5ac7151be2c0" - } - }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", - "value": { - "type": "discrete", - "name": "Strain (Updated)" - } }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "Example 36": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "guid": "d01f6d80-d03e-40d1-9ea3-6e7a6e138ea7" + "sortCriteria": [] } }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", + "Example 37": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "type": "numeric", - "unit": null + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", + "Example 38": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + "Example 39": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameter" - }, - "example": { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - }, - { - "type": "numeric", - "value": 1.0, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterUpdateException" - }, - "examples": { - "Example 1": { - "summary": "No such unit", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the unit of the 'Temperature' parameter with GUID '00000001-000a-4fff-8fff-0000ffff0000', but the unit GUID provided did not match any known unit.", - "value": { - "message": "Cannot update Parameter with GUID '00000001-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterUpdate", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "Could not find Unit with GUID 'e18afbec-c27d-41ed-9444-a1ad3128da91'.", - "reason": "noSuchUnit", - "guid": "e18afbec-c27d-41ed-9444-a1ad3128da91" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for updating a numeric parameter", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'Stress Ratio' parameter with GUID '00000004-000a-4fff-8fff-0000ffff0000'. The unit GUID provided did not match any known unit. The parameter scaleType was set to 'logarithmic', which is invalid because one of the parameter values is less than or equal to zero.", - "value": { - "message": "Cannot update Parameter with GUID '00000004-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterUpdate", - "parameterGuid": "00000004-000a-4fff-8fff-0000ffff0000", - "errors": [ + "criterion": { + "all": [], + "any": [ { - "message": "Could not find Unit with GUID '28a6be68-4a54-4769-ada4-63058dc03bf7'.", - "reason": "noSuchUnit", - "guid": "28a6be68-4a54-4769-ada4-63058dc03bf7" + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "message": "Parameter Value is not valid.", - "reason": "parameterValue", - "errors": [ + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, { - "message": "For a log-scale Parameter, all values must be greater than zero.", - "reason": "logScaleNegative" + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" } - ] + ], + "any": [], + "none": [], + "type": "boolean" } - ] - } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or parameter not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Delete a parameter.", - "operationId": "DeleteParameter", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. Parameter in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterDeletionException" }, - "example": { - "message": "Cannot delete Parameter with GUID '00000005-000a-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "entityType": "parameter", - "entityGuid": "00000005-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more attributes.", - "reason": "usage", - "referencedByType": "attribute", - "referencedBy": [ + "Example 40": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", + "value": { + "criterion": { + "all": [], + "any": [ { - "type": "floatFunctional", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" }, - "name": "Tensile strength with temperature", - "guid": "00000002-0001-4fff-8fff-dd92ffff0000" + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } - ] - } - ] - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or parameter not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}:usages": { - "get": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Get attributes which currently use the given parameter.", - "operationId": "GetObjectsUsingParameter", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimObjects" - } - } - } - }, - "404": { - "description": "Database or parameter not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values/{parameter-value-guid}": { - "get": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Get a parameter value with a specified guid for a given database for a given parameter.", - "operationId": "GetParameterValue", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "parameter-value-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValue" - }, - "example": { - "type": "numeric", - "value": 0.1, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - } - } - } - }, - "404": { - "description": "Database, parameter or parameter value not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Update a parameter value.", - "operationId": "UpdateParameterValue", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "parameter-value-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "f06d9eef-6e26-49a4-8569-085973e7dac7" + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "Example 41": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "c757e7f3-5f45-44af-a7fd-b93e20527b73" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", - "value": { - "type": "numeric", - "guid": "0cab34e7-f2cc-4239-a04b-cc7794587990" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 42": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "f06d9eef-6e26-49a4-8569-085973e7dac7" + "criterion": { + "recordListIdentifiers": [ + "c06f99d2-48e3-41d6-8941-f5a03c543d5f", + "5f193496-fb65-4453-af78-d75a0b9e35b5" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "Example 43": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "c757e7f3-5f45-44af-a7fd-b93e20527b73" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "Example 44": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "type": "numeric", - "guid": "0cab34e7-f2cc-4239-a04b-cc7794587990" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 45": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "f06d9eef-6e26-49a4-8569-085973e7dac7" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "Example 46": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "c757e7f3-5f45-44af-a7fd-b93e20527b73" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "Example 47": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "type": "numeric", - "guid": "0cab34e7-f2cc-4239-a04b-cc7794587990" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 48": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "f06d9eef-6e26-49a4-8569-085973e7dac7" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "Example 49": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "c757e7f3-5f45-44af-a7fd-b93e20527b73" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "Example 50": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "type": "numeric", - "guid": "0cab34e7-f2cc-4239-a04b-cc7794587990" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValue" - }, - "example": { - "type": "numeric", - "value": 0.1, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - } - } - } - }, - "400": { - "description": "Bad request. Parameter in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValueUpdateException" }, - "examples": { - "Example 1": { - "summary": "Name already exists.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'A-basis' parameter value with GUID '505b5d32-0a4a-48af-9a7a-90c4caacd35c' on 'Basis' parameter with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'. The name was set to 'Mean', which is invalid because there is already a parameter value with that name on this parameter.", - "value": { - "message": "Cannot update Parameter Value with GUID '505b5d32-0a4a-48af-9a7a-90c4caacd35c' on Parameter with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'.", - "code": "parameterValueUpdate", - "parameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f", - "errors": [ - { - "message": "The Parameter Value name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Parameter Value with name 'Mean' already exists in this Parameter.", - "reason": "nameAlreadyExists", - "name": "Mean", - "parentEntityType": "parameter", - "entityType": "parameterValue" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for updating a numeric parameter value", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update Batch Size 1000 parameter value with GUID '00000010-000b-4fff-8fff-0010ffff0000' on 'Batch Size' parameter with GUID '00000010-000a-4fff-8fff-0000ffff0000'. The name was set to 'Batch size A ', which is invalid because it has trailing white space. The parameter value was set to be negative, which is invalid because the parameter scaleType is 'logarithmic'. For a log-scale parameter, all values must be greater than zero.", - "value": { - "message": "Cannot update Parameter Value with GUID '00000010-000b-4fff-8fff-0010ffff0000' on Parameter with GUID '00000010-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterValueUpdate", - "parameterValueGuid": "00000010-000b-4fff-8fff-0010ffff0000", - "parameterGuid": "00000010-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "For a log-scale Parameter, all values must be greater than zero.", - "reason": "logScaleNegative" + "Example 51": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", + "value": { + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - { - "message": "Parameter Value name cannot contain leading or trailing whitespace.", - "reason": "nameWhitespace", - "name": "Batch size A " - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "UpdateNumericParameterValue: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, parameter or parameter value not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Delete a parameter value.", - "operationId": "DeleteParameterValue", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "parameter-value-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. Parameter in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValueDeletionException" }, - "example": { - "message": "Cannot delete Parameter Value with GUID '21a27377-12eb-413c-bac4-d4ffceda39d1'.", - "code": "deletion", - "entityType": "parameterValue", - "entityGuid": "21a27377-12eb-413c-bac4-d4ffceda39d1", - "errors": [ - { - "message": "It is being used as the Parameter default value.", - "reason": "usage", - "referencedByType": "defaultParameterValue", - "referencedBy": [ - { - "name": "Basis", - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] - }, - { - "message": "It is being used by multi-valued point data.", - "reason": "usage", - "referencedByType": "multiValuedPointData" - } - ] - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, parameter or parameter value not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values": { - "post": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Create a new parameter value.", - "operationId": "CreateParameterValue", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "parameter-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 52": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "Example 53": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "type": "discrete", - "name": "Heavy water" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 54": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "Example 55": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "type": "discrete", - "name": "Heavy water" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 56": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "Example 57": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "type": "discrete", - "name": "Heavy water" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" - } - }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Heavy water" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValue" - }, - "example": { - "type": "numeric", - "value": 0.1, - "parameterGuid": "00000000-0000-0000-0000-000000000000", - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - } - } - } - }, - "400": { - "description": "Bad request. Parameter in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValueCreationException" - }, - "examples": { - "Example 1": { - "summary": "Parameter value type does not match the type of the parameter.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a numeric parameter value with name 'A New Basis' on discrete parameter 'Basis' with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'. Discrete parameters cannot have numeric parameter values.", - "value": { - "message": "Cannot create Parameter Value 'A New Basis' on Parameter with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'.", - "code": "parameterValueCreation", - "name": "A New Basis", - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f", - "errors": [ - { - "message": "Discrete Parameters cannot have Numeric Parameter Values.", - "reason": "parameterValueType", - "parameterType": "discrete" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for creating a numeric parameter value", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a numeric parameter value with name 'Batch size A ' on parameter 'Batch Size' with GUID '00000010-000a-4fff-8fff-0000ffff0000'. The name was set to 'Batch size A ', which is invalid because it has trailing white space. The parameter value was set to be negative, which is invalid because the parameter scaleType is 'logarithmic'. For a log-scale parameter, all values must be greater than zero.", - "value": { - "message": "Cannot create Parameter Value 'Minimum' on Parameter with GUID '00000010-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterValueCreation", - "name": "Minimum", - "parameterGuid": "00000010-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "The Parameter Value name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Parameter Value with name 'Minimum' already exists in this Parameter.", - "reason": "nameAlreadyExists", - "name": "Minimum", - "parentEntityType": "parameter", - "entityType": "parameterValue" - } - ] - }, - { - "message": "For a log-scale Parameter, all values must be greater than zero.", - "reason": "logScaleNegative" - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateNumericParameterValue: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or parameter not found" - } - } - } - }, - "/v1alpha/profiles": { - "get": { - "tags": [ - "Schema - Profiles" - ], - "summary": "Get AllProfilesInfo", - "operationId": "GetProfiles", - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAllProfilesInfo" - }, - "example": { - "profiles": [ - { - "key": "MI_Training", - "isImplicit": true, - "name": "MI Training" - }, - { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - }, - { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Composites" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - { - "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Additive Manufacturing" - } - ], - "defaultProfile": { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - } - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - }, - "patch": { - "tags": [ - "Schema - Profiles" - ], - "summary": "Update AllProfilesInfo", - "operationId": "UpdateAllProfilesInfo", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" - }, - "examples": { - "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", - "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 } } }, - "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", - "value": { - "defaultProfile": null - } - }, - "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "Example 58": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + "sortDirection": "ascending", + "type": "relevance" } ] } }, - "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "Example 59": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 60": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } }, - "application/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { - "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", - "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - }, - "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", - "value": { - "defaultProfile": null - } - }, - "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "Example 31": { + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "localColumns": { + "filterOn": "all" }, + "type": "text" + }, + "sortCriteria": [ { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + "sortDirection": "ascending", + "type": "relevance" } ] } }, - "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "Example 32": { + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "localColumns": { + "filterOn": "none" }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" - }, - "examples": { - "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", - "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - }, - "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", - "value": { - "defaultProfile": null + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "Example 33": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ] + "type": "text" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "Example 34": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "localColumns": { + "filterOn": "none" }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" - }, - "examples": { - "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", - "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - }, - "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", - "value": { - "defaultProfile": null + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "Example 35": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } ] } }, - "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "Example 36": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "criterion": { + "innerCriterion": { + "type": "integer" }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAllProfilesInfo" - }, - "example": { - "profiles": [ - { - "key": "MI_Training", - "isImplicit": true, - "name": "MI Training" - }, - { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - }, - { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Composites" + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - { - "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Additive Manufacturing" - } - ], - "defaultProfile": { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" + "sortCriteria": [] } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile not found" - } - } - }, - "post": { - "tags": [ - "Schema - Profiles" - ], - "summary": "Create a new profile", - "operationId": "CreateProfile", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" - }, - "examples": { - "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + }, + "Example 37": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "name": "MI:Training Processes" + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 38": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "name": "MI:Training Processes", - "guid": "c6b2d87a-4e5b-4228-bf72-9cd37023a9d6" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "Example 39": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "656251e5-6709-4bad-8a69-3a640acfd8bd" + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" - }, - "examples": { - "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + }, + "Example 40": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "name": "MI:Training Processes" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 41": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "name": "MI:Training Processes", - "guid": "c6b2d87a-4e5b-4228-bf72-9cd37023a9d6" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "Example 42": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "656251e5-6709-4bad-8a69-3a640acfd8bd" + "criterion": { + "recordListIdentifiers": [ + "c06f99d2-48e3-41d6-8941-f5a03c543d5f", + "5f193496-fb65-4453-af78-d75a0b9e35b5" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" - }, - "examples": { - "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + }, + "Example 43": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "name": "MI:Training Processes" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 44": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "name": "MI:Training Processes", - "guid": "c6b2d87a-4e5b-4228-bf72-9cd37023a9d6" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "Example 45": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "656251e5-6709-4bad-8a69-3a640acfd8bd" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" - }, - "examples": { - "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + }, + "Example 46": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "name": "MI:Training Processes" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 47": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "name": "MI:Training Processes", - "guid": "c6b2d87a-4e5b-4228-bf72-9cd37023a9d6" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "Example 48": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "656251e5-6709-4bad-8a69-3a640acfd8bd" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProfile" }, - "example": { - "description": "#markdown\r\nFor metals-oriented users.", - "homepageUrl": "TrainingProfiles/MITrainingMetals", - "profileTables": [ - { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" + "Example 49": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", + "value": { + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" - } - ], - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/profiles/{profile-guid}": { - "get": { - "tags": [ - "Schema - Profiles" - ], - "summary": "Get individual profile", - "operationId": "GetProfile", - "parameters": [ - { - "name": "profile-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProfile" + "sortCriteria": [] + } }, - "example": { - "description": "#markdown\r\nFor metals-oriented users.", - "homepageUrl": "TrainingProfiles/MITrainingMetals", - "profileTables": [ - { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" - }, - { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" - } - ], - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Profiles" - ], - "summary": "Update a profile", - "operationId": "UpdateProfile", - "parameters": [ - { - "name": "profile-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" - }, - "examples": { - "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 50": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "guid": "b4ee957d-52b6-45d4-8ec3-b4efae12de3b" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 51": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "name": "MI:Training Metals (Updated)" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", - "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" - ], - "guid": "cc08a02a-e9cb-4694-8bb0-50f927f745c3", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" - }, - "examples": { - "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 52": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "guid": "b4ee957d-52b6-45d4-8ec3-b4efae12de3b" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 53": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "name": "MI:Training Metals (Updated)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "Example 54": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" - ], - "guid": "cc08a02a-e9cb-4694-8bb0-50f927f745c3", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" - }, - "examples": { - "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + }, + "Example 55": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "guid": "b4ee957d-52b6-45d4-8ec3-b4efae12de3b" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 56": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "name": "MI:Training Metals (Updated)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "Example 57": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } ], - "guid": "cc08a02a-e9cb-4694-8bb0-50f927f745c3", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" - }, - "examples": { - "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + }, + "Example 58": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "guid": "b4ee957d-52b6-45d4-8ec3-b4efae12de3b" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, - "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 59": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "name": "MI:Training Metals (Updated)" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "Example 60": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" - ], - "guid": "cc08a02a-e9cb-4694-8bb0-50f927f745c3", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } @@ -68427,153 +58340,66 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfile" - }, - "example": { - "description": "#markdown\r\nFor metals-oriented users.", - "homepageUrl": "TrainingProfiles/MITrainingMetals", - "profileTables": [ - { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" - }, - { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" - } - ], - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" } } } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}:search": { + "post": { "tags": [ - "Schema - Profiles" + "Search" ], - "summary": "Delete a profile", - "operationId": "DeleteProfile", + "summary": "Runs a search against a given database", + "operationId": "DatabaseSearch", "parameters": [ { - "name": "profile-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request. Profile is set as default." - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Profile not found" - } - } - } - }, - "/v1alpha/profiles/{profile-guid}/profile-tables": { - "get": { - "tags": [ - "Schema - ProfileTables" - ], - "summary": "Get all profile tables of given profile", - "operationId": "GetProfileTables", - "parameters": [ { - "name": "profile-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProfileTablesInfo" - }, - "example": { - "profileTables": [ - { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" - }, - { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" - } - ] - } - } + "enum": [ + "read", + "write" + ], + "type": "string" } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile not found" - } - } - }, - "post": { - "tags": [ - "Schema - ProfileTables" - ], - "summary": "Create a new profile table", - "operationId": "CreateProfileTable", - "parameters": [ { - "name": "profile-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -68581,4403 +58407,3592 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "cdff6131-197d-4560-830e-c1f96c44b5e3" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "a0bf665d-edd4-40be-85c3-e692ae45bf50" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + }, + "Example 4": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "cdff6131-197d-4560-830e-c1f96c44b5e3" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" + } + ] } }, - "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "a0bf665d-edd4-40be-85c3-e692ae45bf50" + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + }, + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "cdff6131-197d-4560-830e-c1f96c44b5e3" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "a0bf665d-edd4-40be-85c3-e692ae45bf50" + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + }, + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "cdff6131-197d-4560-830e-c1f96c44b5e3" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "a0bf665d-edd4-40be-85c3-e692ae45bf50" + "criterion": { + "recordListIdentifiers": [ + "d71d5081-0da4-4fff-af36-390934de7152", + "1ea86480-40d0-4a0e-bbce-c0930feb4c8e" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProfileTable" }, - "example": { - "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", - "subsetFallbackHint": "Metals", - "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", - "layoutFallbackHint": "Metals", - "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "Design Data" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile not found" - } - } - } - }, - "/v1alpha/profiles/{profile-guid}/profile-tables/{profile-table-guid}": { - "get": { - "tags": [ - "Schema - ProfileTables" - ], - "summary": "Get individual profile table", - "operationId": "GetProfileTable", - "parameters": [ - { - "name": "profile-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "profile-table-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProfileTable" + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", + "value": { + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] + } }, - "example": { - "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", - "subsetFallbackHint": "Metals", - "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", - "layoutFallbackHint": "Metals", - "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "Design Data" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile or profile table not found" - } - } - }, - "patch": { - "tags": [ - "Schema - ProfileTables" - ], - "summary": "Update a profile table", - "operationId": "UpdateProfileTable", - "parameters": [ - { - "name": "profile-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "profile-table-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "4407b50a-7ca8-4e0e-8fa1-6f655c7759f6" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "subsetGuid": null, - "layoutGuid": null + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "guid": "0b98dc3e-625c-4838-82b6-8109cccc2301" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + }, + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "4407b50a-7ca8-4e0e-8fa1-6f655c7759f6" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "subsetGuid": null, - "layoutGuid": null + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "guid": "0b98dc3e-625c-4838-82b6-8109cccc2301" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + }, + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "4407b50a-7ca8-4e0e-8fa1-6f655c7759f6" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "subsetGuid": null, - "layoutGuid": null + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "guid": "0b98dc3e-625c-4838-82b6-8109cccc2301" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + }, + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "4407b50a-7ca8-4e0e-8fa1-6f655c7759f6" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "subsetGuid": null, - "layoutGuid": null + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "guid": "0b98dc3e-625c-4838-82b6-8109cccc2301" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProfileTable" }, - "example": { - "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", - "subsetFallbackHint": "Metals", - "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", - "layoutFallbackHint": "Metals", - "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "Design Data" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile or profile table not found" - } - } - }, - "delete": { - "tags": [ - "Schema - ProfileTables" - ], - "summary": "Delete a profile table", - "operationId": "DeleteProfileTable", - "parameters": [ - { - "name": "profile-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "profile-table-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile or profile table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/quality-systems": { - "get": { - "tags": [ - "Schema - Quality Systems" - ], - "summary": "Get all quality systems", - "operationId": "GetQualitySystems", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQualitySystemsInfo" - }, - "examples": { - "Example 1": { - "summary": "Quality Systems", - "description": "Example of quality systems from the MI Training database", - "value": { - "qualitySystems": [ - { - "type": "continuous", - "doesQualityDecreaseWithValue": false, - "thresholdValue": 5.0, - "name": "Test Numerical Quality System", - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" - }, - { - "type": "discrete", - "thresholdValue": { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" - }, - "qualityDiscreteValues": [ - { - "order": 1, - "name": "Poor", - "guid": "0f5a2257-a633-46e7-92b8-b504a8bdbb34" - }, - { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" - }, - { - "order": 3, - "name": "Good", - "guid": "dc966885-a72e-4370-ad48-3b7e45c5729f" - } - ], - "name": "Test Data Quality System", - "guid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Quality Systems" - ], - "summary": "Create a new quality system.", - "operationId": "CreateQualitySystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateQualitySystem" - }, - "examples": { - "Example 1": { - "summary": "Continuous Quality System - Quality increases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality increases with the quality value.", - "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": false, - "thresholdValue": 7.0, - "name": "Continuous Quality System - Quality Increases with Value" - } - }, - "Example 2": { - "summary": "Continuous Quality System - Quality decreases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality decreases with the quality value.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": true, - "thresholdValue": 2.5, - "name": "Continuous Quality System - Quality Decreases with Value" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Discrete Quality System ", - "description": "This example demonstrates how to create a new discrete quality system.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "type": "discrete", - "thresholdValueName": "Medium", - "qualityDiscreteValues": [ - { - "name": "Low" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - { - "name": "Medium" + "localColumns": { + "filterOn": "all" }, + "type": "text" + }, + "sortCriteria": [ { - "name": "High" + "sortDirection": "ascending", + "type": "relevance" } ], - "name": "Discrete Quality System" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateQualitySystem" - }, - "examples": { - "Example 1": { - "summary": "Continuous Quality System - Quality increases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality increases with the quality value.", + }, + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": false, - "thresholdValue": 7.0, - "name": "Continuous Quality System - Quality Increases with Value" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, - "Example 2": { - "summary": "Continuous Quality System - Quality decreases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality decreases with the quality value.", + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": true, - "thresholdValue": 2.5, - "name": "Continuous Quality System - Quality Decreases with Value" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Discrete Quality System ", - "description": "This example demonstrates how to create a new discrete quality system.", + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "type": "discrete", - "thresholdValueName": "Medium", - "qualityDiscreteValues": [ - { - "name": "Low" - }, - { - "name": "Medium" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" }, - { - "name": "High" - } - ], - "name": "Discrete Quality System" + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 31": { + "summary": "Free text search in multiple tables by table GUID", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", + "value": { + "criterion": { + "all": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "property": "tableGuid", + "innerCriterion": { + "all": [], + "any": [ + "0000dd92-0011-4fff-8fff-0000ffff0000", + "0000b5e2-0011-4fff-8fff-0000ffff0000" + ], + "none": [], + "type": "discreteGuidValues" + }, + "type": "recordProperty" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 32": { + "summary": "Free text search in multiple tables by table name", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", + "value": { + "criterion": { + "all": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [], + "any": [ + { + "property": "tableName", + "innerCriterion": { + "value": "MaterialUniverse", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" + }, + { + "property": "tableName", + "innerCriterion": { + "value": "Design Data", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" + } + ], + "none": [], + "type": "boolean" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } } } }, - "text/json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateQualitySystem" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Continuous Quality System - Quality increases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality increases with the quality value.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": false, - "thresholdValue": 7.0, - "name": "Continuous Quality System - Quality Increases with Value" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Continuous Quality System - Quality decreases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality decreases with the quality value.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": true, - "thresholdValue": 2.5, - "name": "Continuous Quality System - Quality Decreases with Value" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, "Example 3": { - "summary": "Discrete Quality System ", - "description": "This example demonstrates how to create a new discrete quality system.", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "type": "discrete", - "thresholdValueName": "Medium", - "qualityDiscreteValues": [ - { - "name": "Low" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" }, - { - "name": "Medium" + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" }, - { - "name": "High" - } - ], - "name": "Discrete Quality System" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateQualitySystem" - }, - "examples": { - "Example 1": { - "summary": "Continuous Quality System - Quality increases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality increases with the quality value.", - "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": false, - "thresholdValue": 7.0, - "name": "Continuous Quality System - Quality Increases with Value" + "type": "text" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Continuous Quality System - Quality decreases with value", - "description": "This example demonstrates how to create a new continuous quality system where the quality decreases with the quality value.", + "Example 4": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": true, - "thresholdValue": 2.5, - "name": "Continuous Quality System - Quality Decreases with Value" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Discrete Quality System ", - "description": "This example demonstrates how to create a new discrete quality system.", + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "type": "discrete", - "thresholdValueName": "Medium", - "qualityDiscreteValues": [ - { - "name": "Low" - }, - { - "name": "Medium" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "name": "High" + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } - ], - "name": "Discrete Quality System" + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQualitySystem" }, - "examples": { - "Example 3": { - "summary": "Continuous Quality system", - "description": "Example response for the 'Test Numerical Quality system' quality system from the MI Training database", - "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": false, - "thresholdValue": 5.0, - "name": "Test Numerical Quality system", - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" - } - }, - "Example 4": { - "summary": "Discrete Quality system", - "description": "Example response for the 'Test Data Quality system' quality system from the MI Training database", - "value": { - "type": "discrete", - "thresholdValue": { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", + "value": { + "criterion": { + "innerCriterion": { + "type": "integer" }, - "qualityDiscreteValues": [ + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", + "value": { + "criterion": { + "all": [ { - "order": 1, - "name": "Poor", - "guid": "0f5a2257-a633-46e7-92b8-b504a8bdbb34" + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, { - "order": 3, - "name": "Good", - "guid": "dc966885-a72e-4370-ad48-3b7e45c5729f" + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } ], - "name": "Test Data Quality system", - "guid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - } + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQualitySystemCreationException" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/quality-systems/{quality-system-guid}": { - "get": { - "tags": [ - "Schema - Quality Systems" - ], - "summary": "Get individual quality system", - "operationId": "GetQualitySystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "quality-system-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQualitySystem" }, - "examples": { - "Example 1": { - "summary": "Continuous Quality system", - "description": "Example response for the 'Test Numerical Quality system' quality system from the MI Training database", - "value": { - "type": "continuous", - "doesQualityDecreaseWithValue": false, - "thresholdValue": 5.0, - "name": "Test Numerical Quality system", - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" - } - }, - "Example 2": { - "summary": "Discrete Quality system", - "description": "Example response for the 'Test Data Quality system' quality system from the MI Training database", - "value": { - "type": "discrete", - "thresholdValue": { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", + "value": { + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - "qualityDiscreteValues": [ - { - "order": 1, - "name": "Poor", - "guid": "0f5a2257-a633-46e7-92b8-b504a8bdbb34" - }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", + "value": { + "criterion": { + "all": [], + "any": [ { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "order": 3, - "name": "Good", - "guid": "dc966885-a72e-4370-ad48-3b7e45c5729f" + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" } ], - "name": "Test Data Quality system", - "guid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - } + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - } - }, - "404": { - "description": "Database or quality system not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Quality Systems" - ], - "summary": "Delete a quality system.", - "operationId": "DeleteQualitySystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "quality-system-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQualitySystemDeletionException" }, - "example": { - "message": "Cannot delete Quality System with GUID 'a66c5a87-4779-44fe-85cf-d7c5f4b820eb'.", - "code": "deletion", - "entityType": "qualitySystem", - "entityGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "errors": [ - { - "message": "It is being used in one or more tables.", - "reason": "usage", - "referencedByType": "table", - "referencedBy": [ + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", + "value": { + "criterion": { + "all": [], + "any": [ { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "Material Universe", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "Design Data", - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - } - ] - } - ] - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups": { - "get": { - "tags": [ - "Schema - Record Link Groups" - ], - "summary": "Get all record link groups pointing from this table.", - "operationId": "GetRecordLinkGroups", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroupsInfo" - }, - "example": { - "recordLinkGroups": [ - { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "identity": 115, - "reverseName": "Training Exercise", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "MaterialUniverse", - "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - }, - { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "manyToMany", - "attributePairs": [ { - "attributeSource": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "9bd8599e-36e0-4008-b52e-2f70b90c00a0" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" }, - "attributeTarget": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "000001cb-0001-4fff-8fff-dd92ffff0000" - } + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "identity": 3, - "reverseName": "Smart Link to Training Record", - "reverseDisplayNames": { - "en": "en-Smart Link to Training Record", - "fr": "fr-Smart Link to Training Record" - }, - "displayNames": { - "en": "en-Smart Link to MaterialUniverse", - "fr": "fr-Smart Link to MaterialUniverse" - }, - "name": "Smart Link to MaterialUniverse", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "none": [], + "type": "boolean" }, - { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "linkTarget": { - "databaseGuid": "665d155f-52dc-46f9-9c7b-52b1ada5db72", - "tableGuid": "7efb50b8-208a-4bdd-8b95-ffcf2cec5465" - } - }, - "identity": 1, - "reverseName": "Second Training Database And Table - MI Training Exercise for Import", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "MI Training Exercise for Import - Second Training Database And Table", - "guid": "a815204c-ccea-46d6-9521-e862d50d9c56" - } - ] - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - }, - "post": { - "tags": [ - "Schema - Record Link Groups" - ], - "summary": "Create a new record link group.", - "operationId": "CreateRecordLinkGroup", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] + } + }, + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + "criterion": { + "recordListIdentifiers": [ + "d71d5081-0da4-4fff-af36-390934de7152", + "1ea86480-40d0-4a0e-bbce-c0930feb4c8e" + ], + "type": "recordListMember" }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "9e5ba258-0bc2-4a18-85ba-6311bcfd8d7a" + "sortCriteria": [] } }, - "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "9bfc37d7-649d-4dd8-8a89-ed48f05c0629" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "sortCriteria": [] } }, - "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "f657283c-0196-428f-ac39-4b1aa0da8768", - "tableGuid": "9085328c-022b-4944-9f7f-314802ff8782" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "bd30e003-f454-44a0-b763-8311ad870c53" + "sortCriteria": [] } }, - "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + "sortCriteria": [] } }, - "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" - }, - { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" - } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "435a2019-8e7d-4aea-b5aa-4eaf65b15468" + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + }, + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "9e5ba258-0bc2-4a18-85ba-6311bcfd8d7a" + "sortCriteria": [] } }, - "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "9bfc37d7-649d-4dd8-8a89-ed48f05c0629" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "sortCriteria": [] } }, - "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "f657283c-0196-428f-ac39-4b1aa0da8768", - "tableGuid": "9085328c-022b-4944-9f7f-314802ff8782" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "bd30e003-f454-44a0-b763-8311ad870c53" + "sortCriteria": [] } }, - "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + "sortCriteria": [] } }, - "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" - } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "435a2019-8e7d-4aea-b5aa-4eaf65b15468" + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + }, + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "9e5ba258-0bc2-4a18-85ba-6311bcfd8d7a" + "sortCriteria": [] } }, - "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "9bfc37d7-649d-4dd8-8a89-ed48f05c0629" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "sortCriteria": [] } }, - "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "f657283c-0196-428f-ac39-4b1aa0da8768", - "tableGuid": "9085328c-022b-4944-9f7f-314802ff8782" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "bd30e003-f454-44a0-b763-8311ad870c53" + "sortCriteria": [] } }, - "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ + "sortCriteria": [ { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" + "sortDirection": "ascending", + "type": "relevance" } ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" + "sortDirection": "ascending", + "type": "relevance" } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "435a2019-8e7d-4aea-b5aa-4eaf65b15468" + ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + }, + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "9e5ba258-0bc2-4a18-85ba-6311bcfd8d7a" + "sortCriteria": [] } }, - "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "Example 31": { + "summary": "Free text search in multiple tables by table GUID", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "9bfc37d7-649d-4dd8-8a89-ed48f05c0629" + "criterion": { + "all": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "property": "tableGuid", + "innerCriterion": { + "all": [], + "any": [ + "0000dd92-0011-4fff-8fff-0000ffff0000", + "0000b5e2-0011-4fff-8fff-0000ffff0000" + ], + "none": [], + "type": "discreteGuidValues" + }, + "type": "recordProperty" + } + ], + "any": [], + "none": [], + "type": "boolean" }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "sortCriteria": [] } }, - "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "Example 32": { + "summary": "Free text search in multiple tables by table name", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "f657283c-0196-428f-ac39-4b1aa0da8768", - "tableGuid": "9085328c-022b-4944-9f7f-314802ff8782" + "criterion": { + "all": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [], + "any": [ + { + "property": "tableName", + "innerCriterion": { + "value": "MaterialUniverse", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" + }, + { + "property": "tableName", + "innerCriterion": { + "value": "Design Data", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" + } + ], + "none": [], + "type": "boolean" + } + ], + "any": [], + "none": [], + "type": "boolean" }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "bd30e003-f454-44a0-b763-8311ad870c53" + "sortCriteria": [] } - }, - "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ + "sortCriteria": [ { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" + "sortDirection": "ascending", + "type": "relevance" } - ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + ] } }, - "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "Example 2": { + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" + "sortCriteria": [] + } + }, + "Example 3": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", + "value": { + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] + } + }, + "Example 4": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", + "value": { + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] + } + }, + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", + "value": { + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "435a2019-8e7d-4aea-b5aa-4eaf65b15468" + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" }, - "examples": { - "Example 4": { - "summary": "Static record link group", - "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - } + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", + "value": { + "criterion": { + "innerCriterion": { + "type": "integer" }, - "identity": 125, - "reverseName": "Fatigue Statistical Data", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Fatigue Test Data", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - } - }, - "Example 5": { - "summary": "Cross database record link group", - "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", - "value": { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", + "value": { + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "a6f47f98-10e2-47c1-ae52-cae222ecabac", - "tableGuid": "56e2f2e9-5c24-4fe6-a2b4-b52bdcc1011c" - } - }, - "identity": 1, - "reverseName": "MI Training - MaterialUniverse", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Different database - different table", - "guid": "7758b55a-1c8a-461a-89c4-f6034ad514db" - } - }, - "Example 6": { - "summary": "Smart record link group", - "description": "This example demonstrates the returned value from getting a 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", - "value": { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ { - "attributeSource": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" }, - "attributeTarget": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" - } - } - ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", + "value": { + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" }, - "identity": 8, - "reverseName": "Further panel information", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Tensile test data", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroupCreationException" }, - "examples": { - "Example 1": { - "summary": "Static record link group with duplicate name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a static link group with name 'Design Data', but there is already a static record link group with that name.", - "value": { - "message": "Cannot create Record Link Group 'Design Data'.", - "code": "recordLinkGroupCreation", - "name": "Design Data", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Record Link Group with name 'Design Data' already exists in this Table.", - "reason": "nameAlreadyExists", - "name": "Design Data", - "parentEntityType": "table", - "entityType": "recordLinkGroup" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Smart record link group with multiple errors", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a smart link group with name 'Process', but: the name is the same as the reverse name, one of the specified linking attributes could not be found, and one of the specified linking attributes is duplicated.", - "value": { - "message": "Cannot create Record Link Group 'Process'.", - "code": "recordLinkGroupCreation", - "name": "Process", - "errors": [ + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", + "value": { + "criterion": { + "all": [], + "any": [ { - "message": "Record Link Group name and reverse name cannot be the same.", - "reason": "nameSameAsReverseName" + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "message": "The Attributes used as linking Attribute pairs for a Smart Link Group are not valid.", - "reason": "smartAttributes", - "errors": [ + "all": [ { - "message": "Could not find Attribute with GUID '8210f958-e088-4264-956b-224c39378bc0' in Table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000' in database 'MI_TRAINING'.", - "reason": "noSuchAttribute", - "databaseKey": "MI_TRAINING", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "8210f958-e088-4264-956b-224c39378bc0" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, { - "message": "Smart Record Link Group source and target Attributes cannot contain duplicates. Attribute with GUID '0000000b-0001-4fff-8fff-dd92ffff0000' has already been specified in Table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'. ", - "reason": "attributeAlreadySpecified", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" } - ] + ], + "any": [], + "none": [], + "type": "boolean" } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateStaticRecordLinkGroup: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Schema - Record Link Groups" - ], - "summary": "Get individual record link group", - "operationId": "GetRecordLinkGroup", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" }, - "examples": { - "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", + "value": { + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - } - }, - "identity": 125, - "reverseName": "Fatigue Statistical Data", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Fatigue Test Data", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - } - }, - "Example 2": { - "summary": "Cross database record link group", - "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", - "value": { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "5c2cf436-9fcb-4741-85ad-051a71d2b75e", - "tableGuid": "b5609de5-3344-4638-8fa3-7496e88b2b6a" - } - }, - "identity": 1, - "reverseName": "MI Training - MaterialUniverse", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Different database - different table", - "guid": "38540540-e6bf-4be9-8554-ae26f0f8b71c" - } - }, - "Example 3": { - "summary": "Smart record link group", - "description": "This example demonstrates the returned value from getting a 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", - "value": { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ { - "attributeSource": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" }, - "attributeTarget": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" - } + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - } - }, - "identity": 8, - "reverseName": "Further panel information", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Tensile test data", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - } - } - } - } - }, - "404": { - "description": "Database, table or record link group not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Record Link Groups" - ], - "summary": "Delete a record link group.", - "operationId": "DeleteRecordLinkGroup", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}": { - "patch": { - "tags": [ - "Schema - Record Link Groups" - ], - "summary": "Update record link group.", - "operationId": "UpdateRecordLinkGroup", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", - "value": { - "type": "static", - "guid": "d0449b87-3274-4814-ab97-876272f2055b" - } - }, - "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", - "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" - } - }, - "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", - "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c9e9d444-1f47-44ff-bfbb-89e9d74b5ece" - } - }, - "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "430c0f34-3231-49d7-8126-48814fbd73d1" + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" } - ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "93ba2414-7212-47f5-8939-ccce9927e914" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", - "value": { - "type": "static", - "guid": "d0449b87-3274-4814-ab97-876272f2055b" - } - }, - "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", - "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" + ] } }, - "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c9e9d444-1f47-44ff-bfbb-89e9d74b5ece" + "criterion": { + "recordListIdentifiers": [ + "d71d5081-0da4-4fff-af36-390934de7152", + "1ea86480-40d0-4a0e-bbce-c0930feb4c8e" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "430c0f34-3231-49d7-8126-48814fbd73d1" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", - "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" - }, - { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" - } - ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "93ba2414-7212-47f5-8939-ccce9927e914" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "type": "static", - "guid": "d0449b87-3274-4814-ab97-876272f2055b" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c9e9d444-1f47-44ff-bfbb-89e9d74b5ece" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "430c0f34-3231-49d7-8126-48814fbd73d1" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" }, - { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" - } - ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "93ba2414-7212-47f5-8939-ccce9927e914" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" - }, - "examples": { - "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", - "value": { - "type": "static", - "guid": "d0449b87-3274-4814-ab97-876272f2055b" + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c9e9d444-1f47-44ff-bfbb-89e9d74b5ece" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "430c0f34-3231-49d7-8126-48814fbd73d1" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" - } - ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "93ba2414-7212-47f5-8939-ccce9927e914" + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" }, - "examples": { - "Example 10": { - "summary": "Static record link group", - "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - } + "localRowsBehavior": "AllRows", + "type": "link" }, - "identity": 125, - "reverseName": "Fatigue Statistical Data", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Fatigue Test Data", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - } - }, - "Example 11": { - "summary": "Cross database record link group", - "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", - "value": { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "36eb2862-6ec5-49cc-9ef0-9316dffccbb5", - "tableGuid": "1dd11256-e5bb-490f-85ed-a796dae6e219" - } + "localRowsBehavior": "AllRows", + "type": "link" }, - "identity": 1, - "reverseName": "MI Training - MaterialUniverse", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Different database - different table", - "guid": "e14c74a4-997f-4cb0-b966-92c8b7326676" - } - }, - "Example 12": { - "summary": "Smart record link group", - "description": "This example demonstrates the returned value from getting a 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", - "value": { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", + "value": { + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" }, - "attributeTarget": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" - } - } - ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - } + "localRowsBehavior": "AllRows", + "type": "link" }, - "identity": 8, - "reverseName": "Further panel information", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Tensile test data", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", + "value": { + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 } } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroupUpdateException" }, - "examples": { - "Example 1": { - "summary": "Static record link group with duplicate name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update 'Fatigue Test Data' static link group to have name 'Design Data', but there is already a static record link group with that name.", - "value": { - "message": "Cannot update Record Link Group with GUID '485da78d-d094-4edb-a5a9-077fe1bc02f2'.", - "code": "recordLinkGroupUpdate", - "recordLinkGroupGuid": "485da78d-d094-4edb-a5a9-077fe1bc02f2", - "errors": [ + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", + "value": { + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] + } + }, + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", + "value": { + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 31": { + "summary": "Free text search in multiple tables by table GUID", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", + "value": { + "criterion": { + "all": [ { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Record Link Group with name 'Design Data' already exists in this Table.", - "reason": "nameAlreadyExists", - "name": "Design Data", - "parentEntityType": "table", - "entityType": "recordLinkGroup" - } - ] + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "property": "tableGuid", + "innerCriterion": { + "all": [], + "any": [ + "0000dd92-0011-4fff-8fff-0000ffff0000", + "0000b5e2-0011-4fff-8fff-0000ffff0000" + ], + "none": [], + "type": "discreteGuidValues" + }, + "type": "recordProperty" } - ] - } - }, - "Example 2": { - "summary": "Smart record link group with multiple errors", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update 'Tensile Test Data' smart link group, but: the name is the same as the reverse name, one of the specified linking attributes could not be found, and one of the specified linking attributes is duplicated.", - "value": { - "message": "Cannot update Record Link Group with GUID '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f'.", - "code": "recordLinkGroupUpdate", - "recordLinkGroupGuid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f", - "errors": [ + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 32": { + "summary": "Free text search in multiple tables by table name", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", + "value": { + "criterion": { + "all": [ { - "message": "Record Link Group name and reverse name cannot be the same.", - "reason": "nameSameAsReverseName" + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "message": "The Attributes used as linking Attribute pairs for a Smart Link Group are not valid.", - "reason": "smartAttributes", - "errors": [ + "all": [], + "any": [ { - "message": "Could not find Attribute with GUID 'f5b43f21-3e97-4d0f-9a0e-5f7a5822e2ef' in Table with GUID '7db2ff8e-54ed-45d6-b522-e03c8be405b3' in database 'MI_TRAINING'.", - "reason": "noSuchAttribute", - "databaseKey": "MI_TRAINING", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3", - "attributeGuid": "f5b43f21-3e97-4d0f-9a0e-5f7a5822e2ef" + "property": "tableName", + "innerCriterion": { + "value": "MaterialUniverse", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" }, { - "message": "Smart Record Link Group source and target Attributes cannot contain duplicates. Attribute with GUID '6e50a7a8-a759-44c9-b151-215a07949c1f' has already been specified in Table with GUID '7db2ff8e-54ed-45d6-b522-e03c8be405b3'. ", - "reason": "attributeAlreadySpecified", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3", - "attributeGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + "property": "tableName", + "innerCriterion": { + "value": "Design Data", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" } - ] + ], + "none": [], + "type": "boolean" } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The property 'name' cannot be set to null.", - "value": { - "message": "UpdateStaticRecordLinkGroup: Required property 'name' expects a non-null value", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/replacement-strings": { - "get": { - "tags": [ - "Schema - Replacement Strings" - ], - "summary": "Get all replacement strings", - "operationId": "GetReplacementStrings", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which replacement strings will be searched for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacementStringsInfo" - }, - "example": { - "replacementStrings": [ - { - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" - } - ] - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Replacement Strings" - ], - "summary": "Create a new replacement string.", - "operationId": "CreateReplacementString", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be created", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "description": "Replacement string to add to database", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" - }, - "examples": { - "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", - "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" - } - }, - "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "b5325f70-18e6-49dd-a189-c1c20a502f9d" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" - }, - "examples": { - "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", - "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" - } - }, - "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "b5325f70-18e6-49dd-a189-c1c20a502f9d" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" - }, - "examples": { - "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", - "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" - } - }, - "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "b5325f70-18e6-49dd-a189-c1c20a502f9d" + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "b5325f70-18e6-49dd-a189-c1c20a502f9d" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacementString" - }, - "example": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/replacement-strings/{replacement-string-guid}": { - "get": { - "tags": [ - "Schema - Replacement Strings" - ], - "summary": "Get individual replacement string", - "operationId": "GetReplacementString", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be searched for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "replacement-string-guid", - "in": "path", - "description": "Guid of requested replacement string", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacementString" }, - "example": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" - } - } - } - }, - "404": { - "description": "Database or replacement string not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Replacement Strings" - ], - "summary": "Update a replacement string.", - "operationId": "UpdateReplacementString", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be search for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "replacement-string-guid", - "in": "path", - "description": "Guid of replacement string to update", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "Replacement string data to be updated", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" - }, - "examples": { - "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 3": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "62d0e3a5-e010-4fb3-8f12-8dded617ea2c" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 4": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "name": "New name for replacement string" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", - "value": { - "value": "New value for replacement string" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" - }, - "examples": { - "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "62d0e3a5-e010-4fb3-8f12-8dded617ea2c" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "name": "New name for replacement string" + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", - "value": { - "value": "New value for replacement string" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" - }, - "examples": { - "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "62d0e3a5-e010-4fb3-8f12-8dded617ea2c" + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "name": "New name for replacement string" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "value": "New value for replacement string" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" - }, - "examples": { - "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "62d0e3a5-e010-4fb3-8f12-8dded617ea2c" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "name": "New name for replacement string" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "value": "New value for replacement string" + "criterion": { + "recordListIdentifiers": [ + "d71d5081-0da4-4fff-af36-390934de7152", + "1ea86480-40d0-4a0e-bbce-c0930feb4c8e" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacementString" }, - "example": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or replacement string not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Replacement Strings" - ], - "summary": "Delete a replacement string", - "operationId": "DeleteReplacementString", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be search for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "replacement-string-guid", - "in": "path", - "description": "Guid of replacement string to delete", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or replacement string not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/search-masks": { - "get": { - "tags": [ - "Schema - Search Masks" - ], - "summary": "Get all search masks.", - "operationId": "GetSearchMasks", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchMaskInfo" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/search-masks/{search-mask-guid}": { - "get": { - "tags": [ - "Schema - Search Masks" - ], - "summary": "Get a specific search mask by GUID.", - "operationId": "GetSearchMask", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "search-mask-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchMask" - } - } - } - }, - "404": { - "description": "Database or search mask not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates": { - "get": { - "tags": [ - "Schema - Search Templates" - ], - "summary": "Get all search templates for a table.", - "operationId": "GetSearchTemplates", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchTemplateInfo" - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates/{search-template-guid}": { - "get": { - "tags": [ - "Schema - Search Templates" - ], - "summary": "Get a specific search template by GUID.", - "operationId": "GetSearchTemplate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "search-template-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchTemplate" - } - } - } - }, - "404": { - "description": "Database, table, or search template not found" - } - } - } - }, - "/v1alpha/securityGroups/defaultFallback": { - "get": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Returns the default fallback (global) security groups.", - "operationId": "GetDefaultFallbackSecurityGroups", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDefaultFallbackSecurityGroups" - } - } - } - }, - "403": { - "description": "Forbidden if the user is not a system administrator." - } - } - }, - "patch": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Updates the default fallback (global) security groups.", - "operationId": "UpdateDefaultFallbackSecurityGroups", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDefaultFallbackSecurityGroups" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden if the user is not a system administrator." - } - } - } - }, - "/v1alpha/securityGroups/databases": { - "get": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Returns the prevailing security groups defined for each database.", - "operationId": "GetDatabaseSecurityGroups", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroupsInfo" - } - } - } - }, - "403": { - "description": "Forbidden if the user is not a system administrator." - } - } - } - }, - "/v1alpha/securityGroups/databases/{databaseKey}": { - "post": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Adds security groups for a specific database.", - "operationId": "AddDatabaseSecurityGroups", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroups" - } - } - } - }, - "201": { - "description": "Created" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden if the user is not a system administrator." - }, - "409": { - "description": "Conflict" - } - } - }, - "patch": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Updates the security groups for a specific database.", - "operationId": "UpdateDatabaseSecurityGroups", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroups" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden if the user is not a system administrator." - }, - "404": { - "description": "Not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Deletes the security groups defined for a specific database.", - "operationId": "RemoveDatabaseSecurityGroups", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden if the user is not a system administrator." - }, - "404": { - "description": "Not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/standard-names": { - "get": { - "tags": [ - "Schema - Standard Names" - ], - "summary": "Gets all standard names for a given database.", - "operationId": "GetStandardNames", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardNamesInfo" - }, - "example": { - "standardNames": [ - { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "0000013c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" - } - ], + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", + "value": { + "criterion": { "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Density", - "guid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd" + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" }, - { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "0° tension strength - normalized", - "guid": "5ec32efe-85d0-4ed2-8036-a8dea3f2127d" - } - ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ] - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Standard Names" - ], - "summary": "Create a new standard name", - "operationId": "CreateStandardName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" - }, - "examples": { - "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + "sortCriteria": [] + } + }, + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "name": "Unification" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "mappedStaticRecordLinkGroups": [ - { - "staticRecordLinkGroup": { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" - }, - "isReverse": false - } - ], - "name": "Unification" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ - { - "guid": "b522b9ac-3eb9-45ac-9034-a7c8808332d6" - } - ], - "name": "Unification" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "name": "Unification" + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" - }, - "examples": { - "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + }, + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "name": "Unification" + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "mappedStaticRecordLinkGroups": [ - { - "staticRecordLinkGroup": { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "isReverse": false - } - ], - "name": "Unification" + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ - { - "guid": "b522b9ac-3eb9-45ac-9034-a7c8808332d6" - } - ], - "name": "Unification" - } - }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", - "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "name": "Unification" + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" - }, - "examples": { - "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + }, + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "name": "Unification" + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "mappedStaticRecordLinkGroups": [ - { - "staticRecordLinkGroup": { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - "isReverse": false - } - ], - "name": "Unification" + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ - { - "guid": "b522b9ac-3eb9-45ac-9034-a7c8808332d6" - } - ], - "name": "Unification" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "name": "Unification" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" - }, - "examples": { - "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", - "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "localColumns": { + "filterOn": "all" }, + "type": "text" + }, + "sortCriteria": [ { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + "sortDirection": "ascending", + "type": "relevance" } ], - "name": "Unification" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" - } - }, - "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", - "value": { - "mappedStaticRecordLinkGroups": [ - { - "staticRecordLinkGroup": { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" - }, - "isReverse": false + "sortDirection": "ascending", + "type": "relevance" } - ], - "name": "Unification" + ] } }, - "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ - { - "guid": "b522b9ac-3eb9-45ac-9034-a7c8808332d6" - } - ], - "name": "Unification" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "name": "Unification" + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardName" }, - "examples": { - "Example 3": { - "summary": "'Density' Standard Name", - "description": "Example response for the 'Density' Standard Name in the ' 'MI Training database'.", - "value": { - "mappedAttributes": [ + "Example 31": { + "summary": "Free text search in multiple tables by table GUID", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", + "value": { + "criterion": { + "all": [ { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "value": "steel", + "attributes": { + "filterOn": "all" }, - "name": "Density", - "guid": "0000013c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" + "localColumns": { + "filterOn": "all" }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" + "type": "text" }, { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" + "property": "tableGuid", + "innerCriterion": { + "all": [], + "any": [ + "0000dd92-0011-4fff-8fff-0000ffff0000", + "0000b5e2-0011-4fff-8fff-0000ffff0000" + ], + "none": [], + "type": "discreteGuidValues" }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" + "type": "recordProperty" } ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Density", - "guid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd" - } - }, - "Example 4": { - "summary": "'Tensile strength' Standard Name", - "description": "Example response for the 'Tensile strength' Standard Name in the ' 'MI Training database'.", - "value": { - "mappedAttributes": [ + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 32": { + "summary": "Free text search in multiple tables by table name", + "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", + "value": { + "criterion": { + "all": [ { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "value": "steel", + "attributes": { + "filterOn": "all" }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "0° tension strength - normalized", - "guid": "5ec32efe-85d0-4ed2-8036-a8dea3f2127d" + "all": [], + "any": [ + { + "property": "tableName", + "innerCriterion": { + "value": "MaterialUniverse", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" + }, + { + "property": "tableName", + "innerCriterion": { + "value": "Design Data", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "type": "recordProperty" + } + ], + "none": [], + "type": "boolean" } ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } } } } - }, - "400": { - "description": "Bad request", + } + }, + "responses": { + "200": { + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNameCreationException" - }, - "examples": { - "Example 1": { - "summary": "Standard name already exists", - "description": "A standard name with the same name already exists in the database.", - "value": { - "message": "Cannot create Standard Name 'Density'.", - "code": "standardNameCreation", - "name": "Density", - "errors": [ - { - "message": "A Standard Name with name 'Density' already exists", - "reason": "standardNameAlreadyExists", - "standardName": "Density" - } - ] - } - }, - "Example 2": { - "summary": "Duplicate mapped attribute GUIDs", - "description": "The mapped attributes contain duplicate GUIDs.", - "value": { - "message": "Cannot create Standard Name 'NewStandardName'.", - "code": "standardNameCreation", - "name": "NewStandardName", - "errors": [ - { - "message": "Duplicated Attribute GUIDs present", - "reason": "duplicateMappedAttributeGuids" - } - ] - } - }, - "Example 3": { - "summary": "Unresolved attribute GUIDs", - "description": "One or more attribute GUIDs could not be resolved.", - "value": { - "message": "Cannot create Standard Name 'NewStandardName'.", - "code": "standardNameCreation", - "name": "NewStandardName", - "errors": [ - { - "message": "The following Attribute GUIDs did not resolve: [4a3cd2fe-0efe-42b2-8426-c88f7db55d61]", - "reason": "unresolvedAttributeGuids", - "unresolvedGuids": [ - "4a3cd2fe-0efe-42b2-8426-c88f7db55d61" - ] - } - ] - } - }, - "Example 4": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateStandardName: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } + "$ref": "#/components/schemas/GsaSearchResponse" } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/standard-names/{standard-name-guid}": { - "get": { - "tags": [ - "Schema - Standard Names" - ], - "summary": "Gets a standard name for a given database and guid.", - "operationId": "GetStandardName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "standard-name-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { + }, + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardName" - }, - "examples": { - "Example 1": { - "summary": "'Density' Standard Name", - "description": "Example response for the 'Density' Standard Name in the ' 'MI Training database'.", - "value": { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "0000013c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" - } - ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Density", - "guid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd" - } - }, - "Example 2": { - "summary": "'Tensile strength' Standard Name", - "description": "Example response for the 'Tensile strength' Standard Name in the ' 'MI Training database'.", - "value": { - "mappedAttributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "0° tension strength - normalized", - "guid": "5ec32efe-85d0-4ed2-8036-a8dea3f2127d" - } - ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - } + "$ref": "#/components/schemas/GsaSearchResponse" } } } - }, - "404": { - "description": "Database or standard name not found" } } - }, - "patch": { + } + }, + "/v1alpha/integration-schemas/{schema}:search": { + "post": { "tags": [ - "Schema - Standard Names" + "Search" ], - "summary": "Edit a standard name", - "operationId": "UpdateStandardName", + "summary": "Runs a search against the integration schema.", + "operationId": "IntegrationSearch", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "standard-name-guid", + "name": "schema", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "forceNonCustom", - "in": "query", - "description": "Optionally force the update for non-custom standard names.", - "schema": { - "type": "boolean", - "default": false + "type": "string" } } ], @@ -72985,29741 +62000,6127 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "name": "Density (Updated)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "guid": "ba577f8e-c216-49ef-a6cd-27467d8391fc" - } - }, - "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ] - } - }, - "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "mappedAttributes": [], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "localColumns": { + "filterOn": "all" }, + "type": "text" + }, + "sortCriteria": [ { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "sortDirection": "ascending", + "type": "relevance" } ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "name": "Density (Updated)" - } }, "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "guid": "ba577f8e-c216-49ef-a6cd-27467d8391fc" - } - }, - "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ] - } - }, - "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "mappedAttributes": [], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "localColumns": { + "filterOn": "none" }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "name": "Density (Updated)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "guid": "ba577f8e-c216-49ef-a6cd-27467d8391fc" + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ] + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "mappedAttributes": [], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "name": "Density (Updated)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", - "value": { - "guid": "ba577f8e-c216-49ef-a6cd-27467d8391fc" + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" } ] } }, - "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "mappedAttributes": [], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "criterion": { + "innerCriterion": { + "type": "integer" }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ] + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardName" }, - "examples": { - "Example 7": { - "summary": "'Density' Standard Name", - "description": "Example response for the 'Density' Standard Name in the ' 'MI Training database'.", - "value": { - "mappedAttributes": [ + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", + "value": { + "criterion": { + "all": [ { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "innerCriterion": { + "type": "longText" }, - "name": "Density", - "guid": "0000013c-0001-4fff-8fff-dd92ffff0000" + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" }, - "name": "Density", - "guid": "00000003-0001-4fff-8fff-b5e2ffff0000" + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Density", - "guid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd" - } - }, - "Example 8": { - "summary": "'Tensile strength' Standard Name", - "description": "Example response for the 'Tensile strength' Standard Name in the ' 'MI Training database'.", - "value": { - "mappedAttributes": [ + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", + "value": { + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", + "value": { + "criterion": { + "all": [], + "any": [ { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "value": "steel", + "attributes": { + "filterOn": "all" }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + "localColumns": { + "filterOn": "all" + }, + "type": "text" }, { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - "name": "0° tension strength - normalized", - "guid": "5ec32efe-85d0-4ed2-8036-a8dea3f2127d" + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" } ], - "databaseKey": "MI_Training", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "isCustom": true, - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardNameUpdateException" + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } }, - "examples": { - "Example 1": { - "summary": "Standard name already exists", - "description": "A standard name with the same name already exists in the database.", - "value": { - "message": "Cannot update Standard Name with GUID 'b45fb00d-b03b-4446-94db-c47ac29c5dbf'.", - "code": "standardNameUpdate", - "standardNameGuid": "b45fb00d-b03b-4446-94db-c47ac29c5dbf", - "errors": [ - { - "message": "A Standard Name with name 'Density' already exists", - "reason": "standardNameAlreadyExists", - "standardName": "Density" - } - ] - } - }, - "Example 2": { - "summary": "Duplicate mapped attribute GUIDs", - "description": "The mapped attributes contain duplicate GUIDs.", - "value": { - "message": "Cannot update Standard Name with GUID 'bc70c5ea-3794-47a0-935d-773f1f326a0c'.", - "code": "standardNameUpdate", - "standardNameGuid": "bc70c5ea-3794-47a0-935d-773f1f326a0c", - "errors": [ - { - "message": "Duplicated Attribute GUIDs present", - "reason": "duplicateMappedAttributeGuids" - } - ] - } - }, - "Example 3": { - "summary": "Unresolved attribute GUIDs", - "description": "One or more attribute GUIDs could not be resolved.", - "value": { - "message": "Cannot update Standard Name with GUID '5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd'.", - "code": "standardNameUpdate", - "standardNameGuid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd", - "errors": [ + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", + "value": { + "criterion": { + "all": [], + "any": [ { - "message": "The following Attribute GUIDs did not resolve: [b92b5292-32fc-4168-96a9-69b7c1376421]", - "reason": "unresolvedAttributeGuids", - "unresolvedGuids": [ - "b92b5292-32fc-4168-96a9-69b7c1376421" - ] - } - ] - } - }, - "Example 4": { - "summary": "Rename a 'non-custom' standard name", - "description": "The standard name to be renamed was a 'non-custom' standard name.", - "value": { - "message": "Cannot update Standard Name with GUID '5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd'.", - "code": "standardNameUpdate", - "standardNameGuid": "5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd", - "errors": [ + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, { - "message": "The Standard Name with name 'Young's Modulus' is non-custom. The names of non-custom Standard Names cannot be changed.", - "reason": "nonCustomStandardNameCannotBeChanged", - "standardName": "Young's Modulus" - } - ] - } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The JSON body could not be deserialized.", - "value": { - "message": "UpdateStandardName: Invalid JSON in request body", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or standard name not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Standard Names" - ], - "summary": "Delete a standard name.", - "operationId": "DeleteStandardName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "standard-name-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "forceNonCustom", - "in": "query", - "description": "Optionally force the deletion for non-custom standard names.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardNameDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Delete a 'non-custom' standard name", - "description": "The standard name to be deleted was a 'non-custom' standard name.", - "value": { - "message": "Cannot delete Standard Name 'Young's Modulus'.", - "code": "standardNameDeletion", - "name": "Young's Modulus", - "errors": [ + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, { - "message": "The Standard Name with name 'Young's Modulus' is non-custom. Non-custom Standard Names cannot be deleted.", - "reason": "nonCustomStandardNameCannotBeDeleted", - "standardName": "Young's Modulus" + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" } - ] - } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or standard name not found." - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets": { - "get": { - "tags": [ - "Schema - Subsets" - ], - "summary": "Get all subsets for table", - "operationId": "GetSubsets", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSubsetsInfo" }, - "example": { - "subsets": [ - { - "associatedLayout": { - "displayNames": { - "en": "Ceramics Layout English Display Name", - "fr": "Ceramics Layout French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" - }, - { - "associatedLayout": { - "name": "Metals", - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", + "value": { + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" }, - "displayNames": {}, - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - { - "associatedLayout": { - "name": "Polymers", - "guid": "00007645-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": {}, - "name": "Polymers", - "guid": "00007645-0010-4fff-8fff-dd92ffff0000" - } - ] - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - }, - "post": { - "tags": [ - "Schema - Subsets" - ], - "summary": "Create a new subset.", - "operationId": "CreateSubset", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" - }, - "examples": { - "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Alloys" + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "name": "Alloys (guid)", - "guid": "b235b097-d117-44c0-ae65-d0bef9b49327" + "criterion": { + "recordListIdentifiers": [ + "4d95d3af-1e95-4915-9aec-f37550e3e5c5", + "d652ec95-3cb4-4111-aa90-b6a24d053a05" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" }, - "name": "Alloys (Layout)" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" - }, - "examples": { - "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Alloys" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "name": "Alloys (guid)", - "guid": "b235b097-d117-44c0-ae65-d0bef9b49327" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" }, - "name": "Alloys (Layout)" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" - }, - "examples": { - "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Alloys" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "name": "Alloys (guid)", - "guid": "b235b097-d117-44c0-ae65-d0bef9b49327" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" }, - "name": "Alloys (Layout)" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" - }, - "examples": { - "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Alloys" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "name": "Alloys (guid)", - "guid": "b235b097-d117-44c0-ae65-d0bef9b49327" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Alloys (Layout)" + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSubset" }, - "example": { - "associatedLayout": { - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": {}, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}": { - "get": { - "tags": [ - "Schema - Subsets" - ], - "summary": "Get a subset with a specified guid for a given database and table.", - "operationId": "GetSubset", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "subset-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSubset" - }, - "example": { - "associatedLayout": { - "displayNames": { - "en": "Ceramics Layout English Display Name", - "fr": "Ceramics Layout French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - } - } - }, - "404": { - "description": "Database, table or subset not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Subsets" - ], - "summary": "Update a subset.", - "operationId": "UpdateSubset", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "subset-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" - }, - "examples": { - "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Ceramics (Updated)", - "guid": "dcd5c4e3-1414-4c15-a4b2-7401705bfab0" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Ceramics (Updated)" - } - }, - "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - } + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "associatedLayout": null - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" - }, - "examples": { - "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Ceramics (Updated)", - "guid": "dcd5c4e3-1414-4c15-a4b2-7401705bfab0" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "name": "Ceramics (Updated)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - } + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "associatedLayout": null - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" - }, - "examples": { - "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Ceramics (Updated)", - "guid": "dcd5c4e3-1414-4c15-a4b2-7401705bfab0" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "name": "Ceramics (Updated)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 } } }, - "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "associatedLayout": null - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" - }, - "examples": { - "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Ceramics (Updated)", - "guid": "dcd5c4e3-1414-4c15-a4b2-7401705bfab0" + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, - "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "name": "Ceramics (Updated)" + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - } - } - }, - "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "associatedLayout": null - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSubset" - }, - "example": { - "associatedLayout": { - "displayNames": { - "en": "Ceramics Layout English Display Name", - "fr": "Ceramics Layout French Display Name" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or subset not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Subsets" - ], - "summary": "Delete a subset.", - "operationId": "DeleteSubset", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "subset-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or subset not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:add-to-subset": { - "post": { - "tags": [ - "Schema - Subsets" - ], - "summary": "Add a record history to a subset.", - "operationId": "AddToSubset", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "subset-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" - }, - "examples": { - "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false - } - }, - "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true + "sortCriteria": [] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" - }, - "examples": { - "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 3": { + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" - }, - "examples": { - "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 4": { + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 5": { + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" + } + ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or subset not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:remove-from-subset": { - "post": { - "tags": [ - "Schema - Subsets" - ], - "summary": "Remove a record history, and all of its descendants, from a subset.", - "operationId": "RemoveFromSubset", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "subset-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 6": { + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 7": { + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 8": { + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 9": { + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or subset not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables": { - "get": { - "tags": [ - "Schema - Tables" - ], - "summary": "Get all tables", - "operationId": "GetTables", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTablesInfo" - }, - "example": { - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "tableTypes": [ - "Universe", - "Material" + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } ], - "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" - }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "none": [], + "type": "boolean" }, - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "tableTypes": [ - "Design" - ], - "displayNames": {}, - "name": "Design Data", - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - } - ] - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Tables" - ], - "summary": "Create a new table.", - "operationId": "CreateTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateTable" - }, - "examples": { - "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "4e8da166-de54-40d8-9a0f-c373e30ecb55" + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, - "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" + "criterion": { + "recordListIdentifiers": [ + "4d95d3af-1e95-4915-9aec-f37550e3e5c5", + "d652ec95-3cb4-4111-aa90-b6a24d053a05" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", + "Example 13": { + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "Example 14": { + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" - ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 7": { - "summary": "Table with Quality System", - "description": "This example demonstrates how to create a new table with the quality system set to the 'Test Numerical Quality System' in the MI_Training database.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "qualitySystem": { - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" }, - "name": "Table with Test Numerical Quality System" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateTable" - }, - "examples": { - "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "4e8da166-de54-40d8-9a0f-c373e30ecb55" + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" - ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 7": { - "summary": "Table with Quality System", - "description": "This example demonstrates how to create a new table with the quality system set to the 'Test Numerical Quality System' in the MI_Training database.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "qualitySystem": { - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Table with Test Numerical Quality System" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateTable" - }, - "examples": { - "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "sortCriteria": [] } }, - "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "4e8da166-de54-40d8-9a0f-c373e30ecb55" + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", + "value": { + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 7": { - "summary": "Table with Quality System", - "description": "This example demonstrates how to create a new table with the quality system set to the 'Test Numerical Quality System' in the MI_Training database.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "qualitySystem": { - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] + } + }, + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", + "value": { + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "name": "Table with Test Numerical Quality System" + "sortCriteria": [] } } } }, - "application/*+json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateTable" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "4e8da166-de54-40d8-9a0f-c373e30ecb55" + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" + } + ] } }, "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" - ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, "Example 7": { - "summary": "Table with Quality System", - "description": "This example demonstrates how to create a new table with the quality system set to the 'Test Numerical Quality System' in the MI_Training database.", + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "qualitySystem": { - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" }, - "name": "Table with Test Numerical Quality System" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTable" - }, - "example": { - "versionState": "unversioned", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "tableTypes": [], - "displayNames": {}, - "name": "Material Universe", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTableCreationException" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}": { - "get": { - "tags": [ - "Schema - Tables" - ], - "summary": "Get a table with a specified guid for a given database.", - "operationId": "GetTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTable" - }, - "example": { - "defaultSubset": { - "name": "All bulk materials", - "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" - }, - "subsets": [ - { - "name": "Aerospace materials", - "guid": "0000fc72-0010-4fff-8fff-dd92ffff0000" - }, - { - "name": "All bulk materials", - "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" - }, - { - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" - }, - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - }, - { - "name": "Polymers", - "guid": "00007645-0010-4fff-8fff-dd92ffff0000" - } - ], - "defaultLayout": { - "name": "All Attributes", - "guid": "384f9abe-0581-434d-a976-86952282207a" - }, - "layouts": [ - { - "name": "Aerospace materials", - "guid": "0000fc72-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "All Attributes", - "guid": "384f9abe-0581-434d-a976-86952282207a" - }, - { - "name": "All bulk materials", - "guid": "0000b1c5-0009-4fff-8fff-dd92ffff0000" - }, - { - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "Metals", - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "Polymers", - "guid": "00007645-0009-4fff-8fff-dd92ffff0000" - } - ], - "versionState": "unversioned", - "order": 0, - "qualitySystem": { - "name": "Test Data Quality System", - "guid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - }, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "tableTypes": [ - "Material" - ], - "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" - }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Tables" - ], - "summary": "Update a table.", - "operationId": "UpdateTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "74416dd3-3508-4c74-917b-9c9b95472959" - } - }, - "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromBrowse": true - } - }, - "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromSearch": false - } - }, - "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - }, - "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": null - } - }, - "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": null + "sortCriteria": [] } }, "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] } }, "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", "value": { - "tableTypes": [ - "Material", - "Universal" + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } ] } }, "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", "value": { - "shouldShowVersionControlSignatures": true + "criterion": { + "recordListIdentifiers": [ + "4d95d3af-1e95-4915-9aec-f37550e3e5c5", + "d652ec95-3cb4-4111-aa90-b6a24d053a05" + ], + "type": "recordListMember" + }, + "sortCriteria": [] } }, "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "qualitySystemGuid": null + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "74416dd3-3508-4c74-917b-9c9b95472959" - } - }, - "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromBrowse": true - } - }, - "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromSearch": false - } - }, - "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - }, - "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": null - } - }, - "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "defaultLayoutGuid": null + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] } }, - "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] } }, - "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] } }, - "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "tableTypes": [ - "Material", - "Universal" - ] + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", "value": { - "shouldShowVersionControlSignatures": true + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "qualitySystemGuid": null + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "74416dd3-3508-4c74-917b-9c9b95472959" - } - }, - "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromBrowse": true - } - }, - "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "isHiddenFromSearch": false - } - }, - "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "defaultSubsetGuid": null + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "defaultLayoutGuid": null + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" + }, + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" + }, + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } } }, - "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", "value": { - "tableTypes": [ - "Material", - "Universal" + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } ] } }, - "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", - "value": { - "shouldShowVersionControlSignatures": true - } - }, - "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", "value": { - "qualitySystemGuid": null + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" + "$ref": "#/components/schemas/GsaSearchRequest" }, "examples": { "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text search", + "description": "This example demonstrates how to create a new free text search with results sorted by relevance", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "74416dd3-3508-4c74-917b-9c9b95472959" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] } }, "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text search with boosted identities", + "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", "value": { - "isHiddenFromBrowse": true + "criterion": { + "value": "lead", + "attributes": { + "identities": [ + -4, + 928, + 886 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "attributeIdentitiesToBoost": [ + { + "identity": -4, + "boostFactor": 20.0 + } + ], + "type": "text" + }, + "sortCriteria": [] } }, "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text search with excluded columns", + "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", "value": { - "isHiddenFromSearch": false + "criterion": { + "value": "Intermediate", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "identities": [], + "guids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "specific" + }, + "type": "text" + }, + "sortCriteria": [] } }, "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Free text prefix search", + "description": "This example demonstrates how to create a new free text prefix search", "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + "criterion": { + "prefix": "ste", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "textPrefix" + }, + "sortCriteria": [] } }, "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Simple attribute search", + "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", "value": { - "defaultSubsetGuid": null + "criterion": { + "innerCriterion": { + "gte": 1, + "lte": 10, + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "identity": 8965, + "attributeType": "integer", + "sortDirection": "ascending", + "type": "attribute" + } + ] } }, "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Attribute exists search", + "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "criterion": { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Multiple attribute search", + "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", "value": { - "defaultLayoutGuid": null + "criterion": { + "all": [ + { + "innerCriterion": { + "type": "longText" + }, + "identity": 5886, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "innerCriterion": { + "gte": "1990-01-01T00:00:00+00:00", + "lte": "1999-12-31T00:00:00+00:00", + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "all": [], + "any": [ + 1665, + 1666 + ], + "none": [], + "type": "discreteIdentityValues" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] } }, "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Attribute prefix search", + "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." + "criterion": { + "innerCriterion": { + "prefix": "chr", + "type": "shortTextPrefix" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "tableTypes": [ - "Material", - "Universal" - ] - } - }, - "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", + "summary": "Nested boolean search", + "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", "value": { - "shouldShowVersionControlSignatures": true - } + "criterion": { + "all": [], + "any": [ + { + "value": "steel", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + }, + { + "all": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + { + "identity": 928, + "isMetaAttribute": false, + "attributeCriterionType": "notApplicable", + "type": "attribute" + } + ], + "any": [], + "none": [], + "type": "boolean" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [] + } + }, + "Example 10": { + "summary": "Record name search", + "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", + "value": { + "criterion": { + "all": [], + "any": [ + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -4, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -9, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + { + "innerCriterion": { + "value": "steel", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "identity": -10, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + } + ], + "none": [], + "type": "boolean" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] + } + }, + "Example 11": { + "summary": "Record color search", + "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", + "value": { + "criterion": { + "innerCriterion": { + "all": [ + "red" + ], + "any": [], + "none": [], + "textMatchBehavior": "contains", + "type": "discreteTextValues" + }, + "identity": -6, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "property": "recordName", + "sortType": "natural", + "sortDirection": "descending", + "type": "recordProperty" + } + ] + } + }, + "Example 12": { + "summary": "Record list search", + "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", + "value": { + "criterion": { + "recordListIdentifiers": [ + "4d95d3af-1e95-4915-9aec-f37550e3e5c5", + "d652ec95-3cb4-4111-aa90-b6a24d053a05" + ], + "type": "recordListMember" + }, + "sortCriteria": [] + } }, "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Record reference search", + "description": "A search in MI_TRAINING for results where the record matches the record history GUID", "value": { - "qualitySystemGuid": null + "criterion": { + "databaseKey": "MI_Training", + "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", + "type": "reference" + }, + "sortCriteria": [] } }, "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Record ancestor search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" + "criterion": { + "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", + "directParentOnly": false, + "type": "recordAncestor" + }, + "sortCriteria": [] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTable" }, - "example": { - "defaultSubset": { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - }, - "subsets": [ - { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - } - ], - "defaultLayout": { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - }, - "layouts": [ - { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - } - ], - "versionState": "unreleased", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTableUpdateException" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Tables" - ], - "summary": "Delete a table.", - "operationId": "DeleteTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. Table in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTableDeletionException" + "Example 15": { + "summary": "Record ancestor history search", + "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", + "value": { + "criterion": { + "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", + "directParentOnly": false, + "type": "recordAncestorHistory" + }, + "sortCriteria": [] + } }, - "example": { - "message": "Cannot delete Table with GUID 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'.", - "code": "deletion", - "entityType": "table", - "entityGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "errors": [ - { - "message": "It is being used in one or more tabular attributes.", - "reason": "usage", - "referencedByType": "tabularAttribute", - "referencedBy": [ - { - "type": "tabular", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ] - } - ] - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:release": { - "post": { - "tags": [ - "Schema - Tables" - ], - "summary": "Releases the table. Table must be version-controlled and unreleased.", - "operationId": "ReleaseTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTable" + "Example 16": { + "summary": "Top level records search", + "description": "A search in MI_TRAINING for results where the record has no parent in the tree", + "value": { + "criterion": { + "directParentOnly": true, + "type": "recordAncestor" + }, + "sortCriteria": [] + } }, - "example": { - "defaultSubset": { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - }, - "subsets": [ - { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - } - ], - "defaultLayout": { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - }, - "layouts": [ - { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - } - ], - "versionState": "released", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - } - } - } - }, - "400": { - "description": "Bad request. Table is not unreleased, or table is not version controlled.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReleaseTableVersionControlException" + "Example 17": { + "summary": "Subset search", + "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", + "value": { + "criterion": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "type": "subset" + }, + "sortCriteria": [] + } }, - "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "A table can only be released if it is currently unreleased.", - "value": { - "message": "Cannot release Table with GUID 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'.", - "code": "releaseTableVersionControl", - "tableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "errors": [ - { - "message": "Invalid version state 'Released'.", - "reason": "invalidVersionState", - "versionState": "released" - } - ] - } - }, - "Example 2": { - "summary": "Table is not version controlled.", - "value": { - "message": "Cannot release Table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "code": "releaseTableVersionControl", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] - } + "Example 18": { + "summary": "Tabular data link exists", + "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", + "value": { + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:enable-version-control": { - "post": { - "tags": [ - "Schema - Tables" - ], - "summary": "Enable version control on the table. This cannot be undone.\r\nAfter this method has been called all records and data in the table are in an unreleased state.\r\nThis means that read users will not be able to see any records unless they are subsequently released.", - "operationId": "EnableVersionControl", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTable" }, - "example": { - "defaultSubset": { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - }, - "subsets": [ - { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - } - ], - "defaultLayout": { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - }, - "layouts": [ - { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - } - ], - "versionState": "unreleased", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - } - } - } - }, - "400": { - "description": "Bad request. Table is already versioned." - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:inbound-links": { - "post": { - "tags": [ - "Schema - Tables" - ], - "summary": "Get all record link groups and tabular attributes pointing towards the table.", - "description": "Note that all accessible databases will be checked.\r\n If write mode is requested, the user must have write access to all accessible databases.\r\n To use the latest versions available, don't set the version control mode.", - "operationId": "GetInboundLinks", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "type", - "in": "query", - "description": "The link types to include in the response. If not provided, all link types are included.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - } - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaLinksInfo" - }, - "example": { - "links": [ - { - "type": "recordLink", - "includeIndirectLinks": false, - "reverseName": "Training Exercise", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + "Example 19": { + "summary": "Tabular data local column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", + "value": { + "criterion": { + "innerCriterion": { + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" + }, + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "localColumnCriterionType": "matches", + "type": "localColumn" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "localRowsBehavior": "AllRows", + "type": "link" }, - "displayNames": {}, - "name": "MaterialUniverse", - "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - { - "type": "smartLink", - "forbidOrphans": false, - "referentialIntegrityModel": "manyToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "9bd8599e-36e0-4008-b52e-2f70b90c00a0" + "sortCriteria": [] + } + }, + "Example 20": { + "summary": "Tabular data linked attribute column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", + "value": { + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "localCriterion": { + "innerCriterion": { + "gte": 10.0, + "type": "range" }, - "attributeTarget": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "000001cb-0001-4fff-8fff-dd92ffff0000" - } - } - ], - "reverseName": "Smart Link to Training Record", - "reverseDisplayNames": { - "en": "en-Smart Link to Training Record", - "fr": "fr-Smart Link to Training Record" - }, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "displayNames": { - "en": "en-Smart Link to MaterialUniverse", - "fr": "fr-Smart Link to MaterialUniverse" - }, - "name": "Smart Link to MaterialUniverse", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - { - "type": "crossDatabaseLink", - "includeIndirectLinks": false, - "reverseName": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "402b097d-b654-4cac-8385-28dcdd3e67fb", - "databaseVersionGuid": "e912286c-aceb-4802-b9f3-51ea96612b7f", - "tableGuid": "d916e9c7-72b3-40cd-8a82-e26c537ba02a" + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "value": "Alkanes", + "textMatchBehavior": "contains", + "type": "shortText" + }, + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "localRowsBehavior": "AllRows", + "type": "link" }, - "displayNames": {}, - "name": "Cross database link group : Second Training Database And Table - MI Training MaterialUniverse", - "guid": "8f43e9d8-2bca-4327-98d4-6a6c79a4f7aa" + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - { - "type": "tabularAttribute", - "targetAttribute": { - "guid": "00000099-0001-4fff-8fff-dd92ffff0000" - }, - "reverseName": "Environmental performances overview", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "displayNames": {}, - "name": "Environmental performances overview", - "guid": "2523a67a-6246-4c9e-8583-15b64d6290e5" - } - ] - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables:query": { - "post": { - "tags": [ - "Schema - Tables" - ], - "summary": "Gets tables for a given database, populates the requested properties.", - "operationId": "QueryTables", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all tables with custom properties", - "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "sortCriteria": [] } }, - "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", + "Example 21": { + "summary": "Tabular data linked column column search", + "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "innerCriterion": { + "innerCriterion": { + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "innerCriterion": { + "innerCriterion": { + "value": "Banned with conditions", + "textMatchBehavior": "exactMatch", + "type": "discreteText" + }, + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } + "sortCriteria": [] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all tables with custom properties", + }, + "Example 22": { + "summary": "Tabular linking value search", + "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "linkDatumType": "tabularAttribute", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "values": [ + "85535" + ], + "linkingValueMatchBehavior": "FreeTextMatchingRows", + "type": "tabularLinkingValue" + }, + "localRowsBehavior": "AllRows", + "type": "link" }, - "displayNames": true, - "name": true, - "guid": true - } + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", + "Example 23": { + "summary": "Record link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", "value": { - "properties": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "picture" + }, + "identity": 8563, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "localRowsBehavior": "AllRows", + "type": "link" + }, + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } + "sortCriteria": [] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all tables with custom properties", + }, + "Example 24": { + "summary": "Record link exists search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 59, + "targetDatabaseKey": "MI_TRAINING", + "linkDatumType": "recordLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "type": "link" }, - "displayNames": true, - "name": true, - "guid": true - } + "identity": 101, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", + "Example 25": { + "summary": "Cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all tables with custom properties", - "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryTablesInfo" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/permission-category-access-controls": { - "get": { - "tags": [ - "Schema - Tables" - ], - "summary": "Get permission-based access control settings for a given table.\r\nReturns the access control for each permission in each category.", - "operationId": "GetTablePermissionCategoryAccessControls", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" - }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" + "criterion": { + "innerCriterion": { + "targetTableIdentity": 56, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": false, + "innerCriterion": { + "innerCriterion": { + "type": "floatFunctional" }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "patch": { - "tags": [ - "Schema - Tables" - ], - "summary": "Update permission-based access control settings for a given table.\r\nSets the access control for the given permissions.", - "description": "\r\n\r\nCan also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation)", - "operationId": "UpdateTablePermissionCategoryAccessControls", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 11": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 12": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "identity": 33, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 11": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "identity": 45, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 12": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 26": { + "summary": "Reverse cross database link search", + "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true + "criterion": { + "innerCriterion": { + "targetTableIdentity": 39, + "targetDatabaseKey": "Target_Database", + "linkDatumType": "crossDatabaseLink", + "indirectLinks": "fromLinkDefinition", + "searchInReversedDirection": true, + "innerCriterion": { + "innerCriterion": { + "type": "file" }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 11": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 12": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "identity": 87, + "isMetaAttribute": true, + "attributeCriterionType": "exists", + "type": "attribute" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] + "localRowsBehavior": "AllRows", + "type": "link" }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 11": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "identity": 65, + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] } }, - "Example 12": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 27": { + "summary": "Paginated search", + "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" - }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterion": { + "value": "steel", + "attributes": { + "filterOn": "all" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" + "localColumns": { + "filterOn": "all" }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 21": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '858e6ed3-3509-4e3d-90ab-ac1bd5e127a1', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID '858e6ed3-3509-4e3d-90ab-ac1bd5e127a1' does not exist.", - "reason": "noSuchCategory", - "categoryGuid": "858e6ed3-3509-4e3d-90ab-ac1bd5e127a1" - } - ] - } - }, - "Example 22": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '04fba682-cf5d-4719-8623-5caf190ebde8' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '04fba682-cf5d-4719-8623-5caf190ebde8' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "reason": "noSuchPermission", - "permissionGuid": "04fba682-cf5d-4719-8623-5caf190ebde8", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - ] - } - }, - "Example 23": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "reason": "duplicateCategoryGuids", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ] - } - ] - } - }, - "Example 24": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "reason": "duplicatePermissionGuids", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ] - } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables:reorder": { - "post": { - "tags": [ - "Schema - Tables" - ], - "summary": "Reorders the tables for a given database.\r\nNo tables are added, deleted or modified.\r\nAll the existing tables must be included in the request body.", - "operationId": "ReorderTables", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaReorderTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Reorder tables in the MI_Training database.", - "value": { - "tables": [ - { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - { - "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - { - "guid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - { - "guid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" - }, - { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - { - "guid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - }, - { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReorderTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Reorder tables in the MI_Training database.", - "value": { - "tables": [ - { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - { - "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - { - "guid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - { - "guid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" - }, - { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - { - "guid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - }, - { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaReorderTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Reorder tables in the MI_Training database.", - "value": { - "tables": [ - { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - { - "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - { - "guid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - { - "guid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" - }, - { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - { - "guid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - }, - { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaReorderTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Reorder tables in the MI_Training database.", - "value": { - "tables": [ - { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - { - "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - { - "guid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - { - "guid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" - }, - { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - { - "guid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - }, - { - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" - }, - { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - { - "guid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTablesInfo" - }, - "example": { - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "tableTypes": [ - "Universe", - "Material" - ], - "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" - }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "tableTypes": [ - "Design" - ], - "displayNames": {}, - "name": "Design Data", - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReorderTablesException" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/unit-equivalents": { - "get": { - "tags": [ - "Schema - Unit Equivalents" - ], - "summary": "Get unit equivalents", - "operationId": "GetUnitEquivalents", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-guid", - "in": "query", - "description": "The GUIDs of the units to include in the response. If none are provided, all units are included.", - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - { - "name": "unit-system-guid", - "in": "query", - "description": "The GUIDs of the unit systems to include in the response. If none are provided, all unit systems are included.", - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitEquivalentsInfo" - }, - "example": { - "unitEquivalents": [ - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "unitSystem": { - "guid": "00000001-0014-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "symbol": "m", - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "unitSystem": { - "guid": "00000007-0014-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetUnitEquivalentsException" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/unit-equivalents:update": { - "post": { - "tags": [ - "Schema - Unit Equivalents" - ], - "summary": "Update one or more unit equivalents.\r\nReturns the unit equivalents that have been updated.", - "operationId": "SetUnitEquivalents", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitEquivalentsInfo" - }, - "example": { - "unitEquivalents": [ - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "unitSystem": { - "guid": "00000001-0014-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "symbol": "m", - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "unitSystem": { - "guid": "00000007-0014-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsException" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/unit-conversions": { - "post": { - "tags": [ - "Schema - Units" - ], - "summary": "Gets all the equivalent units and their conversion factors for the specified source units,\r\nincluding any errors that occurred.", - "operationId": "GetUnitConversions", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" - }, - "examples": { - "Example 1": { - "summary": "Convert units", - "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", - "value": { - "conversions": [ - { - "sourceUnitSymbol": "K", - "targetUnitSymbol": "°F" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" - }, - "examples": { - "Example 1": { - "summary": "Convert units", - "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", - "value": { - "conversions": [ - { - "sourceUnitSymbol": "K", - "targetUnitSymbol": "°F" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" - }, - "examples": { - "Example 1": { - "summary": "Convert units", - "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", - "value": { - "conversions": [ - { - "sourceUnitSymbol": "K", - "targetUnitSymbol": "°F" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGetUnitConversionsRequest" - }, - "examples": { - "Example 1": { - "summary": "Convert units", - "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", - "value": { - "conversions": [ - { - "sourceUnitSymbol": "K", - "targetUnitSymbol": "°F" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitConversionsInfo" - } - } - } - }, - "400": { - "description": "Bad request" - } - } - } - }, - "/v1alpha/databases/{database-key}/units": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get all units", - "operationId": "GetUnits", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitsInfo" - }, - "examples": { - "Example 1": { - "summary": "Units", - "description": "Example of units from the MI Training database", - "value": { - "units": [ - { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Units" - ], - "summary": "Create a new unit.", - "operationId": "CreateUnit", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "1a4196ce-da08-47b1-bac6-03282135b268" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "bd5c11fe-1052-479a-9d74-7e26ad3c199a" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "1a4196ce-da08-47b1-bac6-03282135b268" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "bd5c11fe-1052-479a-9d74-7e26ad3c199a" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "1a4196ce-da08-47b1-bac6-03282135b268" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "bd5c11fe-1052-479a-9d74-7e26ad3c199a" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "1a4196ce-da08-47b1-bac6-03282135b268" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "bd5c11fe-1052-479a-9d74-7e26ad3c199a" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnit" - }, - "examples": { - "Example 3": { - "summary": "Unit with equation", - "description": "Example of the inch unit from the MI Training database which contains an equation", - "value": { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 4": { - "summary": "Unit with relative symbol", - "description": "Example of the Kelvin unit from the MI Training database which contains a relative symbol", - "value": { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitCreationException" - }, - "examples": { - "Example 1": { - "summary": "Empty symbol", - "description": "The unit symbol was not provided or is empty.", - "value": { - "message": "Cannot create Unit 'NewUnit'", - "code": "unitCreation", - "name": "NewUnit", - "errors": [ - { - "message": "Unit must have a symbol", - "reason": "emptySymbol" - } - ] - } - }, - "Example 2": { - "summary": "Duplicate symbol", - "description": "A unit with the same symbol already exists in the database.", - "value": { - "message": "Cannot create Unit 'Kilogram'", - "code": "unitCreation", - "name": "Kilogram", - "errors": [ - { - "message": "A Unit with the symbol 'kg' already exists.", - "reason": "duplicateSymbol", - "symbol": "kg" - } - ] - } - }, - "Example 3": { - "summary": "Name already exists", - "description": "A unit with the same name already exists.", - "value": { - "message": "Cannot create Unit 'Kilogram'", - "code": "unitCreation", - "name": "Kilogram", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Unit with name 'Kilogram' already exists.", - "reason": "nameAlreadyExists", - "name": "Kilogram", - "entityType": "unit" - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateUnit: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/units/{unit-guid}": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get individual units", - "operationId": "GetUnit", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnit" - }, - "examples": { - "Example 1": { - "summary": "Unit with equation", - "description": "Example of the inch unit from the MI Training database which contains an equation", - "value": { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 2": { - "summary": "Unit with relative symbol", - "description": "Example of the Kelvin unit from the MI Training database which contains a relative symbol", - "value": { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - } - } - } - }, - "404": { - "description": "Database or unit not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Units" - ], - "summary": "Update unit.", - "operationId": "UpdateUnit", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "885220a6-7dce-4ffb-a63a-3a5942eb8c65" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "885220a6-7dce-4ffb-a63a-3a5942eb8c65" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "885220a6-7dce-4ffb-a63a-3a5942eb8c65" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "885220a6-7dce-4ffb-a63a-3a5942eb8c65" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnit" - }, - "examples": { - "Example 7": { - "summary": "Unit with equation", - "description": "Example of the inch unit from the MI Training database which contains an equation", - "value": { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 8": { - "summary": "Unit with relative symbol", - "description": "Example of the Kelvin unit from the MI Training database which contains a relative symbol", - "value": { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Empty symbol", - "description": "The unit symbol was set to an empty value.", - "value": { - "message": "Cannot update Unit '0000007a-0013-4fff-8fff-0000ffff0000'", - "code": "unitUpdate", - "guid": "0000007a-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "Unit must have a symbol", - "reason": "emptySymbol" - } - ] - } - }, - "Example 2": { - "summary": "Duplicate symbol", - "description": "A unit with the same symbol already exists in the database.", - "value": { - "message": "Cannot update Unit '0000007a-0013-4fff-8fff-0000ffff0000'", - "code": "unitUpdate", - "guid": "0000007a-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "A Unit with the symbol 'kg' already exists.", - "reason": "duplicateSymbol", - "symbol": "kg" - } - ] - } - }, - "Example 3": { - "summary": "Name already exists", - "description": "A unit with the same name already exists.", - "value": { - "message": "Cannot update Unit '0000007a-0013-4fff-8fff-0000ffff0000'", - "code": "unitUpdate", - "guid": "0000007a-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "The name or GUID is not valid.", - "reason": "namedEntity", - "errors": [ - { - "message": "Unit with name 'Kilogram' already exists.", - "reason": "nameAlreadyExists", - "name": "Kilogram", - "entityType": "unit" - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Invalid JSON", - "description": "The JSON body could not be deserialized.", - "value": { - "message": "UpdateUnit: Invalid JSON in request body", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or unit not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Units" - ], - "summary": "Delete unit.", - "operationId": "DeleteUnit", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. A unit cannot be deleted if it is used in an attribute, parameter, constant, expression, local tabular column, in the equation of another unit, or as the database currency unit.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Used by attributes", - "description": "The unit cannot be deleted, because it is used by the following attributes: 'Yield Strength (elastic limit)' with GUID '0000011b-0001-4fff-8fff-dd92ffff0000' in the 'MaterialUniverse' table (GUID '0000dd92-0011-4fff-8fff-0000ffff0000'), and 'Yield Strength' with GUID '2b233cf4-fd42-4ab0-b8de-2227c9b71248' in the 'Training Exercise for Import' table (GUID '0404f83b-64fb-47b1-8f3c-3388c513c9b0')", - "value": { - "message": "Cannot delete Unit with GUID '0000002b-0013-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "entityType": "unit", - "entityGuid": "0000002b-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more attributes.", - "reason": "usage", - "referencedByType": "attribute", - "referencedBy": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield Strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "name": "Yield Strength", - "guid": "2b233cf4-fd42-4ab0-b8de-2227c9b71248" - } - ] - } - ] - } - } - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or unit not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/units/{unit-guid}:compatible-units": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get compatible units for unit", - "operationId": "GetCompatibleUnits", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitsInfo" - }, - "examples": { - "Example 1": { - "summary": "Units", - "description": "Example of units from the MI Training database", - "value": { - "units": [ - { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database or unit not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/units/{unit-guid}:usages": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get all usages of unit", - "operationId": "GetUnitUsages", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "response-filters", - "in": "query", - "description": "The unit usage types to include in the response. If none are provided, all types are included.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitUsageType" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitUsage" - }, - "examples": { - "Example 1": { - "summary": "Unit usage", - "description": "Displays some example usages of the unit Kelvin in the MI Training database. ", - "value": { - "attributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Melting point", - "guid": "0000000d-0001-4fff-8fff-dd92ffff0000" - } - ], - "parameters": [ - { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "units": [ - { - "equation": "(5/9)*[K]", - "name": "Temperature (Rankine/Fahrenheit)", - "symbol": "°R", - "relativeSymbol": "°F", - "guid": "00000003-0013-4fff-8fff-0000ffff0000" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database or unit not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/units:validate-equation": { - "post": { - "tags": [ - "Schema - Units" - ], - "summary": "Check whether the unit equation is valid.", - "operationId": "ValidateUnitEquation", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationResponse" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/units-grouped-by-compatibility": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get units grouped by compatibility, each grouping contains only compatible units", - "operationId": "GetUnitsGroupedByCompatibility", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitsGroupingInfo" - }, - "examples": { - "Example 1": { - "summary": "Units grouped by compatibilty", - "description": "Example of units grouped by compatibility", - "value": { - "unitGroups": [ - [ - { - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "cm", - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "m", - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - ], - [ - { - "symbol": "Pa", - "guid": "00000025-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "bar", - "guid": "000000de-0013-4fff-8fff-0000ffff0000" - } - ] - ] - } - } - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/unit-systems": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get all unit systems in the database", - "operationId": "GetUnitSystems", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitSystemsInfo" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Units" - ], - "summary": "Create a new unit system.", - "operationId": "CreateUnitSystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common", - "guid": "67148e5d-a394-4be5-b3d6-36b6aee7e9bd" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common", - "guid": "67148e5d-a394-4be5-b3d6-36b6aee7e9bd" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common", - "guid": "67148e5d-a394-4be5-b3d6-36b6aee7e9bd" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common", - "guid": "67148e5d-a394-4be5-b3d6-36b6aee7e9bd" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitSystem" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/unit-systems/{unit-system-guid}": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get an individual unit system", - "operationId": "GetUnitSystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-system-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitSystem" - } - } - } - }, - "404": { - "description": "Database or unit system not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Units" - ], - "summary": "Update a unit system.", - "operationId": "UpdateUnitSystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-system-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Everything for a unit system", - "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)", - "guid": "b2fdcac6-f1b0-4575-97f7-86c694eca836" - } - }, - "Example 2": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "guid": "9e99289c-ff6d-4b3a-b09b-08fc2765676a" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Everything for a unit system", - "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)", - "guid": "b2fdcac6-f1b0-4575-97f7-86c694eca836" - } - }, - "Example 2": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "guid": "9e99289c-ff6d-4b3a-b09b-08fc2765676a" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Everything for a unit system", - "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)", - "guid": "b2fdcac6-f1b0-4575-97f7-86c694eca836" - } - }, - "Example 2": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "guid": "9e99289c-ff6d-4b3a-b09b-08fc2765676a" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUnitSystem" - }, - "examples": { - "Example 1": { - "summary": "Everything for a unit system", - "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)", - "guid": "b2fdcac6-f1b0-4575-97f7-86c694eca836" - } - }, - "Example 2": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "UK Imperial (Updated)" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "guid": "9e99289c-ff6d-4b3a-b09b-08fc2765676a" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitSystem" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or unit system not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Units" - ], - "summary": "Delete a unit system.", - "operationId": "DeleteUnitSystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "unit-system-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or unit system not found" - } - } - } - }, - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates/{templateGuid}": { - "get": { - "tags": [ - "Schema - XY Chart Templates" - ], - "summary": "Get XY chart template in database.", - "operationId": "GetTemplate", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "tableGuid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "templateGuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaXYChartTemplate" - } - } - } - }, - "404": { - "description": "Database, table or chart template not found" - } - } - } - }, - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates": { - "get": { - "tags": [ - "Schema - XY Chart Templates" - ], - "summary": "Get XY chart templates in database", - "operationId": "GetTemplates", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "tableGuid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "schema": { - "type": "integer", - "format": "int32", - "default": 10 - } - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaXYChartTemplatesInfo" - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-identity}:search": { - "post": { - "tags": [ - "Search" - ], - "summary": "Runs a search against a given database and table identity", - "operationId": "DatabaseSearchInTableWithIdentity", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "406d6710-033c-4911-8ce0-8a91e31ea446", - "a9fb804a-d873-4b1a-b05c-35f2c899aeca" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "406d6710-033c-4911-8ce0-8a91e31ea446", - "a9fb804a-d873-4b1a-b05c-35f2c899aeca" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "406d6710-033c-4911-8ce0-8a91e31ea446", - "a9fb804a-d873-4b1a-b05c-35f2c899aeca" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "406d6710-033c-4911-8ce0-8a91e31ea446", - "a9fb804a-d873-4b1a-b05c-35f2c899aeca" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - } - } - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:search": { - "post": { - "tags": [ - "Search" - ], - "summary": "Runs a search against a given database and table guid", - "operationId": "DatabaseSearchInTableWithGuid", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 31": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 33": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 34": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 35": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 36": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 37": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 38": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 39": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 40": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 41": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 42": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "12e44bf1-315c-4c48-b716-58ec3016a851", - "28060e62-4796-49e2-a18c-35f2ebe8bc66" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 43": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 44": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 45": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 46": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 47": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 48": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 49": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 50": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 51": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 52": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 53": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 54": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 55": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 56": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 57": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 58": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 59": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 60": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 31": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 33": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 34": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 35": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 36": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 37": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 38": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 39": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 40": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 41": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 42": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "12e44bf1-315c-4c48-b716-58ec3016a851", - "28060e62-4796-49e2-a18c-35f2ebe8bc66" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 43": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 44": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 45": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 46": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 47": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 48": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 49": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 50": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 51": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 52": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 53": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 54": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 55": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 56": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 57": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 58": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 59": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 60": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 31": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 33": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 34": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 35": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 36": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 37": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 38": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 39": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 40": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 41": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 42": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "12e44bf1-315c-4c48-b716-58ec3016a851", - "28060e62-4796-49e2-a18c-35f2ebe8bc66" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 43": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 44": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 45": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 46": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 47": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 48": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 49": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 50": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 51": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 52": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 53": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 54": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 55": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 56": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 57": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 58": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 59": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 60": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 31": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 33": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 34": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 35": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 36": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 37": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 38": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 39": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 40": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 41": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 42": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "12e44bf1-315c-4c48-b716-58ec3016a851", - "28060e62-4796-49e2-a18c-35f2ebe8bc66" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 43": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 44": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 45": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 46": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 47": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 48": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 49": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 50": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 51": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 52": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 53": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 54": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 55": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 56": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 57": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 58": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 59": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 60": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - } - } - } - } - } - }, - "/v1alpha/databases/{database-key}:search": { - "post": { - "tags": [ - "Search" - ], - "summary": "Runs a search against a given database", - "operationId": "DatabaseSearch", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode.\r\n- If set to read, uses the latest version of records and tables available in read mode.\r\n- If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database.\r\n- If not provided, defaults to write mode if the user is allowed to see that.\r\nCan also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "692dfd6e-3363-4f7f-9bde-aa4b4bd1b9b4", - "0111ce36-c3ef-477d-9667-ea282b724714" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text search in multiple tables by table GUID", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "property": "tableGuid", - "innerCriterion": { - "all": [], - "any": [ - "0000dd92-0011-4fff-8fff-0000ffff0000", - "0000b5e2-0011-4fff-8fff-0000ffff0000" - ], - "none": [], - "type": "discreteGuidValues" - }, - "type": "recordProperty" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search in multiple tables by table name", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [], - "any": [ - { - "property": "tableName", - "innerCriterion": { - "value": "MaterialUniverse", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - }, - { - "property": "tableName", - "innerCriterion": { - "value": "Design Data", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - } - ], - "none": [], - "type": "boolean" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "692dfd6e-3363-4f7f-9bde-aa4b4bd1b9b4", - "0111ce36-c3ef-477d-9667-ea282b724714" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text search in multiple tables by table GUID", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "property": "tableGuid", - "innerCriterion": { - "all": [], - "any": [ - "0000dd92-0011-4fff-8fff-0000ffff0000", - "0000b5e2-0011-4fff-8fff-0000ffff0000" - ], - "none": [], - "type": "discreteGuidValues" - }, - "type": "recordProperty" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search in multiple tables by table name", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [], - "any": [ - { - "property": "tableName", - "innerCriterion": { - "value": "MaterialUniverse", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - }, - { - "property": "tableName", - "innerCriterion": { - "value": "Design Data", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - } - ], - "none": [], - "type": "boolean" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "692dfd6e-3363-4f7f-9bde-aa4b4bd1b9b4", - "0111ce36-c3ef-477d-9667-ea282b724714" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text search in multiple tables by table GUID", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "property": "tableGuid", - "innerCriterion": { - "all": [], - "any": [ - "0000dd92-0011-4fff-8fff-0000ffff0000", - "0000b5e2-0011-4fff-8fff-0000ffff0000" - ], - "none": [], - "type": "discreteGuidValues" - }, - "type": "recordProperty" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search in multiple tables by table name", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [], - "any": [ - { - "property": "tableName", - "innerCriterion": { - "value": "MaterialUniverse", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - }, - { - "property": "tableName", - "innerCriterion": { - "value": "Design Data", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - } - ], - "none": [], - "type": "boolean" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "692dfd6e-3363-4f7f-9bde-aa4b4bd1b9b4", - "0111ce36-c3ef-477d-9667-ea282b724714" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text search in multiple tables by table GUID", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table GUID.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "property": "tableGuid", - "innerCriterion": { - "all": [], - "any": [ - "0000dd92-0011-4fff-8fff-0000ffff0000", - "0000b5e2-0011-4fff-8fff-0000ffff0000" - ], - "none": [], - "type": "discreteGuidValues" - }, - "type": "recordProperty" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Free text search in multiple tables by table name", - "description": "A free text search in MI_TRAINING tables 'MaterialUniverse' or 'Design Data' by table name.", - "value": { - "criterion": { - "all": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [], - "any": [ - { - "property": "tableName", - "innerCriterion": { - "value": "MaterialUniverse", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - }, - { - "property": "tableName", - "innerCriterion": { - "value": "Design Data", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "type": "recordProperty" - } - ], - "none": [], - "type": "boolean" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - } - } - } - } - } - }, - "/v1alpha/integration-schemas/{schema}:search": { - "post": { - "tags": [ - "Search" - ], - "summary": "Runs a search against the integration schema.", - "operationId": "IntegrationSearch", - "parameters": [ - { - "name": "schema", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "0ed1abb6-e0c6-4141-ae6b-ee111b104e33", - "7232ff49-d977-4217-8b45-a1bc32a80789" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "0ed1abb6-e0c6-4141-ae6b-ee111b104e33", - "7232ff49-d977-4217-8b45-a1bc32a80789" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "0ed1abb6-e0c6-4141-ae6b-ee111b104e33", - "7232ff49-d977-4217-8b45-a1bc32a80789" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Free text search", - "description": "This example demonstrates how to create a new free text search with results sorted by relevance", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Free text search with boosted identities", - "description": "A free text search in MI_TRAINING in attributes with identities -4 (record name), 928 and 886 with results in the record name boosted by a factor of 20", - "value": { - "criterion": { - "value": "lead", - "attributes": { - "identities": [ - -4, - 928, - 886 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "attributeIdentitiesToBoost": [ - { - "identity": -4, - "boostFactor": 20.0 - } - ], - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Free text search with excluded columns", - "description": "A free text search in MI_TRAINING with local tabular columns 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table excluded from search.", - "value": { - "criterion": { - "value": "Intermediate", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "identities": [], - "guids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "specific" - }, - "type": "text" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Free text prefix search", - "description": "This example demonstrates how to create a new free text prefix search", - "value": { - "criterion": { - "prefix": "ste", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "textPrefix" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Simple attribute search", - "description": "A simple search in MI_TRAINING on an integer 8965 attribute, with results sorted by that attribute", - "value": { - "criterion": { - "innerCriterion": { - "gte": 1, - "lte": 10, - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "identity": 8965, - "attributeType": "integer", - "sortDirection": "ascending", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Attribute exists search", - "description": "A search in MI_TRAINING on for records that have data for integer 8965 attribute", - "value": { - "criterion": { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 7": { - "summary": "Multiple attribute search", - "description": "A search where results must match all three attribute criterion (the long text meta attribute exist, the date time attribute has a value in the given range, and the discrete attribute has one of the given values)", - "value": { - "criterion": { - "all": [ - { - "innerCriterion": { - "type": "longText" - }, - "identity": 5886, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "innerCriterion": { - "gte": "1990-01-01T00:00:00+00:00", - "lte": "1999-12-31T00:00:00+00:00", - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "all": [], - "any": [ - 1665, - 1666 - ], - "none": [], - "type": "discreteIdentityValues" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Attribute prefix search", - "description": "This example demonstrates how to create a new prefix search in MI_TRAINING in the 'Restricted Substances' table on the short text attribute 'Chemical Name'", - "value": { - "criterion": { - "innerCriterion": { - "prefix": "chr", - "type": "shortTextPrefix" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 9": { - "summary": "Nested boolean search", - "description": "A nested boolean search in MI_TRAINING where results must either match the free text search for 'steel', or both the integer attribute with identity 8965 exists and attribute with identity 928 is not applicable", - "value": { - "criterion": { - "all": [], - "any": [ - { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - { - "all": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - { - "identity": 928, - "isMetaAttribute": false, - "attributeCriterionType": "notApplicable", - "type": "attribute" - } - ], - "any": [], - "none": [], - "type": "boolean" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Record name search", - "description": "A search in MI_TRAINING for a value in either the (full) record name, the short (tree) name, or the breadcrumbs, sorted by (full) record name", - "value": { - "criterion": { - "all": [], - "any": [ - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -4, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -9, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - { - "innerCriterion": { - "value": "steel", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "identity": -10, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - } - ], - "none": [], - "type": "boolean" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Record color search", - "description": "A search in MI_TRAINING for results where the record color is red, sorted by record name", - "value": { - "criterion": { - "innerCriterion": { - "all": [ - "red" - ], - "any": [], - "none": [], - "textMatchBehavior": "contains", - "type": "discreteTextValues" - }, - "identity": -6, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "property": "recordName", - "sortType": "natural", - "sortDirection": "descending", - "type": "recordProperty" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Record list search", - "description": "A search in MI_TRAINING for results where the record is in any of the given (favorites) list", - "value": { - "criterion": { - "recordListIdentifiers": [ - "0ed1abb6-e0c6-4141-ae6b-ee111b104e33", - "7232ff49-d977-4217-8b45-a1bc32a80789" - ], - "type": "recordListMember" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Record reference search", - "description": "A search in MI_TRAINING for results where the record matches the record history GUID", - "value": { - "criterion": { - "databaseKey": "MI_Training", - "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", - "type": "reference" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Record ancestor search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorGuid": "00000024-000e-4fff-8fff-dd92ffff0000", - "directParentOnly": false, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Record ancestor history search", - "description": "A search in MI_TRAINING for results where the record is below the Glasses folder in the tree", - "value": { - "criterion": { - "ancestorHistoryGuid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3", - "directParentOnly": false, - "type": "recordAncestorHistory" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Top level records search", - "description": "A search in MI_TRAINING for results where the record has no parent in the tree", - "value": { - "criterion": { - "directParentOnly": true, - "type": "recordAncestor" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 17": { - "summary": "Subset search", - "description": "A search in MI_TRAINING for results where the record is in the Material Universe 'Ceramics' subset", - "value": { - "criterion": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "type": "subset" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Tabular data link exists", - "description": "A tabular search in MI_TRAINING where there is a tabular link from the tabular attribute 'Restricted substances that may be associated with this material'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Tabular data local column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where the 'amount' is greater than 10% ('amount' is a local column).", - "value": { - "criterion": { - "innerCriterion": { - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "localColumnCriterionType": "matches", - "type": "localColumn" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Tabular data linked attribute column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material', where there is a linked 'Restricted Substance' with an 'amount' greater than 10% ('amount' is a local column), and the 'Chemical name' attribute in the linked 'Restricted Substances' table contains 'Alkanes'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "localCriterion": { - "innerCriterion": { - "gte": 10.0, - "type": "range" - }, - "guid": "1f1e5808-5a10-4b70-9ff6-8b832bf561d8", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "value": "Alkanes", - "textMatchBehavior": "contains", - "type": "shortText" - }, - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Tabular data linked column column search", - "description": "A tabular search in MI_TRAINING on the tabular attribute 'Restricted substances that may be associated with this material' where there is a linked 'Restricted Substance', which has a linked 'Legislations and Lists' via the tabular attribute 'Legislations restricting its use', and the 'Legislation rating' is 'Banned with conditions'. Target attribute and table may both be omitted, but this could affect performance.", - "value": { - "criterion": { - "innerCriterion": { - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "innerCriterion": { - "innerCriterion": { - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "innerCriterion": { - "innerCriterion": { - "value": "Banned with conditions", - "textMatchBehavior": "exactMatch", - "type": "discreteText" - }, - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "6e5d7d7b-be80-4e81-b013-0a19db19305f", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Tabular linking value search", - "description": "A tabular search in MI_TRAINING where the tabular linking value for the tabular attribute 'Restricted substances associated with this material' contains '85535'", - "value": { - "criterion": { - "innerCriterion": { - "linkDatumType": "tabularAttribute", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "values": [ - "85535" - ], - "linkingValueMatchBehavior": "FreeTextMatchingRows", - "type": "tabularLinkingValue" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Record link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where record link to table with identity 59 exists where the target has a populated picture attribute with identity 8563. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "picture" - }, - "identity": 8563, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Record link exists search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a record link to table with identity 59 exists. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 59, - "targetDatabaseKey": "MI_TRAINING", - "linkDatumType": "recordLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "type": "link" - }, - "identity": 101, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 25": { - "summary": "Cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a cross database link to table with identity 56 in Target_Database exists and the linked record has a populated float functional meta attribute with identity 33. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 56, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": false, - "innerCriterion": { - "innerCriterion": { - "type": "floatFunctional" - }, - "identity": 33, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 45, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Reverse cross database link search", - "description": "A search in MI_TRAINING from Metals Pedigree table ($ad27baf0-42e9-4136-bc96-9dbbf116e265) where a reverse cross database link from table 39 in Target_Database exists and the linked record has a populated file attribute with identity 87. Note that link searches must be made against a specific table", - "value": { - "criterion": { - "innerCriterion": { - "targetTableIdentity": 39, - "targetDatabaseKey": "Target_Database", - "linkDatumType": "crossDatabaseLink", - "indirectLinks": "fromLinkDefinition", - "searchInReversedDirection": true, - "innerCriterion": { - "innerCriterion": { - "type": "file" - }, - "identity": 87, - "isMetaAttribute": true, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "localRowsBehavior": "AllRows", - "type": "link" - }, - "identity": 65, - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Paginated search", - "description": "A free text search where only the first 5 results will be returned initially, and the results have a sliding expiration time of 10 minutes", - "value": { - "criterion": { - "value": "steel", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "pagingOptions": { - "pageSize": 5, - "keepAliveInMinutes": 10, - "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Float functional graph search", - "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", - "value": { - "criterion": { - "innerCriterion": { - "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "numberOfSeriesGte": 1, - "showAsTable": false, - "type": "floatFunctionalGraph" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [ - { - "sortDirection": "ascending", - "type": "relevance" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Float functional search by attribute value", - "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", - "value": { - "criterion": { - "innerCriterion": { - "gte": 75.0, - "lte": 80.0, - "constraints": [ - { - "gte": 100.0, - "lte": 100.0, - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "type": "numeric" - } - ], - "type": "floatFunctionalData" - }, - "guid": "00000001-0001-4fff-8fff-dd92ffff0000", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Discrete functional search", - "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", - "value": { - "criterion": { - "innerCriterion": { - "anyGuids": [ - "00000032-0007-4fff-8fff-000cffff0000", - "00000033-0007-4fff-8fff-000cffff0000" - ], - "constraints": [ - { - "any": [ - "Fresh water" - ], - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "type": "discreteName" - } - ], - "type": "discreteFunctionalValues" - }, - "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", - "isMetaAttribute": false, - "attributeCriterionType": "matches", - "type": "attribute" - }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - } - } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/searches/{searchIdentifier}/results": { - "post": { - "tags": [ - "Search" - ], - "summary": "Returns search results by identifier", - "operationId": "GetSearchResults", - "parameters": [ - { - "name": "searchIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResultsRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResultsRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResultsRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResultsRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchResponse" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Search not found" - } - } - } - }, - "/v1alpha/searches/{searchIdentifier}": { - "delete": { - "tags": [ - "Search" - ], - "summary": "Delete search results by identifier", - "operationId": "DeleteSearchResults", - "parameters": [ - { - "name": "searchIdentifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Search not found" - } - } - } - }, - "/v1alpha/status": { - "get": { - "tags": [ - "Status" - ], - "summary": "Check whether the API is available", - "operationId": "Get", - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/v1alpha/status/databases": { - "get": { - "tags": [ - "Status" - ], - "summary": "Returns status information for all databases", - "operationId": "GetStatus", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" - } - } - } - } - } - } - } - }, - "/v1alpha/status/databases/{database-key}": { - "get": { - "tags": [ - "Status" - ], - "summary": "Returns status information for a given database", - "operationId": "GetDatabaseStatus", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" - } - } - } - } - } - } - }, - "/v1alpha/status/search-cluster": { - "get": { - "tags": [ - "Status" - ], - "summary": "Returns disk status information for the search cluster", - "operationId": "GetSearchClusterStatus", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchClusterStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchClusterStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchClusterStatus" - } - } - } - } - } - } - }, - "/v1alpha/status/searchServiceStatus": { - "get": { - "tags": [ - "Status" - ], - "summary": "Returns information about the Search Service status", - "operationId": "GetSearchServiceStatusAsync", - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchServiceStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchServiceStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchServiceStatus" - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/status/databases/{databaseKey}/searchIndexStatus": { - "get": { - "tags": [ - "Status" - ], - "summary": "Returns information about the Search Index status", - "operationId": "GetSearchIndexStatusAsync", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "includeErrorDetails", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - } - }, - "components": { - "schemas": { - "GrantaMIRecordPropertyFakeAttributeIdentities": { - "enum": [ - { - "name": "Breadcrumbs", - "identity": -10, - "guid": "00000007-0000-0000-0000-000000000000" - }, - { - "name": "TreeName", - "identity": -9, - "guid": "00000006-0000-0000-0000-000000000000" - }, - { - "name": "TableIdentity", - "identity": -8, - "guid": "00000005-0000-0000-0000-000000000000" - }, - { - "name": "TableName", - "identity": -7, - "guid": "00000004-0000-0000-0000-000000000000" - }, - { - "name": "RecordColor", - "identity": -6, - "guid": "00000003-0000-0000-0000-000000000000" - }, - { - "name": "DatabaseKey", - "identity": -5, - "guid": "00000002-0000-0000-0000-000000000000" - }, - { - "name": "RecordName", - "identity": -4, - "guid": "00000001-0000-0000-0000-000000000000" - }, - { - "name": "RecordModifiedBy", - "identity": -3, - "guid": "00000009-0000-0000-0000-000000000000" - }, - { - "name": "RecordCreatedBy", - "identity": -2, - "guid": "00000008-0000-0000-0000-000000000000" - } - ], - "type": "string", - "description": "Values that can be used in place of an attribute identity to perform a search, aggregation or export of a record property. RecordCreatedBy and RecordModifiedBy cannot be used in free text search or aggregation.", - "format": "int32" - }, - "GrantaMISearchFreeTextIdentifiers": { - "type": "object", - "properties": { - "attributeGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "columnGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAboutAttributeCannotBeMetaAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Cannot have a meta-attribute as an 'About attribute'.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'aboutAttributeCannotBeMeta'", - "x-discriminator-value": "aboutAttributeCannotBeMeta", - "x-discriminator-name": "reason" - }, - "GsaAccessControlCategoriesInfo": { - "required": [ - "categories" - ], - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategory" - } - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategory": { - "required": [ - "discreteType", - "guid", - "name" - ], - "type": "object", - "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryTableMapping" - }, - "description": "Optionally maps an attribute, and values applied to the table, for each table.\r\nThere can be at most one entry for each table.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategoryCreationException": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategoryErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNoSuchEntityAccessControlCategoryErrorDetail](#model-GsaNoSuchEntityAccessControlCategoryErrorDetail)\r\n * [GsaDiscreteValueNotInDiscreteTypeErrorDetail](#model-GsaDiscreteValueNotInDiscreteTypeErrorDetail)\r\n * [GsaAttributeNotOnTableErrorDetail](#model-GsaAttributeNotOnTableErrorDetail)\r\n * [GsaAttributeDiscreteTypeMismatchErrorDetail](#model-GsaAttributeDiscreteTypeMismatchErrorDetail)\r\n * [GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail](#model-GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail)\r\n * [GsaNamedEntityAccessControlCategoryErrorDetail](#model-GsaNamedEntityAccessControlCategoryErrorDetail)\r\n * [GsaDuplicateTableErrorDetail](#model-GsaDuplicateTableErrorDetail)\r\n * [GsaDuplicateDiscreteValueErrorDetail](#model-GsaDuplicateDiscreteValueErrorDetail)\r\n * [GsaNoSuchTableMappingErrorDetail](#model-GsaNoSuchTableMappingErrorDetail)\r\n * [GsaTableVersionStateAccessControlCategoryErrorDetail](#model-GsaTableVersionStateAccessControlCategoryErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "noSuchEntity": "#/components/schemas/GsaNoSuchEntityAccessControlCategoryErrorDetail", - "discreteValueNotInDiscreteType": "#/components/schemas/GsaDiscreteValueNotInDiscreteTypeErrorDetail", - "attributeNotOnTable": "#/components/schemas/GsaAttributeNotOnTableErrorDetail", - "attributeDiscreteTypeMismatch": "#/components/schemas/GsaAttributeDiscreteTypeMismatchErrorDetail", - "multipleDefaultValuesInSingleValuedDiscrete": "#/components/schemas/GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityAccessControlCategoryErrorDetail", - "duplicateTable": "#/components/schemas/GsaDuplicateTableErrorDetail", - "duplicateDiscreteValue": "#/components/schemas/GsaDuplicateDiscreteValueErrorDetail", - "noSuchTableMapping": "#/components/schemas/GsaNoSuchTableMappingErrorDetail", - "tableVersionState": "#/components/schemas/GsaTableVersionStateAccessControlCategoryErrorDetail" - } - } - }, - "GsaAccessControlCategoryErrorReason": { - "enum": [ - "noSuchEntity", - "discreteValueNotInDiscreteType", - "attributeNotOnTable", - "attributeDiscreteTypeMismatch", - "multipleDefaultValuesInSingleValuedDiscrete", - "namedEntity", - "duplicateTable", - "duplicateDiscreteValue", - "noSuchTableMapping", - "tableVersionState" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • noSuchEntity: An entity (table, attribute, discrete type, or discrete value) could not be found.
    • \r\n
  • discreteValueNotInDiscreteType: A discrete value does not belong to the specified discrete type.
    • \r\n
  • attributeNotOnTable: The attribute does not belong to the specified table.
    • \r\n
  • attributeDiscreteTypeMismatch: The attribute does not use the correct discrete type.
    • \r\n
  • multipleDefaultValuesInSingleValuedDiscrete: Multiple default values were specified for a single-valued discrete attribute.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • duplicateTable: A table GUID has been specified more than once.
    • \r\n
  • duplicateDiscreteValue: A discrete value GUID has been specified more than once.
    • \r\n
  • noSuchTableMapping: An existing table mapping was not found for this table. To create a mapping, specify a table and an attribute.
    • \r\n
  • tableVersionState: tableDiscreteValues can only be set if the table is unreleased or unversioned.
    • \r\n
\r\n" - }, - "GsaAccessControlCategoryInclude": { - "enum": [ - "tableMappings" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • tableMappings: Include tableMappings in the response.
    • \r\n
\r\n" - }, - "GsaAccessControlCategoryNoSuchEntityType": { - "enum": [ - "table", - "attribute", - "discreteType", - "discreteValue" - ], - "type": "string" - }, - "GsaAccessControlCategoryTableMapping": { - "required": [ - "attribute", - "table" - ], - "type": "object", - "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "description": "The values applied to the table for this category.", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategoryUpdateException": { - "required": [ - "categoryGuid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "categoryGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAccessControlDatabaseUserCapabilities": { - "required": [ - "attributeBasedCategories", - "permissionBasedAccessControl", - "permissionCategories" - ], - "type": "object", - "properties": { - "attributeBasedCategories": { - "$ref": "#/components/schemas/GsaUserCapabilities" - }, - "permissionCategories": { - "$ref": "#/components/schemas/GsaUserCapabilities" - }, - "permissionBasedAccessControl": { - "$ref": "#/components/schemas/GsaUserCapabilities" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nattributeBasedCategories: Whether the current user can read from or write to the attribute-based access control categories.\r\n\r\npermissionCategories: Whether the current user can read from or write to the permission-based access control schema.\r\n\r\npermissionBasedAccessControl: Whether the current user can read from or write to the applied permission-based access control." - }, - "GsaAccessControlEntitiesAggregationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlAggregationErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlEntitiesErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The access control entities are not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionBasedAccessControlAggregationErrorDetail](#model-GsaPermissionBasedAccessControlAggregationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'accessControlEntities'", - "x-discriminator-value": "accessControlEntities", - "x-discriminator-name": "reason" - }, - "GsaAccessControlEntitiesErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlEntitiesErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNoSuchEntitiesAccessControlEntitiesErrorDetail](#model-GsaNoSuchEntitiesAccessControlEntitiesErrorDetail)\r\n * [GsaNoSuchSubsetAccessControlEntitiesErrorDetail](#model-GsaNoSuchSubsetAccessControlEntitiesErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "noSuchEntities": "#/components/schemas/GsaNoSuchEntitiesAccessControlEntitiesErrorDetail", - "noSuchSubset": "#/components/schemas/GsaNoSuchSubsetAccessControlEntitiesErrorDetail" - } - } - }, - "GsaAccessControlEntitiesUpdateOperationsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlUpdateOperationsErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlEntitiesErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The access control entities are not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionBasedAccessControlUpdateOperationsErrorDetail](#model-GsaPermissionBasedAccessControlUpdateOperationsErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'accessControlEntities'", - "x-discriminator-value": "accessControlEntities", - "x-discriminator-name": "reason" - }, - "GsaAccessControlEntity": { - "required": [ - "entityType" - ], - "type": "object", - "properties": { - "entityType": { - "$ref": "#/components/schemas/GsaAccessControlEntityType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaRecordVersionAccessControlEntity](#model-GsaRecordVersionAccessControlEntity)\r\n * [GsaAttributeAccessControlEntity](#model-GsaAttributeAccessControlEntity)\r\n * [GsaDatabaseAccessControlEntity](#model-GsaDatabaseAccessControlEntity)\r\n * [GsaTableAccessControlEntity](#model-GsaTableAccessControlEntity)\r\n * [GsaExpressionAccessControlEntity](#model-GsaExpressionAccessControlEntity)\r\n * [GsaTableDescendantsAccessControlEntity](#model-GsaTableDescendantsAccessControlEntity)\r\n * [GsaRecordHistoryDescendantsAccessControlEntity](#model-GsaRecordHistoryDescendantsAccessControlEntity)", - "discriminator": { - "propertyName": "entityType", - "mapping": { - "recordVersion": "#/components/schemas/GsaRecordVersionAccessControlEntity", - "attribute": "#/components/schemas/GsaAttributeAccessControlEntity", - "database": "#/components/schemas/GsaDatabaseAccessControlEntity", - "table": "#/components/schemas/GsaTableAccessControlEntity", - "expression": "#/components/schemas/GsaExpressionAccessControlEntity", - "tableDescendants": "#/components/schemas/GsaTableDescendantsAccessControlEntity", - "recordHistoryDescendants": "#/components/schemas/GsaRecordHistoryDescendantsAccessControlEntity" - } - } - }, - "GsaAccessControlEntityType": { - "enum": [ - "recordVersion", - "attribute", - "database", - "table", - "expression", - "tableDescendants", - "recordHistoryDescendants" - ], - "type": "string" - }, - "GsaAccessControlInfo": { - "required": [ - "mode" - ], - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/GsaAccessControlMode" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaPermissionBasedAccessControlInfo](#model-GsaPermissionBasedAccessControlInfo)\r\n * [GsaAttributeBasedAccessControlInfo](#model-GsaAttributeBasedAccessControlInfo)", - "discriminator": { - "propertyName": "mode", - "mapping": { - "permissionBased": "#/components/schemas/GsaPermissionBasedAccessControlInfo", - "attributeBased": "#/components/schemas/GsaAttributeBasedAccessControlInfo" - } - } - }, - "GsaAccessControlMode": { - "enum": [ - "permissionBased", - "attributeBased" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • permissionBased: Permission-based access control.
    • \r\n
  • attributeBased: Attribute-based access control.
    • \r\n
\r\n" - }, - "GsaAccessControlUserCapabilities": { - "required": [ - "currentMode", - "databaseUserCapabilities" - ], - "type": "object", - "properties": { - "currentMode": { - "$ref": "#/components/schemas/GsaUserCapabilities" - }, - "databaseUserCapabilities": { - "$ref": "#/components/schemas/GsaAccessControlDatabaseUserCapabilities" - } - }, - "additionalProperties": false, - "description": "\r\n\r\ncurrentMode: Whether the current user can get or set the current access control mode.\r\n\r\ndatabaseUserCapabilities: The highest level of capabilities the user has across all loaded databases." - }, - "GsaActivityLogApplicationNameFilter": { - "required": [ - "applicationNameToMatch" - ], - "type": "object", - "properties": { - "applicationNameToMatch": { - "type": "string" - }, - "matchType": { - "$ref": "#/components/schemas/GsaActivityLogMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nmatchType: Defines how the application name should be matched. If not specified, defaults to exactMatchCaseInsensitive." - }, - "GsaActivityLogApplicationNamesCollectionFilter": { - "required": [ - "applicationNamesToMatch" - ], - "type": "object", - "properties": { - "applicationNamesToMatch": { - "type": "array", - "items": { - "type": "string" - } - }, - "collectionMatchType": { - "$ref": "#/components/schemas/GsaActivityLogCollectionMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\ncollectionMatchType: Defines how the application names collection should be matched. If not specified, defaults to collectionExactMatch." - }, - "GsaActivityLogCollectionMatchType": { - "enum": [ - "collectionExactMatch", - "collectionContains" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • collectionExactMatch: Collection matches exactly.
    • \r\n
  • collectionContains: The collection contains this subset.
    • \r\n
\r\n" - }, - "GsaActivityLogDatabaseKeyFilter": { - "required": [ - "databaseKeyToMatch" - ], - "type": "object", - "properties": { - "databaseKeyToMatch": { - "type": "string", - "nullable": true - }, - "matchType": { - "$ref": "#/components/schemas/GsaActivityLogMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nmatchType: Defines how the database key should be matched. If not specified, defaults to exactMatchCaseInsensitive." - }, - "GsaActivityLogDateFilter": { - "type": "object", - "properties": { - "dateFrom": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "dateFromInclusive": { - "type": "boolean" - }, - "dateTo": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "dateToInclusive": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaActivityLogEntriesFilter": { - "type": "object", - "properties": { - "dateFilter": { - "$ref": "#/components/schemas/GsaActivityLogDateFilter" - }, - "usernameFilter": { - "$ref": "#/components/schemas/GsaActivityLogUsernameFilter" - }, - "applicationNamesCollectionFilter": { - "$ref": "#/components/schemas/GsaActivityLogApplicationNamesCollectionFilter" - }, - "applicationNameFilter": { - "$ref": "#/components/schemas/GsaActivityLogApplicationNameFilter" - }, - "databaseKeyFilter": { - "$ref": "#/components/schemas/GsaActivityLogDatabaseKeyFilter" - }, - "usageModeFilter": { - "$ref": "#/components/schemas/GsaActivityLogUsageModeFilter" - } - }, - "additionalProperties": false - }, - "GsaActivityLogEntriesInfo": { - "required": [ - "entries", - "itemType", - "links" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaPaginatedItemType" - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaActivityLogEntry" - } - }, - "links": { - "$ref": "#/components/schemas/GsaPaginationLinks" - } - }, - "additionalProperties": false - }, - "GsaActivityLogEntry": { - "required": [ - "applicationNames", - "date", - "usageMode", - "username" - ], - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "username": { - "type": "string" - }, - "applicationNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "databaseKey": { - "type": "string", - "nullable": true - }, - "usageMode": { - "$ref": "#/components/schemas/GsaActivityLogUsageMode" - } - }, - "additionalProperties": false - }, - "GsaActivityLogMatchType": { - "enum": [ - "exactMatchCaseInsensitive", - "containsCaseInsensitive" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • exactMatchCaseInsensitive: Exact match case-insensitive.
    • \r\n
  • containsCaseInsensitive: Contains case-insensitive.
    • \r\n
\r\n" - }, - "GsaActivityLogUsageMode": { - "enum": [ - "view", - "edit" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • view: View.
    • \r\n
  • edit: Edit.
    • \r\n
\r\n" - }, - "GsaActivityLogUsageModeFilter": { - "required": [ - "usageModeToMatch" - ], - "type": "object", - "properties": { - "usageModeToMatch": { - "$ref": "#/components/schemas/GsaActivityLogUsageMode" - } - }, - "additionalProperties": false - }, - "GsaActivityLogUsernameFilter": { - "required": [ - "usernameToMatch" - ], - "type": "object", - "properties": { - "usernameToMatch": { - "type": "string" - }, - "matchType": { - "$ref": "#/components/schemas/GsaActivityLogMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nmatchType: Defines how the username should be matched. If not specified, defaults to exactMatchCaseInsensitive." - }, - "GsaAddDatabase": { - "required": [ - "databaseKey", - "inputConnectionDetails" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "inputConnectionDetails": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - }, - "isReadOnly": { - "type": "boolean", - "description": "(Optional) True if the database should be set to read only after adding", - "nullable": true - }, - "loadingOrder": { - "type": "integer", - "description": "(Optional) The MI loading order for the database", - "format": "int32", - "nullable": true - }, - "language": { - "type": "string", - "description": "(Optional) The language of the database, used when indexing the database. Currently \"english\" is the only supported value.", - "nullable": true - }, - "versionGuid": { - "type": "string", - "description": "(Optional) Overrides the database version guid stored in the database. This must be unique across all the loaded databases.", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false, - "description": "\r\n\r\ninputConnectionDetails: The SQL server connection details for the database" - }, - "GsaAddDatabaseIssueType": { - "enum": [ - "schemaTooNew", - "schemaTooOld", - "duplicateGuid", - "duplicateVersionGuid", - "duplicateKey", - "invalidKey", - "unableToConnect", - "duplicateDatabase" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • schemaTooNew: The specified database schema is too new, you must upgrade MI:Server before this database can be used.
    • \r\n
  • schemaTooOld: The specified database schema is too old and must be upgraded.
    • \r\n
  • duplicateGuid: Duplicate Guid.
    • \r\n
  • duplicateVersionGuid: Duplicate version Guid.
    • \r\n
  • duplicateKey: Duplicate database key.
    • \r\n
  • invalidKey: Invalid database key.
    • \r\n
  • unableToConnect: Unable to connect to database.
    • \r\n
  • duplicateDatabase: Duplicate database - this database has already been added to MI.
    • \r\n
\r\n" - }, - "GsaAddDatabaseSecurityGroups": { - "required": [ - "adminGroup", - "grantGroup", - "powerUserGroup", - "readGroup", - "writeGroup" - ], - "type": "object", - "properties": { - "adminGroup": { - "type": "string", - "nullable": true - }, - "grantGroup": { - "type": "string", - "nullable": true - }, - "powerUserGroup": { - "type": "string", - "nullable": true - }, - "writeGroup": { - "type": "string", - "nullable": true - }, - "readGroup": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAddDatabaseValidationIssue": { - "required": [ - "IssueType" - ], - "type": "object", - "properties": { - "IssueType": { - "$ref": "#/components/schemas/GsaAddDatabaseIssueType" - }, - "additionalInformation": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDuplicateGuidAddDatabaseValidationIssue](#model-GsaDuplicateGuidAddDatabaseValidationIssue)\r\n * [GsaDuplicateVersionGuidAddDatabaseValidationIssue](#model-GsaDuplicateVersionGuidAddDatabaseValidationIssue)\r\n * [GsaDuplicateKeyAddDatabaseValidationIssue](#model-GsaDuplicateKeyAddDatabaseValidationIssue)\r\n * [GsaInvalidKeyAddDatabaseValidationIssue](#model-GsaInvalidKeyAddDatabaseValidationIssue)\r\n * [GsaSchemaTooNewAddDatabaseValidationIssue](#model-GsaSchemaTooNewAddDatabaseValidationIssue)\r\n * [GsaSchemaTooOldAddDatabaseValidationIssue](#model-GsaSchemaTooOldAddDatabaseValidationIssue)\r\n * [GsaUnableToConnectAddDatabaseValidationIssue](#model-GsaUnableToConnectAddDatabaseValidationIssue)\r\n * [GsaDuplicateDatabaseAddDatabaseValidationIssue](#model-GsaDuplicateDatabaseAddDatabaseValidationIssue)", - "discriminator": { - "propertyName": "IssueType", - "mapping": { - "duplicateGuid": "#/components/schemas/GsaDuplicateGuidAddDatabaseValidationIssue", - "duplicateVersionGuid": "#/components/schemas/GsaDuplicateVersionGuidAddDatabaseValidationIssue", - "duplicateKey": "#/components/schemas/GsaDuplicateKeyAddDatabaseValidationIssue", - "invalidKey": "#/components/schemas/GsaInvalidKeyAddDatabaseValidationIssue", - "schemaTooNew": "#/components/schemas/GsaSchemaTooNewAddDatabaseValidationIssue", - "schemaTooOld": "#/components/schemas/GsaSchemaTooOldAddDatabaseValidationIssue", - "unableToConnect": "#/components/schemas/GsaUnableToConnectAddDatabaseValidationIssue", - "duplicateDatabase": "#/components/schemas/GsaDuplicateDatabaseAddDatabaseValidationIssue" - } - } - }, - "GsaAddDatabaseValidationResult": { - "type": "object", - "properties": { - "addDatabaseIssues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAddRecordHistoryToSubset": { - "required": [ - "recordHistoryGuid" - ], - "type": "object", - "properties": { - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "recurseChildren": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaAdditionalSqlParameters": { - "type": "object", - "properties": { - "value": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAggregatePermissionAccessControlsRequest": { - "required": [ - "entities" - ], - "type": "object", - "properties": { - "entities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlEntity" - } - } - }, - "additionalProperties": false - }, - "GsaAggregation": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaAggregationType" - } - }, - "additionalProperties": false, - "description": "The results of aggregation.\r\n\r\nThis is one of: \r\n * [GsaAttributeAggregation](#model-GsaAttributeAggregation)\r\n * [GsaFreeTextAggregation](#model-GsaFreeTextAggregation)", - "discriminator": { - "propertyName": "type", - "mapping": { - "attribute": "#/components/schemas/GsaAttributeAggregation", - "text": "#/components/schemas/GsaFreeTextAggregation" - } - } - }, - "GsaAggregationCriterion": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaAggregationType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAttributeAggregationCriterion](#model-GsaAttributeAggregationCriterion)\r\n * [GsaFreeTextAggregationCriterion](#model-GsaFreeTextAggregationCriterion)", - "discriminator": { - "propertyName": "type", - "mapping": { - "attribute": "#/components/schemas/GsaAttributeAggregationCriterion", - "text": "#/components/schemas/GsaFreeTextAggregationCriterion" - } - } - }, - "GsaAggregationDatum": { - "required": [ - "datumType" - ], - "type": "object", - "properties": { - "datumType": { - "$ref": "#/components/schemas/GsaAggregationDatumType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaIntegerAggregation](#model-GsaIntegerAggregation)\r\n * [GsaPointAggregation](#model-GsaPointAggregation)\r\n * [GsaRangeAggregation](#model-GsaRangeAggregation)\r\n * [GsaIntegerHistogramAggregation](#model-GsaIntegerHistogramAggregation)\r\n * [GsaPointHistogramAggregation](#model-GsaPointHistogramAggregation)\r\n * [GsaRangeHistogramAggregation](#model-GsaRangeHistogramAggregation)\r\n * [GsaDateTimeAggregation](#model-GsaDateTimeAggregation)\r\n * [GsaDateTimeHistogramAggregation](#model-GsaDateTimeHistogramAggregation)\r\n * [GsaShortTextAggregation](#model-GsaShortTextAggregation)\r\n * [GsaDiscreteTextAggregation](#model-GsaDiscreteTextAggregation)\r\n * [GsaLinkAggregation](#model-GsaLinkAggregation)\r\n * [GsaLogicalAggregation](#model-GsaLogicalAggregation)\r\n * [GsaFloatFunctionalAggregation](#model-GsaFloatFunctionalAggregation)", - "discriminator": { - "propertyName": "datumType", - "mapping": { - "integer": "#/components/schemas/GsaIntegerAggregation", - "point": "#/components/schemas/GsaPointAggregation", - "range": "#/components/schemas/GsaRangeAggregation", - "integerHistogram": "#/components/schemas/GsaIntegerHistogramAggregation", - "pointHistogram": "#/components/schemas/GsaPointHistogramAggregation", - "rangeHistogram": "#/components/schemas/GsaRangeHistogramAggregation", - "dateTime": "#/components/schemas/GsaDateTimeAggregation", - "dateTimeHistogram": "#/components/schemas/GsaDateTimeHistogramAggregation", - "shortText": "#/components/schemas/GsaShortTextAggregation", - "discreteText": "#/components/schemas/GsaDiscreteTextAggregation", - "link": "#/components/schemas/GsaLinkAggregation", - "logical": "#/components/schemas/GsaLogicalAggregation", - "floatFunctionalGraph": "#/components/schemas/GsaFloatFunctionalAggregation" - } - } - }, - "GsaAggregationDatumCriterion": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaAggregationDatumCriterionType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDateTimeAggregationDatumCriterion](#model-GsaDateTimeAggregationDatumCriterion)\r\n * [GsaDateTimeHistogramAggregationDatumCriterion](#model-GsaDateTimeHistogramAggregationDatumCriterion)\r\n * [GsaDateTimeFixedWidthHistogramAggregationDatumCriterion](#model-GsaDateTimeFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion](#model-GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion)\r\n * [GsaDiscreteTextAggregationDatumCriterion](#model-GsaDiscreteTextAggregationDatumCriterion)\r\n * [GsaIntegerAggregationDatumCriterion](#model-GsaIntegerAggregationDatumCriterion)\r\n * [GsaPointAggregationDatumCriterion](#model-GsaPointAggregationDatumCriterion)\r\n * [GsaRangeAggregationDatumCriterion](#model-GsaRangeAggregationDatumCriterion)\r\n * [GsaIntegerHistogramAggregationDatumCriterion](#model-GsaIntegerHistogramAggregationDatumCriterion)\r\n * [GsaIntegerFixedWidthHistogramAggregationDatumCriterion](#model-GsaIntegerFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaPointHistogramAggregationDatumCriterion](#model-GsaPointHistogramAggregationDatumCriterion)\r\n * [GsaPointFixedWidthHistogramAggregationDatumCriterion](#model-GsaPointFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaRangeHistogramAggregationDatumCriterion](#model-GsaRangeHistogramAggregationDatumCriterion)\r\n * [GsaRangeFixedWidthHistogramAggregationDatumCriterion](#model-GsaRangeFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaShortTextAggregationDatumCriterion](#model-GsaShortTextAggregationDatumCriterion)\r\n * [GsaLinkAggregationDatumCriterion](#model-GsaLinkAggregationDatumCriterion)\r\n * [GsaLogicalAggregationDatumCriterion](#model-GsaLogicalAggregationDatumCriterion)\r\n * [GsaFloatFunctionalAggregationDatumCriterion](#model-GsaFloatFunctionalAggregationDatumCriterion)", - "discriminator": { - "propertyName": "type", - "mapping": { - "dateTime": "#/components/schemas/GsaDateTimeAggregationDatumCriterion", - "dateTimeHistogram": "#/components/schemas/GsaDateTimeHistogramAggregationDatumCriterion", - "dateTimeFixedWidthHistogram": "#/components/schemas/GsaDateTimeFixedWidthHistogramAggregationDatumCriterion", - "dateTimeFixedCalendarWidthHistogram": "#/components/schemas/GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion", - "discreteText": "#/components/schemas/GsaDiscreteTextAggregationDatumCriterion", - "integer": "#/components/schemas/GsaIntegerAggregationDatumCriterion", - "point": "#/components/schemas/GsaPointAggregationDatumCriterion", - "range": "#/components/schemas/GsaRangeAggregationDatumCriterion", - "integerHistogram": "#/components/schemas/GsaIntegerHistogramAggregationDatumCriterion", - "integerFixedWidthHistogram": "#/components/schemas/GsaIntegerFixedWidthHistogramAggregationDatumCriterion", - "pointHistogram": "#/components/schemas/GsaPointHistogramAggregationDatumCriterion", - "pointFixedWidthHistogram": "#/components/schemas/GsaPointFixedWidthHistogramAggregationDatumCriterion", - "rangeHistogram": "#/components/schemas/GsaRangeHistogramAggregationDatumCriterion", - "rangeFixedWidthHistogram": "#/components/schemas/GsaRangeFixedWidthHistogramAggregationDatumCriterion", - "shortText": "#/components/schemas/GsaShortTextAggregationDatumCriterion", - "link": "#/components/schemas/GsaLinkAggregationDatumCriterion", - "logical": "#/components/schemas/GsaLogicalAggregationDatumCriterion", - "floatFunctionalGraph": "#/components/schemas/GsaFloatFunctionalAggregationDatumCriterion" - } - } - }, - "GsaAggregationDatumCriterionType": { - "enum": [ - "dateTime", - "dateTimeHistogram", - "dateTimeFixedWidthHistogram", - "dateTimeFixedCalendarWidthHistogram", - "discreteText", - "integer", - "integerHistogram", - "integerFixedWidthHistogram", - "point", - "pointHistogram", - "pointFixedWidthHistogram", - "range", - "rangeHistogram", - "rangeFixedWidthHistogram", - "shortText", - "link", - "logical", - "floatFunctionalGraph" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • dateTime: Aggregation datum criterion date time type
    • \r\n
  • dateTimeHistogram: Aggregation datum criterion date time histogram type
    • \r\n
  • dateTimeFixedWidthHistogram: Aggregation datum criterion date time fixed width histogram type
    • \r\n
  • dateTimeFixedCalendarWidthHistogram: Aggregation datum criterion date time fixed calendar width histogram type
    • \r\n
  • discreteText: Aggregation datum criterion discrete type
    • \r\n
  • integer: Aggregation datum criterion integer type
    • \r\n
  • integerHistogram: Aggregation datum criterion integer histogram type
    • \r\n
  • integerFixedWidthHistogram: Aggregation datum criterion integer fixed width histogram type
    • \r\n
  • point: Aggregation datum criterion point type
    • \r\n
  • pointHistogram: Aggregation datum criterion point histogram type
    • \r\n
  • pointFixedWidthHistogram: Aggregation datum criterion point fixed width histogram type
    • \r\n
  • range: Aggregation datum criterion range type
    • \r\n
  • rangeHistogram: Aggregation datum criterion range histogram type
    • \r\n
  • rangeFixedWidthHistogram: Aggregation datum criterion range fixed width histogram type
    • \r\n
  • shortText: Aggregation datum criterion short text type
    • \r\n
  • link: Aggregation datum criterion link type
    • \r\n
  • logical: Aggregation datum criterion logical type
    • \r\n
  • floatFunctionalGraph: Aggregation datum criterion float functional graph type
    • \r\n
\r\n" - }, - "GsaAggregationDatumExistsCriterion": { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaAttributeType" - } - }, - "additionalProperties": false, - "description": "Inner criterion of an attribute search criterion for when the only bit of information about the datum that we want to convey is its type" - }, - "GsaAggregationDatumType": { - "enum": [ - "integer", - "point", - "range", - "integerHistogram", - "pointHistogram", - "rangeHistogram", - "dateTime", - "dateTimeHistogram", - "shortText", - "discreteText", - "link", - "logical", - "floatFunctionalGraph" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • integer: Aggregation datum integer type
    • \r\n
  • point: Aggregation datum point type
    • \r\n
  • range: Aggregation datum range type
    • \r\n
  • integerHistogram: Aggregation datum integer histogram type
    • \r\n
  • pointHistogram: Aggregation datum point histogram type
    • \r\n
  • rangeHistogram: Aggregation datum range histogram type
    • \r\n
  • dateTime: Aggregation datum date time type
    • \r\n
  • dateTimeHistogram: Aggregation datum date time histogram type
    • \r\n
  • shortText: Aggregation datum short text type
    • \r\n
  • discreteText: Aggregation datum discrete text type
    • \r\n
  • link: Aggregation datum link type
    • \r\n
  • logical: Aggregation datum logical type
    • \r\n
  • floatFunctionalGraph: Aggregation datum float functional graph type
    • \r\n
\r\n" - }, - "GsaAggregationType": { - "enum": [ - "attribute", - "text" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • attribute: Aggregation attribute type
    • \r\n
  • text: Aggregation text type
    • \r\n
\r\n" - }, - "GsaAggregationsRequest": { - "type": "object", - "properties": { - "criterion": { - "$ref": "#/components/schemas/GsaCriterion" - }, - "aggregationCriteria": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAggregationCriterion" - }, - "description": "The aggregations you wish to perform.", - "nullable": true - }, - "tableSearchBehaviour": { - "$ref": "#/components/schemas/GsaTableSearchBehaviour" - } - }, - "additionalProperties": false, - "description": "A request for aggregation information from a particular scope. The type of information\r\nrequested can vary: for example, for attributes, it could be a request for minimum/maximum\r\nvalues, or for common text terms.\r\n \r\nAn aggregation request is associated with a particular scope (database, table, integration\r\nschema, etc) based off the API invoked; however, the scope can be further narrowed down by\r\nproviding a criterion in the aggregation request. Only data from records matching that\r\ncriterion will be considered when aggregating data.\r\n \r\nNote that only some types of criterion will be supported: in particular, criteria that involve\r\n\"matches\" criteria against functional attributes, or link-attribute criteria against record\r\nlink groups, are not eligible to be used as an aggregation query criterion.\r\n\r\ncriterion: An optional query criterion, to be used to filter the collection of records to aggregate over.\r\n\r\ntableSearchBehaviour: Determines the behaviour of records in tables that are marked as hidden from search. The default behaviour is that these records are excluded." - }, - "GsaAggregationsResponse": { - "required": [ - "results" - ], - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAggregation" - } - } - }, - "additionalProperties": false - }, - "GsaAllProfilesInfo": { - "type": "object", - "properties": { - "profiles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimProfile" - }, - "nullable": true - }, - "defaultProfile": { - "$ref": "#/components/schemas/GsaSlimProfile" - } - }, - "additionalProperties": false, - "description": "Object containing list of all profiles as well as default profile if it is set and can be found within the list.\r\n\r\ndefaultProfile: Profile used by default in MI Applications. Null if no default profile is chosen or if default profile is not visible for current user." - }, - "GsaAllValuesSpecifier": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaValueSpecifier" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Specifies no filtering.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'all'", - "x-discriminator-value": "all", - "x-discriminator-name": "filterOn" - }, - "GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Anonymous expressions cannot be allowed without allowing all compatible expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'anonymousExpressionsMustAllowAllCompatible'", - "x-discriminator-value": "anonymousExpressionsMustAllowAllCompatible", - "x-discriminator-name": "reason" - }, - "GsaAppNameLicenseCheckoutRequest": { - "type": "object", - "properties": { - "appNames": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAppNameLicenseCheckoutResponse": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResult" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAppNameLicenseCheckoutResult": { - "type": "object", - "properties": { - "appName": { - "type": "string", - "nullable": true - }, - "licenseStateOk": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaAppendDiscreteValues": { - "required": [ - "discreteValues" - ], - "type": "object", - "properties": { - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - }, - "additionalProperties": false - }, - "GsaAppendPointValues": { - "required": [ - "values" - ], - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSetPointDatumValue" - } - } - }, - "additionalProperties": false - }, - "GsaApplicableDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatum" - }, - { - "required": [ - "datumType" - ], - "type": "object", - "properties": { - "datumType": { - "$ref": "#/components/schemas/GsaDatumType" - } - }, - "discriminator": { - "propertyName": "datumType", - "mapping": { - "integer": "#/components/schemas/GsaIntegerDatum", - "logical": "#/components/schemas/GsaLogicalDatum", - "shortText": "#/components/schemas/GsaShortTextDatum", - "longText": "#/components/schemas/GsaLongTextDatum", - "hyperlink": "#/components/schemas/GsaHyperlinkDatum", - "dateTime": "#/components/schemas/GsaDateTimeDatum", - "discrete": "#/components/schemas/GsaDiscreteDatum", - "range": "#/components/schemas/GsaRangeDatum", - "point": "#/components/schemas/GsaPointDatum", - "picture": "#/components/schemas/GsaPictureDatum", - "file": "#/components/schemas/GsaFileDatum", - "floatFunctional": "#/components/schemas/GsaFloatFunctionalDatum", - "discreteFunctional": "#/components/schemas/GsaDiscreteFunctionalDatum", - "tabular": "#/components/schemas/GsaTabularDatum" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatum](#model-GsaDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * [GsaIntegerDatum](#model-GsaIntegerDatum)\r\n * [GsaLogicalDatum](#model-GsaLogicalDatum)\r\n * [GsaShortTextDatum](#model-GsaShortTextDatum)\r\n * [GsaLongTextDatum](#model-GsaLongTextDatum)\r\n * [GsaHyperlinkDatum](#model-GsaHyperlinkDatum)\r\n * [GsaDateTimeDatum](#model-GsaDateTimeDatum)\r\n * [GsaDiscreteDatum](#model-GsaDiscreteDatum)\r\n * [GsaRangeDatum](#model-GsaRangeDatum)\r\n * [GsaPointDatum](#model-GsaPointDatum)\r\n * [GsaPictureDatum](#model-GsaPictureDatum)\r\n * [GsaFileDatum](#model-GsaFileDatum)\r\n * [GsaFloatFunctionalDatum](#model-GsaFloatFunctionalDatum)\r\n * [GsaDiscreteFunctionalDatum](#model-GsaDiscreteFunctionalDatum)\r\n * [GsaTabularDatum](#model-GsaTabularDatum)", - "x-discriminator-value": "applicable", - "x-discriminator-name": "notApplicable" - }, - "GsaApplicationsInfo": { - "type": "object", - "properties": { - "applications": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaApplyOptions": { - "required": [ - "applyAddsAsState", - "matchMode", - "retargetTabularAttributes" - ], - "type": "object", - "properties": { - "matchMode": { - "$ref": "#/components/schemas/GsaMatchMode" - }, - "applyAddsAsState": { - "type": "boolean" - }, - "retargetTabularAttributes": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaAssociationChainCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "associationChainLinks", - "associationChainName" - ], - "type": "object", - "properties": { - "associationChainName": { - "type": "string" - }, - "associationChainLinks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutAssociationChainLink" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'associationChain'", - "x-discriminator-value": "associationChain", - "x-discriminator-name": "itemType" - }, - "GsaAttribute": { - "required": [ - "defaultThresholdType", - "displayNames", - "guid", - "info", - "isHiddenFromSearchCriteria", - "isProtected", - "name", - "table", - "type" - ], - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "axisName": { - "$ref": "#/components/schemas/GsaAxisName" - }, - "helpPath": { - "type": "string", - "nullable": true - }, - "info": { - "$ref": "#/components/schemas/GsaAttributeInfo" - }, - "type": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "aboutAttribute": { - "$ref": "#/components/schemas/GsaSlimTypedAttribute" - }, - "isHiddenFromSearchCriteria": { - "type": "boolean", - "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches." - }, - "isProtected": { - "type": "boolean", - "description": "If true, the attribute is protected from all changes." - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaPointAttribute](#model-GsaPointAttribute)\r\n * [GsaIntegerAttribute](#model-GsaIntegerAttribute)\r\n * [GsaRangeAttribute](#model-GsaRangeAttribute)\r\n * [GsaLogicalAttribute](#model-GsaLogicalAttribute)\r\n * [GsaShortTextAttribute](#model-GsaShortTextAttribute)\r\n * [GsaLongTextAttribute](#model-GsaLongTextAttribute)\r\n * [GsaDateTimeAttribute](#model-GsaDateTimeAttribute)\r\n * [GsaDiscreteAttribute](#model-GsaDiscreteAttribute)\r\n * [GsaHyperlinkAttribute](#model-GsaHyperlinkAttribute)\r\n * [GsaFileAttribute](#model-GsaFileAttribute)\r\n * [GsaPictureAttribute](#model-GsaPictureAttribute)\r\n * [GsaTabularAttribute](#model-GsaTabularAttribute)\r\n * [GsaFloatFunctionalAttribute](#model-GsaFloatFunctionalAttribute)\r\n * [GsaDiscreteFunctionalAttribute](#model-GsaDiscreteFunctionalAttribute)\r\n * [GsaMathsFunctionalAttribute](#model-GsaMathsFunctionalAttribute)", - "discriminator": { - "propertyName": "type", - "mapping": { - "point": "#/components/schemas/GsaPointAttribute", - "integer": "#/components/schemas/GsaIntegerAttribute", - "range": "#/components/schemas/GsaRangeAttribute", - "logical": "#/components/schemas/GsaLogicalAttribute", - "shortText": "#/components/schemas/GsaShortTextAttribute", - "longText": "#/components/schemas/GsaLongTextAttribute", - "dateTime": "#/components/schemas/GsaDateTimeAttribute", - "discrete": "#/components/schemas/GsaDiscreteAttribute", - "hyperlink": "#/components/schemas/GsaHyperlinkAttribute", - "file": "#/components/schemas/GsaFileAttribute", - "picture": "#/components/schemas/GsaPictureAttribute", - "link": "#/components/schemas/GsaTabularAttribute", - "floatFunctional": "#/components/schemas/GsaFloatFunctionalAttribute", - "discreteFunctional": "#/components/schemas/GsaDiscreteFunctionalAttribute", - "mathsFunctional": "#/components/schemas/GsaMathsFunctionalAttribute" - } - } - }, - "GsaAttributeAccessControlEntity": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlEntity" - }, - { - "required": [ - "attributeGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "isMetaAttribute": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlEntity](#model-GsaAccessControlEntity)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "entityType" - }, - "GsaAttributeAggregation": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAggregation" - }, - { - "required": [ - "attributeAggregationType" - ], - "type": "object", - "properties": { - "attributeIdentity": { - "type": "integer", - "description": "The identity of the attribute that was aggregated over.", - "format": "int32", - "nullable": true - }, - "attributeGuid": { - "type": "string", - "description": "The GUID of the attribute that was aggregated over.", - "format": "uuid", - "nullable": true - }, - "attributeAggregationType": { - "$ref": "#/components/schemas/GsaAttributeAggregationType" - }, - "count": { - "type": "integer", - "description": "The number of records that have a populated (applicable) value for this attribute.\r\n(For multi-valued attributes: the number of records that have one or more populated\r\n(applicable) values for this attribute.)\r\n \r\nFor a tabular attribute, this will be the number of records that have at least one\r\ntabular row in this attribute, even if those rows might be filtered out from users'\r\nviews in some clients.", - "format": "int32" - } - }, - "discriminator": { - "propertyName": "attributeAggregationType", - "mapping": { - "value": "#/components/schemas/GsaAttributeValueAggregation", - "exists": "#/components/schemas/GsaAttributeExistsAggregation" - } - } - } - ], - "additionalProperties": false, - "description": "The results of aggregation over an attribute. In all cases this will report the number of records in\r\nthe aggregation scope that have a value for the attribute. In some cases, depending on the attribute\r\ntype, we may be able to report more information. For example, aggregating over a numeric attribute will\r\nalso provide the minimum and maximum values that attribute takes across records in the aggregation\r\nscope.\r\n\r\nThis extends: [GsaAggregation](#model-GsaAggregation)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * [GsaAttributeValueAggregation](#model-GsaAttributeValueAggregation)\r\n * [GsaAttributeExistsAggregation](#model-GsaAttributeExistsAggregation)", - "x-discriminator-value": "attribute", - "x-discriminator-name": "type" - }, - "GsaAttributeAggregationCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAggregationCriterion" - }, - { - "required": [ - "attributeAggregationCriterionType" - ], - "type": "object", - "properties": { - "identity": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "isMetaAttribute": { - "type": "boolean" - }, - "attributeAggregationCriterionType": { - "$ref": "#/components/schemas/GsaAttributeAggregationType" - } - }, - "discriminator": { - "propertyName": "attributeAggregationCriterionType", - "mapping": { - "value": "#/components/schemas/GsaAttributeAggregationValueCriterion", - "exists": "#/components/schemas/GsaAttributeAggregationExistsCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute. Exactly one of the identity or GUID must be provided.\r\n\r\nThis extends: [GsaAggregationCriterion](#model-GsaAggregationCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * [GsaAttributeAggregationValueCriterion](#model-GsaAttributeAggregationValueCriterion)\r\n * [GsaAttributeAggregationExistsCriterion](#model-GsaAttributeAggregationExistsCriterion)", - "x-discriminator-value": "attribute", - "x-discriminator-name": "type" - }, - "GsaAttributeAggregationExistsCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeAggregationCriterion" - }, - { - "required": [ - "innerCriterion" - ], - "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaAggregationDatumExistsCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute.\r\n\r\nThis extends: [GsaAttributeAggregationCriterion](#model-GsaAttributeAggregationCriterion)\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'exists'", - "x-discriminator-value": "exists", - "x-discriminator-name": "attributeAggregationCriterionType" - }, - "GsaAttributeAggregationType": { - "enum": [ - "value", - "exists" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • value: Attribute aggregation value type
    • \r\n
  • exists: Attribute aggregation exists type
    • \r\n
\r\n" - }, - "GsaAttributeAggregationValueCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeAggregationCriterion" - }, - { - "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute,\r\nincluding summary information about the values assumed by the attribute.\r\n \r\nFor a numeric attribute (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the attribute on some record.\r\n \r\nFor a simple text attribute (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that attribute.\r\n \r\nThis can also be used within the inner criteria of a 'link' attribute aggregation, to request\r\nan aggregation over a local tabular column.\r\n\r\nThis extends: [GsaAttributeAggregationCriterion](#model-GsaAttributeAggregationCriterion)\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'value'", - "x-discriminator-value": "value", - "x-discriminator-name": "attributeAggregationCriterionType" - }, - "GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "attributeGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Smart record link group source and target attributes cannot contain duplicates.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeAlreadySpecified'", - "x-discriminator-value": "attributeAlreadySpecified", - "x-discriminator-name": "reason" - }, - "GsaAttributeBasedAccessControlInfo": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlInfo" - }, - { - "required": [ - "currentRuleEngine" - ], - "type": "object", - "properties": { - "currentRuleEngine": { - "$ref": "#/components/schemas/GsaRuleEngine" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlInfo](#model-GsaAccessControlInfo)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'attributeBased'", - "x-discriminator-value": "attributeBased", - "x-discriminator-name": "mode" - }, - "GsaAttributeCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "attributeGuid" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "required": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "metaAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutAttributeItem" - }, - "nullable": true - }, - "tabularColumnGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "itemType" - }, - "GsaAttributeCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "isMetaAttribute": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAttributeCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCriterion" - }, - { - "required": [ - "attributeCriterionType" - ], - "type": "object", - "properties": { - "identity": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "isMetaAttribute": { - "type": "boolean" - }, - "attributeCriterionType": { - "$ref": "#/components/schemas/GsaAttributeCriterionType" - } - }, - "discriminator": { - "propertyName": "attributeCriterionType", - "mapping": { - "matches": "#/components/schemas/GsaAttributeMatchesCriterion", - "exists": "#/components/schemas/GsaAttributeExistsCriterion", - "notApplicable": "#/components/schemas/GsaAttributeNotApplicableCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "Base class for attribute criterions. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * [GsaAttributeMatchesCriterion](#model-GsaAttributeMatchesCriterion)\r\n * [GsaAttributeExistsCriterion](#model-GsaAttributeExistsCriterion)\r\n * [GsaAttributeNotApplicableCriterion](#model-GsaAttributeNotApplicableCriterion)", - "x-discriminator-value": "attribute", - "x-discriminator-name": "type" - }, - "GsaAttributeCriterionType": { - "enum": [ - "matches", - "exists", - "notApplicable" - ], - "type": "string" - }, - "GsaAttributeDeletionException": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDeletionException" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "entityType" - }, - "GsaAttributeDiscreteTypeMismatchErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "actualDiscreteTypeGuid", - "attributeGuid", - "expectedDiscreteTypeGuid" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "expectedDiscreteTypeGuid": { - "type": "string", - "format": "uuid" - }, - "actualDiscreteTypeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeDiscreteTypeMismatch'", - "x-discriminator-value": "attributeDiscreteTypeMismatch", - "x-discriminator-name": "reason" - }, - "GsaAttributeErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaAttributeErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAboutAttributeCannotBeMetaAttributeErrorDetail](#model-GsaAboutAttributeCannotBeMetaAttributeErrorDetail)\r\n * [GsaAttributeTypeAttributeErrorDetail](#model-GsaAttributeTypeAttributeErrorDetail)\r\n * [GsaDuplicateParameterGuidsAttributeErrorDetail](#model-GsaDuplicateParameterGuidsAttributeErrorDetail)\r\n * [GsaEmptyAxisNameAttributeErrorDetail](#model-GsaEmptyAxisNameAttributeErrorDetail)\r\n * [GsaFuncNoParamsAttributeErrorDetail](#model-GsaFuncNoParamsAttributeErrorDetail)\r\n * [GsaMathsFunctionalAttributeErrorDetail](#model-GsaMathsFunctionalAttributeErrorDetail)\r\n * [GsaMissingParameterGuidAttributeErrorDetail](#model-GsaMissingParameterGuidAttributeErrorDetail)\r\n * [GsaNamedEntityAttributeErrorDetail](#model-GsaNamedEntityAttributeErrorDetail)\r\n * [GsaNoSuchEntityAttributeErrorDetail](#model-GsaNoSuchEntityAttributeErrorDetail)\r\n * [GsaPointParametersRequiresMultiValuedAttributeErrorDetail](#model-GsaPointParametersRequiresMultiValuedAttributeErrorDetail)\r\n * [GsaTargetAttributeNotInTableAttributeErrorDetail](#model-GsaTargetAttributeNotInTableAttributeErrorDetail)\r\n * [GsaTargetAttributeTypeAttributeErrorDetail](#model-GsaTargetAttributeTypeAttributeErrorDetail)\r\n * [GsaThresholdTypeAttributeErrorDetail](#model-GsaThresholdTypeAttributeErrorDetail)\r\n * [GsaDuplicateTabularColumnGuidsErrorDetail](#model-GsaDuplicateTabularColumnGuidsErrorDetail)\r\n * [GsaExistingTabularColumnGuidErrorDetail](#model-GsaExistingTabularColumnGuidErrorDetail)\r\n * [GsaTabularColumnNameNotProvidedErrorDetail](#model-GsaTabularColumnNameNotProvidedErrorDetail)\r\n * [GsaDuplicateTabularColumnNamesErrorDetail](#model-GsaDuplicateTabularColumnNamesErrorDetail)\r\n * [GsaNoSuchEntityTabularColumnErrorDetail](#model-GsaNoSuchEntityTabularColumnErrorDetail)\r\n * [GsaMetaAttributeCannotHaveMetaAttributeErrorDetail](#model-GsaMetaAttributeCannotHaveMetaAttributeErrorDetail)\r\n * [GsaMultiValuedAttributeErrorDetail](#model-GsaMultiValuedAttributeErrorDetail)\r\n * [GsaTargetNotFullySpecifiedAttributeErrorDetail](#model-GsaTargetNotFullySpecifiedAttributeErrorDetail)\r\n * [GsaNoSuchTabularColumnAttributeErrorDetail](#model-GsaNoSuchTabularColumnAttributeErrorDetail)\r\n * [GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail](#model-GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail)\r\n * [GsaUpdateTabularColumnTypeAttributeErrorDetail](#model-GsaUpdateTabularColumnTypeAttributeErrorDetail)\r\n * [GsaCannotDeleteTabularColumnAttributeErrorDetail](#model-GsaCannotDeleteTabularColumnAttributeErrorDetail)\r\n * [GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail](#model-GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail)\r\n * [GsaCannotChangeDiscreteTypeAttributeErrorDetail](#model-GsaCannotChangeDiscreteTypeAttributeErrorDetail)\r\n * [GsaCannotRemoveParameterInUseAttributeErrorDetail](#model-GsaCannotRemoveParameterInUseAttributeErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "aboutAttributeCannotBeMeta": "#/components/schemas/GsaAboutAttributeCannotBeMetaAttributeErrorDetail", - "attributeType": "#/components/schemas/GsaAttributeTypeAttributeErrorDetail", - "duplicateParameterGuids": "#/components/schemas/GsaDuplicateParameterGuidsAttributeErrorDetail", - "emptyAxisName": "#/components/schemas/GsaEmptyAxisNameAttributeErrorDetail", - "funcNoParams": "#/components/schemas/GsaFuncNoParamsAttributeErrorDetail", - "mathsFunctional": "#/components/schemas/GsaMathsFunctionalAttributeErrorDetail", - "missingParameterGuid": "#/components/schemas/GsaMissingParameterGuidAttributeErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityAttributeErrorDetail", - "noSuchEntity": "#/components/schemas/GsaNoSuchEntityAttributeErrorDetail", - "pointParametersRequiresMultiValued": "#/components/schemas/GsaPointParametersRequiresMultiValuedAttributeErrorDetail", - "targetAttributeNotInTable": "#/components/schemas/GsaTargetAttributeNotInTableAttributeErrorDetail", - "targetAttributeType": "#/components/schemas/GsaTargetAttributeTypeAttributeErrorDetail", - "thresholdType": "#/components/schemas/GsaThresholdTypeAttributeErrorDetail", - "duplicateTabularColumnGuids": "#/components/schemas/GsaDuplicateTabularColumnGuidsErrorDetail", - "existingTabularColumnGuid": "#/components/schemas/GsaExistingTabularColumnGuidErrorDetail", - "tabularColumnNameNotProvided": "#/components/schemas/GsaTabularColumnNameNotProvidedErrorDetail", - "duplicateTabularColumnNames": "#/components/schemas/GsaDuplicateTabularColumnNamesErrorDetail", - "tabularColumnNoSuchEntity": "#/components/schemas/GsaNoSuchEntityTabularColumnErrorDetail", - "metaAttributeCannotHaveMetaAttribute": "#/components/schemas/GsaMetaAttributeCannotHaveMetaAttributeErrorDetail", - "multiValued": "#/components/schemas/GsaMultiValuedAttributeErrorDetail", - "targetNotFullySpecified": "#/components/schemas/GsaTargetNotFullySpecifiedAttributeErrorDetail", - "noSuchTabularColumn": "#/components/schemas/GsaNoSuchTabularColumnAttributeErrorDetail", - "updateTabularColumnPropertyNotProvided": "#/components/schemas/GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail", - "updateTabularColumnType": "#/components/schemas/GsaUpdateTabularColumnTypeAttributeErrorDetail", - "cannotDeleteTabularColumn": "#/components/schemas/GsaCannotDeleteTabularColumnAttributeErrorDetail", - "cannotCreateUnavailableTabularColumn": "#/components/schemas/GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail", - "cannotChangeDiscreteType": "#/components/schemas/GsaCannotChangeDiscreteTypeAttributeErrorDetail", - "cannotRemoveParameterInUse": "#/components/schemas/GsaCannotRemoveParameterInUseAttributeErrorDetail" - } - } - }, - "GsaAttributeErrorReason": { - "enum": [ - "aboutAttributeCannotBeMeta", - "attributeType", - "metaAttributeCannotHaveMetaAttribute", - "duplicateParameterGuids", - "emptyAxisName", - "funcNoParams", - "mathsFunctional", - "missingParameterGuid", - "namedEntity", - "noSuchEntity", - "pointParametersRequiresMultiValued", - "targetAttributeNotInTable", - "targetAttributeType", - "thresholdType", - "duplicateTabularColumnGuids", - "existingTabularColumnGuid", - "tabularColumnNameNotProvided", - "duplicateTabularColumnNames", - "tabularColumnNoSuchEntity", - "multiValued", - "targetNotFullySpecified", - "noSuchTabularColumn", - "updateTabularColumnPropertyNotProvided", - "updateTabularColumnType", - "cannotDeleteTabularColumn", - "cannotCreateUnavailableTabularColumn", - "cannotChangeDiscreteType", - "cannotRemoveParameterInUse" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • aboutAttributeCannotBeMeta: Cannot have a meta-attribute as an 'About attribute'.
    • \r\n
  • attributeType: When updating an existing attribute, attribute type must match.
    • \r\n
  • metaAttributeCannotHaveMetaAttribute: Meta-attribute cannot have a meta-attribute.
    • \r\n
  • duplicateParameterGuids: No duplicate parameter GUIDs allowed.
    • \r\n
  • emptyAxisName: Axis name cannot be empty or whitespace.
    • \r\n
  • funcNoParams: Functional attributes must have at least one parameter. Functional attributes only.
    • \r\n
  • mathsFunctional: Errors specific to Maths Functional attributes. See \"errors\" for details.
    • \r\n
  • missingParameterGuid: All supplied attribute parameters must have parameter GUIDs specified.
    • \r\n
  • namedEntity: The name or GUID is not valid. See \"errors\" for details.
    • \r\n
  • noSuchEntity: Could not find the entityType with the given GUID.
    • \r\n
  • pointParametersRequiresMultiValued: Only attributes marked as multi-valued can be parameterized. Point attributes only.
    • \r\n
  • targetAttributeNotInTable: The target attribute is not valid as it does not belong to the target table. Tabular attributes only.
    • \r\n
  • targetAttributeType: The target attribute is not valid as the target attribute of a tabular attribute as it is not a short text attribute. Tabular attributes only.
    • \r\n
  • thresholdType: Threshold type is not allowed for this attribute type.
    • \r\n
  • duplicateTabularColumnGuids: No duplicate tabular column GUIDs allowed.
    • \r\n
  • existingTabularColumnGuid: Tabular column with GUID already exists.
    • \r\n
  • tabularColumnNameNotProvided: Tabular Column must have a name.
    • \r\n
  • duplicateTabularColumnNames: No duplicate tabular column names allowed.
    • \r\n
  • tabularColumnNoSuchEntity: Could not find the entityType with the given GUID.
    • \r\n
  • multiValued: Cannot update the multi-valued flag. See multiValuedReasons for details.
    • \r\n
  • targetNotFullySpecified: Target must be fully specified because there is no existing Target to update.
    • \r\n
  • noSuchTabularColumn: Could not find the Tabular Column with the given GUID.
    • \r\n
  • updateTabularColumnPropertyNotProvided: A required property was not provided when creating a Tabular Column in an update. Required properties are: - UpdateLinkedAttributeTabularColumn: LinkedAttribute - UpdateLinkedColumnTabularColumn: LinkedColumn - UpdateLocalDiscreteTabularColumn: DiscreteType
    • \r\n
  • updateTabularColumnType: Tabular Column to update is not of the same type as the existing Tabular Column with the same GUID.
    • \r\n
  • cannotDeleteTabularColumn: Cannot delete a Tabular Column that has local data and is part of a version-controlled Table.
    • \r\n
  • cannotCreateUnavailableTabularColumn: Unavailable Tabular Columns cannot be created.
    • \r\n
  • cannotChangeDiscreteType: Cannot change the Discrete Type of a Tabular Column.
    • \r\n
  • cannotRemoveParameterInUse: Cannot remove a Parameter that is used in data
    • \r\n
\r\n" - }, - "GsaAttributeExistsAggregation": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeAggregation" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "The results of aggregation over an attribute, reporting only the number of records with a value\r\nfor the attribute.\r\n\r\nThis extends: [GsaAttributeAggregation](#model-GsaAttributeAggregation)\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'exists'", - "x-discriminator-value": "exists", - "x-discriminator-name": "attributeAggregationType" - }, - "GsaAttributeExistsCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeCriterion" - }, - { - "required": [ - "innerCriterion" - ], - "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "Criterion for matching record where there is data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'exists'", - "x-discriminator-value": "exists", - "x-discriminator-name": "attributeCriterionType" - }, - "GsaAttributeExportFailure": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaExportFailure" - }, - { - "required": [ - "failedAttributes" - ], - "type": "object", - "properties": { - "failedAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeReference" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "type" - }, - "GsaAttributeInfo": { - "required": [ - "chartable", - "expressionable", - "extendedName", - "foreignDataLinkGroups", - "isMetaAttribute", - "linkable", - "primaryDataLinkGroups", - "standardNames", - "typeCode" - ], - "type": "object", - "properties": { - "typeCode": { - "type": "string" - }, - "chartable": { - "type": "boolean", - "description": "Determines whether or not this attribute is chartable in an X/Y bubble chart." - }, - "expressionable": { - "type": "boolean", - "description": "Determines whether or not this attribute can be used in an expression." - }, - "linkable": { - "type": "boolean", - "description": "Determines whether or not this attribute can be linked to from a tabular column." - }, - "extendedName": { - "type": "string" - }, - "isMetaAttribute": { - "type": "boolean" - }, - "orderedMetaAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimTypedAttribute" - }, - "nullable": true - }, - "standardNames": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - }, - "primaryDataLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - }, - "foreignDataLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - }, - "primarySmartLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - }, - "foreignSmartLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAttributeInterpolationMethod": { - "enum": [ - "auto", - "none", - "linear", - "cubicSpline" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • auto: The default interpolation method should be applied.
    • \r\n
  • none: No interpolation should be performed to infer values between data points.
    • \r\n
  • linear: Linear interpolation should be performed to infer values between data points.
    • \r\n
  • cubicSpline: Cubic-spline interpolation should be performed to infer values between data points.
    • \r\n
\r\n" - }, - "GsaAttributeLinkPair": { - "required": [ - "attributeSource", - "attributeTarget" - ], - "type": "object", - "properties": { - "attributeSource": { - "$ref": "#/components/schemas/GsaTargetAttribute" - }, - "attributeTarget": { - "$ref": "#/components/schemas/GsaTargetAttribute" - } - }, - "additionalProperties": false - }, - "GsaAttributeMatchesCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeCriterion" - }, - { - "required": [ - "innerCriterion" - ], - "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaDatumCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "Criterion for a search matching values in a given attribute. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'matches'", - "x-discriminator-value": "matches", - "x-discriminator-name": "attributeCriterionType" - }, - "GsaAttributeNoSuchEntityType": { - "enum": [ - "dataRule", - "discreteType", - "parameter", - "unit", - "aboutAttribute" - ], - "type": "string" - }, - "GsaAttributeNotApplicableCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeCriterion" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Criterion for matching record where there is not applicable data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'notApplicable'", - "x-discriminator-value": "notApplicable", - "x-discriminator-name": "attributeCriterionType" - }, - "GsaAttributeNotOnTableErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "attributeGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeNotOnTable'", - "x-discriminator-value": "attributeNotOnTable", - "x-discriminator-name": "reason" - }, - "GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "sourceAttributeGuid", - "targetAttributeGuid" - ], - "type": "object", - "properties": { - "sourceAttributeGuid": { - "type": "string", - "format": "uuid" - }, - "targetAttributeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Discrete attributes in attribute pairs must have the same discrete type.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributePairDiscreteTypeMismatch'", - "x-discriminator-value": "attributePairDiscreteTypeMismatch", - "x-discriminator-name": "reason" - }, - "GsaAttributePairTypeMismatchSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "sourceAttributeGuid", - "targetAttributeGuid" - ], - "type": "object", - "properties": { - "sourceAttributeGuid": { - "type": "string", - "format": "uuid" - }, - "targetAttributeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Attributes in attribute pairs must have the same attribute type.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributePairTypeMismatch'", - "x-discriminator-value": "attributePairTypeMismatch", - "x-discriminator-name": "reason" - }, - "GsaAttributeReference": { - "required": [ - "databaseKey" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "attributeIdentity": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "attributeGuid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAttributeScaleType": { - "enum": [ - "notSet", - "linear", - "logarithmic" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • notSet: No scale type has been chosen, the default value should be applied.
    • \r\n
  • linear: Use a linear scale
    • \r\n
  • logarithmic: Use a logarithmic scale
    • \r\n
\r\n" - }, - "GsaAttributeSortCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSortCriterion" - }, - { - "type": "object", - "properties": { - "identity": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "sortType": { - "$ref": "#/components/schemas/GsaSortType" - } - } - } - ], - "additionalProperties": false, - "description": "Specifies an attribute based sort criterion for a search query. Either the GUID or identity of the sorting attribute must be provided.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: [GsaSortCriterion](#model-GsaSortCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "type" - }, - "GsaAttributeThresholdType": { - "enum": [ - "exists", - "doesNotExist", - "atLeast", - "atMost", - "equal", - "between", - "isOneOf", - "contains", - "isNot", - "isAllOf", - "none" - ], - "type": "string", - "description": "The threshold type for an attribute when used in searching.\r\nAllowed values depend on the attribute type as follows:\r\n- shortText: exists, doesNotExist, equal, contains, none\r\n- longText, file, hyperlink: exists, doesNotExist, contains, none\r\n- logical: exists, doesNotExist, equal, none\r\n- picture, link, tabular: exists, doesNotExist, none\r\n- point, range, integer, date, floatFunctional, mathsFunctional: exists, doesNotExist, atLeast, atMost, equal, between, none\r\n- discrete: exists, doesNotExist, atLeast, atMost, equal, isOneOf, isNot, isAllOf, none\r\n- discreteFunctional: exists, doesNotExist, atLeast, atMost, equal, isOneOf, none" - }, - "GsaAttributeToExport": { - "required": [ - "attributeType" - ], - "type": "object", - "properties": { - "identity": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "attributeType": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaLinkAttributeToExport](#model-GsaLinkAttributeToExport)\r\n * [GsaSimpleAttributeToExport](#model-GsaSimpleAttributeToExport)", - "discriminator": { - "propertyName": "attributeType", - "mapping": { - "link": "#/components/schemas/GsaLinkAttributeToExport", - "simple": "#/components/schemas/GsaSimpleAttributeToExport" - } - } - }, - "GsaAttributeType": { - "enum": [ - "integer", - "point", - "range", - "logical", - "shortText", - "longText", - "dateTime", - "discrete", - "hyperlink", - "file", - "picture", - "link", - "floatFunctional", - "discreteFunctional", - "mathsFunctional", - "tabular" - ], - "type": "string", - "description": "The types of attribute that are supported by the API.

Possible values:

\r\n
    \r\n
  • integer: Integer
    • \r\n
  • point: Point
    • \r\n
  • range: Range
    • \r\n
  • logical: Logical
    • \r\n
  • shortText: Short Text
    • \r\n
  • longText: Long Text
    • \r\n
  • dateTime: Date and Time
    • \r\n
  • discrete: Discrete Value
    • \r\n
  • hyperlink: Hyperlink
    • \r\n
  • file: File
    • \r\n
  • picture: Picture
    • \r\n
  • link: Link
    • \r\n
  • floatFunctional: Float functional
    • \r\n
  • discreteFunctional: Discrete functional
    • \r\n
  • mathsFunctional: Maths functional. Also known as Embedded Equations and Logic (EEL).
    • \r\n
  • tabular: Tabular data
    • \r\n
\r\n" - }, - "GsaAttributeTypeAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object", - "properties": { - "newAttributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "existingAttributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - } - } - } - ], - "additionalProperties": false, - "description": "When updating an existing attribute, attribute type must match.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeType'", - "x-discriminator-value": "attributeType", - "x-discriminator-name": "reason" - }, - "GsaAttributeTypeNotSupportedSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "attributeGuid", - "attributeType" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - } - } - } - ], - "additionalProperties": false, - "description": "Attribute type is not supported in smart link group attribute pairs.\r\nAttribute types supported in attribute pairs: discrete, dateTime, integer, logical, shortText.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeTypeNotSupported'", - "x-discriminator-value": "attributeTypeNotSupported", - "x-discriminator-name": "reason" - }, - "GsaAttributeUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "isMetaAttribute": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAttributeUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimAttribute" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "referencedByType" - }, - "GsaAttributeValidateResponse": { - "type": "object", - "properties": { - "isValid": { - "type": "boolean", - "description": "Gets whether the provided value was valid based on the attributes data rules." - }, - "hasValidationRules": { - "type": "boolean", - "description": "Gets whether the attribute has any validation rules that were checked." - }, - "valueChanged": { - "type": "boolean", - "description": "Gets whether the provided value was a new value compared to the existing value. Null if no record was provided.", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAttributeValueAggregation": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeAggregation" - }, - { - "type": "object", - "properties": { - "aggregationDatum": { - "$ref": "#/components/schemas/GsaAggregationDatum" - } - } - } - ], - "additionalProperties": false, - "description": "The results of aggregation over an attribute, reporting the number of records that have a value for\r\nthe attribute, plus additional aggregation information about the attribute values. The exact type of\r\nadditional information will depend on the type of attribute.\r\n\r\naggregationDatum: The type of datum associated with this attribute. (Note: a tabular attribute will be listed as type 'link'.)\r\n\r\nThis extends: [GsaAttributeAggregation](#model-GsaAttributeAggregation)\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'value'", - "x-discriminator-value": "value", - "x-discriminator-name": "attributeAggregationType" - }, - "GsaAttributesInfo": { - "required": [ - "attributes" - ], - "type": "object", - "properties": { - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimAttribute" - } - } - }, - "additionalProperties": false - }, - "GsaAxisName": { - "required": [ - "displayNames", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - } - } - }, - "additionalProperties": false - }, - "GsaBlobInfoDto": { - "required": [ - "fullPath", - "lastWriteTimeUtc", - "length", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the blob." - }, - "fullPath": { - "type": "string", - "description": "Full path of the blob.\r\nPath segments are separated by '/'\r\nThe last segment is always blob name." - }, - "length": { - "type": "integer", - "description": "Blob size in bytes.", - "format": "int64" - }, - "lastWriteTimeUtc": { - "type": "string", - "description": "Last modification date.", - "format": "date-time" - } - }, - "additionalProperties": false - }, - "GsaBooleanCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCriterion" - }, - { - "type": "object", - "properties": { - "all": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCriterion" - }, - "description": "Only records that match all of these criteria are returned.", - "nullable": true - }, - "any": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCriterion" - }, - "description": "Only results that match any of these criteria are returned.", - "nullable": true - }, - "none": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCriterion" - }, - "description": "Only results that match none of these criteria are returned.", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "boolean: Criterion that wraps other criteria in order to specify how the results should be joined together.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'boolean'", - "x-discriminator-value": "boolean", - "x-discriminator-name": "type" - }, - "GsaBoostByGuid": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "boostFactor": { - "type": "number", - "format": "double" - } - }, - "additionalProperties": false - }, - "GsaBoostByIdentity": { - "type": "object", - "properties": { - "identity": { - "type": "integer", - "format": "int32" - }, - "boostFactor": { - "type": "number", - "format": "double" - } - }, - "additionalProperties": false - }, - "GsaBracketMismatchUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'bracketMismatch'", - "x-discriminator-value": "bracketMismatch", - "x-discriminator-name": "reason" - }, - "GsaBreadcrumb": { - "required": [ - "breadcrumbType" - ], - "type": "object", - "properties": { - "breadcrumbType": { - "$ref": "#/components/schemas/GsaBreadcrumbType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaResolvedBreadcrumb](#model-GsaResolvedBreadcrumb)\r\n * [GsaUnresolvedBreadcrumb](#model-GsaUnresolvedBreadcrumb)", - "discriminator": { - "propertyName": "breadcrumbType", - "mapping": { - "resolved": "#/components/schemas/GsaResolvedBreadcrumb", - "unresolved": "#/components/schemas/GsaUnresolvedBreadcrumb" - } - } - }, - "GsaBreadcrumbType": { - "enum": [ - "resolved", - "unresolved" - ], - "type": "string" - }, - "GsaBreadcrumbsProperty": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaProperty" - }, - { - "required": [ - "breadcrumbs" - ], - "type": "object", - "properties": { - "breadcrumbs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBreadcrumb" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'breadcrumbs'", - "x-discriminator-value": "breadcrumbs", - "x-discriminator-name": "propertyName" - }, - "GsaBulkInfo": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBulkResponseItem" - } - } - }, - "additionalProperties": false - }, - "GsaBulkRequest": { - "required": [ - "requests" - ], - "type": "object", - "properties": { - "requests": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBulkRequestItem" - } - } - }, - "additionalProperties": false - }, - "GsaBulkRequestHttpMethod": { - "enum": [ - "GET", - "POST", - "DELETE", - "PATCH", - "PUT" - ], - "type": "string" - }, - "GsaBulkRequestItem": { - "required": [ - "method", - "path" - ], - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The relative path for this request." - }, - "method": { - "$ref": "#/components/schemas/GsaBulkRequestHttpMethod" - }, - "body": { - "type": "object", - "description": "The request body. The type of this object depends on the request being sent.\r\nIt should be the same as if this request were being sent separately.", - "nullable": true - }, - "headers": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Any additional headers to set on this request. Headers from the bulk request will also be included.\r\nHeaders set in this field override any headers also set on the bulk request.", - "nullable": true - }, - "query": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Query string parameters.", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaBulkResponseItem": { - "required": [ - "status" - ], - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/SystemNetHttpStatusCode" - }, - "body": { - "type": "object", - "description": "The response body. The type of this object depends on the request being sent.\r\nIt should be the same as if the request were sent separately.", - "nullable": true - }, - "headers": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaCalendarInterval": { - "enum": [ - "minute", - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • minute: Minute
    • \r\n
  • hour: Hour
    • \r\n
  • day: Day
    • \r\n
  • week: Week
    • \r\n
  • month: Month
    • \r\n
  • quarter: Quarter
    • \r\n
  • year: Year
    • \r\n
\r\n" - }, - "GsaCannotChangeDiscreteTypeAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object", - "properties": { - "columnGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Cannot change the Discrete Type of a Tabular Column.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'cannotChangeDiscreteType'", - "x-discriminator-value": "cannotChangeDiscreteType", - "x-discriminator-name": "reason" - }, - "GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Unavailable Tabular Columns cannot be created.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'cannotCreateUnavailableTabularColumn'", - "x-discriminator-value": "cannotCreateUnavailableTabularColumn", - "x-discriminator-name": "reason" - }, - "GsaCannotDeleteTabularColumnAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object", - "properties": { - "columnGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Cannot delete a Tabular Column that has local data and is part of a version-controlled Table.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'cannotDeleteTabularColumn'", - "x-discriminator-value": "cannotDeleteTabularColumn", - "x-discriminator-name": "reason" - }, - "GsaCannotRemoveParameterInUseAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object", - "properties": { - "parameterGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Cannot remove a Parameter that is used in data.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'cannotRemoveParameterInUse'", - "x-discriminator-value": "cannotRemoveParameterInUse", - "x-discriminator-name": "reason" - }, - "GsaCategoryReplacePermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The category is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'category'", - "x-discriminator-value": "category", - "x-discriminator-name": "reason" - }, - "GsaChartData": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaChartDataType" - }, - "recordVersionGuid": { - "type": "string", - "description": "The record version associated with this chart data.", - "format": "uuid" - }, - "bubbleAxisValue": { - "$ref": "#/components/schemas/GsaDataExportRange" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nbubbleAxisValue: The numeric range to for plotting on a bubble chart.\r\n\r\nThis is one of: \r\n * [GsaPointChartData](#model-GsaPointChartData)\r\n * [GsaIntegerChartData](#model-GsaIntegerChartData)\r\n * [GsaRangeChartData](#model-GsaRangeChartData)\r\n * [GsaLogicalChartData](#model-GsaLogicalChartData)\r\n * [GsaDiscreteChartData](#model-GsaDiscreteChartData)", - "discriminator": { - "propertyName": "type", - "mapping": { - "point": "#/components/schemas/GsaPointChartData", - "integer": "#/components/schemas/GsaIntegerChartData", - "range": "#/components/schemas/GsaRangeChartData", - "logical": "#/components/schemas/GsaLogicalChartData", - "discrete": "#/components/schemas/GsaDiscreteChartData" - } - } - }, - "GsaChartDataType": { - "enum": [ - "integer", - "point", - "range", - "logical", - "discrete" - ], - "type": "string", - "description": "The types of chart data that are supported by the API.

Possible values:

\r\n
    \r\n
  • integer: Integer
    • \r\n
  • point: Point
    • \r\n
  • range: Range
    • \r\n
  • logical: Logical
    • \r\n
  • discrete: Discrete Value
    • \r\n
\r\n" - }, - "GsaCircularReferenceFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Circular reference found - you cannot move a folder to be a child of one of its descendants.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'circularReference'", - "x-discriminator-value": "circularReference", - "x-discriminator-name": "reason" - }, - "GsaCodeMissingCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Currency must have a code.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'codeMissing'", - "x-discriminator-value": "codeMissing", - "x-discriminator-name": "reason" - }, - "GsaCodeWhitespaceCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object", - "properties": { - "currencyCode": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Currency code must not contain leading or trailing whitespace.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'codeWhitespace'", - "x-discriminator-value": "codeWhitespace", - "x-discriminator-name": "reason" - }, - "GsaConfigInvalidJsonFileErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Configuration's value must be valid JSON.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'configInvalidJson'", - "x-discriminator-value": "configInvalidJson", - "x-discriminator-name": "reason" - }, - "GsaConfiguration": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "value": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaConfigurationDetails": { - "required": [ - "connectionDetails", - "language" - ], - "type": "object", - "properties": { - "language": { - "type": "string" - }, - "connectionDetails": { - "$ref": "#/components/schemas/GsaConnectionDetails" - } - }, - "additionalProperties": false - }, - "GsaConfigurationsInfo": { - "required": [ - "configurations" - ], - "type": "object", - "properties": { - "configurations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimConfiguration" - } - } - }, - "additionalProperties": false - }, - "GsaConnectionDetails": { - "required": [ - "dataSource", - "initialCatalog" - ], - "type": "object", - "properties": { - "dataSource": { - "type": "string", - "description": "The SQL server data source" - }, - "initialCatalog": { - "type": "string", - "description": "The name of the database in SQL server" - }, - "useConfigurationDatabaseCredentials": { - "type": "boolean", - "description": "Set to true if the SQL connection is using the credentials from the Configuration database." - }, - "useIntegratedSecurity": { - "type": "boolean", - "description": "Set to true if the SQL connection to the database is using Windows authentication" - }, - "sqlUsername": { - "type": "string", - "description": "The username used if the database is using SQL authentication.", - "nullable": true - }, - "additionalSqlParameters": { - "type": "string", - "description": "(Optional) Any additional parameters added to the SQL connection string for the database.", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaConstant": { - "required": [ - "guid", - "name", - "value" - ], - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" - }, - "value": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Constant used in equations" - }, - "GsaConstantCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaConstantErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaConstantDeletionException": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDeletionException" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'constant'", - "x-discriminator-value": "constant", - "x-discriminator-name": "entityType" - }, - "GsaConstantErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaConstantErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityConstantErrorDetail](#model-GsaNamedEntityConstantErrorDetail)\r\n * [GsaNoSuchUnitConstantErrorDetail](#model-GsaNoSuchUnitConstantErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityConstantErrorDetail", - "noSuchUnit": "#/components/schemas/GsaNoSuchUnitConstantErrorDetail" - } - } - }, - "GsaConstantErrorReason": { - "enum": [ - "namedEntity", - "noSuchUnit" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noSuchUnit: Could not find the unit with the given GUID.
    • \r\n
\r\n" - }, - "GsaConstantUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "constantGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaConstantErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaConstantUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'constant'", - "x-discriminator-value": "constant", - "x-discriminator-name": "referencedByType" - }, - "GsaConstantsInfo": { - "type": "object", - "properties": { - "constants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaConstant" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaContinuousQualitySystem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaQualitySystem" - }, - { - "required": [ - "doesQualityDecreaseWithValue", - "thresholdValue" - ], - "type": "object", - "properties": { - "doesQualityDecreaseWithValue": { - "type": "boolean" - }, - "thresholdValue": { - "type": "number", - "format": "double" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystem](#model-GsaQualitySystem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'continuous'", - "x-discriminator-value": "continuous", - "x-discriminator-name": "type" - }, - "GsaContinuousRange": { - "type": "object", - "properties": { - "lowValue": { - "type": "number", - "format": "double", - "nullable": true - }, - "highValue": { - "type": "number", - "format": "double", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaCopyRecordHistory": { - "required": [ - "subsetOption" - ], - "type": "object", - "properties": { - "newParent": { - "$ref": "#/components/schemas/GsaSlimRecordHistory" - }, - "subsetOption": { - "$ref": "#/components/schemas/GsaRecordPropertyInheritanceType" - }, - "newShortName": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaCreateAccessControlCategory": { - "required": [ - "discreteType", - "name" - ], - "type": "object", - "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategoryTableMapping" - }, - "description": "Optionally maps an attribute, and values applied to the table, for each table.\r\nThere can be at most one entry for each table.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateAccessControlCategoryTableMapping": { - "required": [ - "attribute", - "table" - ], - "type": "object", - "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "description": "The discrete values applied to the table for this mapping.\r\nIf omitted or set to null or an empty array, table discrete values will be set to empty.", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaCreateAttribute": { - "required": [ - "name", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "helpPath": { - "type": "string", - "nullable": true - }, - "isHiddenFromSearchCriteria": { - "type": "boolean", - "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches.\r\nIf not specified, it will be set to the default value for the attribute type.", - "nullable": true - }, - "metaAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Set a display name for different languages.\r\nSupported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\".", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePointAttribute](#model-GsaCreatePointAttribute)\r\n * [GsaCreateIntegerAttribute](#model-GsaCreateIntegerAttribute)\r\n * [GsaCreateRangeAttribute](#model-GsaCreateRangeAttribute)\r\n * [GsaCreateLogicalAttribute](#model-GsaCreateLogicalAttribute)\r\n * [GsaCreateShortTextAttribute](#model-GsaCreateShortTextAttribute)\r\n * [GsaCreateLongTextAttribute](#model-GsaCreateLongTextAttribute)\r\n * [GsaCreateDateTimeAttribute](#model-GsaCreateDateTimeAttribute)\r\n * [GsaCreateDiscreteAttribute](#model-GsaCreateDiscreteAttribute)\r\n * [GsaCreateHyperlinkAttribute](#model-GsaCreateHyperlinkAttribute)\r\n * [GsaCreateFileAttribute](#model-GsaCreateFileAttribute)\r\n * [GsaCreatePictureAttribute](#model-GsaCreatePictureAttribute)\r\n * [GsaCreateTabularAttribute](#model-GsaCreateTabularAttribute)\r\n * [GsaCreateFloatFunctionalAttribute](#model-GsaCreateFloatFunctionalAttribute)\r\n * [GsaCreateDiscreteFunctionalAttribute](#model-GsaCreateDiscreteFunctionalAttribute)\r\n * [GsaCreateMathsFunctionalAttribute](#model-GsaCreateMathsFunctionalAttribute)", - "discriminator": { - "propertyName": "type", - "mapping": { - "point": "#/components/schemas/GsaCreatePointAttribute", - "integer": "#/components/schemas/GsaCreateIntegerAttribute", - "range": "#/components/schemas/GsaCreateRangeAttribute", - "logical": "#/components/schemas/GsaCreateLogicalAttribute", - "shortText": "#/components/schemas/GsaCreateShortTextAttribute", - "longText": "#/components/schemas/GsaCreateLongTextAttribute", - "dateTime": "#/components/schemas/GsaCreateDateTimeAttribute", - "discrete": "#/components/schemas/GsaCreateDiscreteAttribute", - "hyperlink": "#/components/schemas/GsaCreateHyperlinkAttribute", - "file": "#/components/schemas/GsaCreateFileAttribute", - "picture": "#/components/schemas/GsaCreatePictureAttribute", - "link": "#/components/schemas/GsaCreateTabularAttribute", - "floatFunctional": "#/components/schemas/GsaCreateFloatFunctionalAttribute", - "discreteFunctional": "#/components/schemas/GsaCreateDiscreteFunctionalAttribute", - "mathsFunctional": "#/components/schemas/GsaCreateMathsFunctionalAttribute" - } - } - }, - "GsaCreateAttributeLinkPair": { - "required": [ - "attributeSourceGuid", - "attributeTargetGuid" - ], - "type": "object", - "properties": { - "attributeSourceGuid": { - "type": "string", - "format": "uuid" - }, - "attributeTargetGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Attribute types supported in attribute pairs: discrete, dateTime, integer, logical, shortText." - }, - "GsaCreateAxisName": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - } - }, - "additionalProperties": false - }, - "GsaCreateConfiguration": { - "required": [ - "name", - "value" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "value": { - "type": "string" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateConstant": { - "required": [ - "name", - "value" - ], - "type": "object", - "properties": { - "unitGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "value": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateContinuousQualitySystem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateQualitySystem" - }, - { - "required": [ - "thresholdValue" - ], - "type": "object", - "properties": { - "doesQualityDecreaseWithValue": { - "type": "boolean" - }, - "thresholdValue": { - "type": "number", - "format": "double" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateQualitySystem](#model-GsaCreateQualitySystem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'continuous'", - "x-discriminator-value": "continuous", - "x-discriminator-name": "type" - }, - "GsaCreateContinuousRange": { - "required": [ - "highValue", - "lowValue" - ], - "type": "object", - "properties": { - "lowValue": { - "type": "number", - "format": "double" - }, - "highValue": { - "type": "number", - "format": "double" - } - }, - "additionalProperties": false - }, - "GsaCreateCrossDatabaseLinkTarget": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "databaseGuid": { - "type": "string", - "description": "If databaseGuid is set, the target will match any database with that Guid.\r\nIf databaseGuid is not set, the target wil match the tableGuid in any database.", - "format": "uuid", - "nullable": true - }, - "tableGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateCrossDatabaseRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - { - "required": [ - "linkTarget" - ], - "type": "object", - "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaCreateCrossDatabaseLinkTarget" - }, - "includeIndirectLinks": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateRecordLinkGroup](#model-GsaCreateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", - "x-discriminator-value": "crossDatabase", - "x-discriminator-name": "type" - }, - "GsaCreateDataRule": { - "required": [ - "description", - "name", - "regularExpression" - ], - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "regularExpression": { - "type": "string" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateDataUpdateServerApiRequest": { - "required": [ - "name", - "project" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "project": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "additionalProperties": false - }, - "GsaCreateDateTimeAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "required": [ - "discreteType" - ], - "type": "object", - "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "isMultiValued": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteFunctionalAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "required": [ - "attributeParameters", - "discreteType" - ], - "type": "object", - "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attributeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeParameter" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", - "x-discriminator-value": "discreteFunctional", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteFunctionalAttributeDiscreteParameter": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeParameter" - }, - { - "type": "object", - "properties": { - "defaultValue": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaCreateDiscreteFunctionalAttributeParameter](#model-GsaCreateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteFunctionalAttributeNumericParameter": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeParameter" - }, - { - "type": "object", - "properties": { - "defaultValue": { - "type": "number", - "description": "If there is no default value, fallback to the parameter default.", - "format": "double", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateDiscreteFunctionalAttributeParameter](#model-GsaCreateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteFunctionalAttributeParameter": { - "required": [ - "parameter", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "parameter": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteFunctionalAttributeDiscreteParameter](#model-GsaCreateDiscreteFunctionalAttributeDiscreteParameter)\r\n * [GsaCreateDiscreteFunctionalAttributeNumericParameter](#model-GsaCreateDiscreteFunctionalAttributeNumericParameter)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeDiscreteParameter", - "numeric": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeNumericParameter" - } - } - }, - "GsaCreateDiscreteParameter": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateParameter" - }, - { - "required": [ - "values" - ], - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateDiscreteParameterValue" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameter](#model-GsaCreateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteParameterContent": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateParameterContent" - }, - { - "type": "object", - "properties": { - "parameterValue": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "parameterRange": { - "$ref": "#/components/schemas/GsaCreateDiscreteRange" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterContent](#model-GsaCreateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteParameterValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterValue](#model-GsaCreateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteQualitySystem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateQualitySystem" - }, - { - "required": [ - "qualityDiscreteValues" - ], - "type": "object", - "properties": { - "thresholdValueName": { - "type": "string", - "nullable": true - }, - "qualityDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateQualityDiscreteValue" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateQualitySystem](#model-GsaCreateQualitySystem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaCreateDiscreteRange": { - "required": [ - "parameterValues" - ], - "type": "object", - "properties": { - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - }, - "additionalProperties": false - }, - "GsaCreateDiscreteType": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "isOrdered": { - "type": "boolean" - }, - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" - }, - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateExpression": { - "required": [ - "name", - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateFileAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", - "x-discriminator-value": "file", - "x-discriminator-name": "type" - }, - "GsaCreateFloatFunctionalAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "required": [ - "attributeParameters" - ], - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "axisName": { - "$ref": "#/components/schemas/GsaCreateAxisName" - }, - "attributeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter" - } - }, - "isRange": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", - "x-discriminator-value": "floatFunctional", - "x-discriminator-name": "type" - }, - "GsaCreateFloatFunctionalAttributeDiscreteParameter": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter" - }, - { - "type": "object", - "properties": { - "defaultValue": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaCreateFloatFunctionalAttributeParameter](#model-GsaCreateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaCreateFloatFunctionalAttributeNumericParameter": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter" - }, - { - "type": "object", - "properties": { - "defaultValue": { - "type": "number", - "description": "If there is no default value, fallback to the parameter default.", - "format": "double", - "nullable": true - }, - "interpolationMethod": { - "$ref": "#/components/schemas/GsaAttributeInterpolationMethod" - }, - "scaleType": { - "$ref": "#/components/schemas/GsaAttributeScaleType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: [GsaCreateFloatFunctionalAttributeParameter](#model-GsaCreateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" - }, - "GsaCreateFloatFunctionalAttributeParameter": { - "required": [ - "parameter", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "parameter": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateFloatFunctionalAttributeDiscreteParameter](#model-GsaCreateFloatFunctionalAttributeDiscreteParameter)\r\n * [GsaCreateFloatFunctionalAttributeNumericParameter](#model-GsaCreateFloatFunctionalAttributeNumericParameter)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaCreateFloatFunctionalAttributeDiscreteParameter", - "numeric": "#/components/schemas/GsaCreateFloatFunctionalAttributeNumericParameter" - } - } - }, - "GsaCreateFolder": { - "required": [ - "name", - "parentGuid" - ], - "type": "object", - "properties": { - "parentGuid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateHyperlinkAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", - "x-discriminator-value": "hyperlink", - "x-discriminator-name": "type" - }, - "GsaCreateIntegerAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object", - "properties": { - "isUnique": { - "type": "boolean", - "description": "Whether or not the attribute is constrained to contain a unique value" - }, - "axisName": { - "$ref": "#/components/schemas/GsaCreateAxisName" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "type" - }, - "GsaCreateJobRequest": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "culture": { - "type": "string", - "nullable": true - }, - "type": { - "type": "string", - "nullable": true - }, - "version": { - "type": "integer", - "format": "int32" - }, - "scheduledExecutionDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "inputFileIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Names of temporary input files that were uploaded prior to creating this job.", - "nullable": true - }, - "parameters": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaCreateLayout": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "applicableApplications": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If there are no ApplicableApplications, the layout is applicable in all applications.", - "nullable": true - }, - "sections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" - }, - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Create dto for Layouts" - }, - "GsaCreateLayoutSection": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "sectionItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutItem" - }, - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Create dto for Layout Sections" - }, - "GsaCreateLinkedAttributeTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "required": [ - "linkedAttribute" - ], - "type": "object", - "properties": { - "linkedAttribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", - "x-discriminator-value": "linkedAttribute", - "x-discriminator-name": "columnType" - }, - "GsaCreateLinkedColumnTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "required": [ - "linkedColumn" - ], - "type": "object", - "properties": { - "linkedColumn": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", - "x-discriminator-value": "linkedColumn", - "x-discriminator-name": "columnType" - }, - "GsaCreateLinkedRecordTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", - "x-discriminator-value": "linkedRecord", - "x-discriminator-name": "columnType" - }, - "GsaCreateListItem": { - "required": [ - "databaseGuid", - "recordHistoryGuid" - ], - "type": "object", - "properties": { - "databaseGuid": { - "type": "string", - "format": "uuid" - }, - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "recordVersion": { - "type": "integer", - "description": "Optional record version. Note that versioned items should not be used in lists used in the Favorites App, which considers all items to be versionless.", - "format": "int32", - "nullable": true - }, - "tableGuid": { - "type": "string", - "description": "Optional table GUID. If the item exists in a loaded database, the GUID will be calculated if not provided.", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaCreateLocalDateTimeTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", - "x-discriminator-value": "localDateTime", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalDiscreteTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "required": [ - "discreteType" - ], - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "discreteType": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", - "x-discriminator-value": "localDiscrete", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalFileTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", - "x-discriminator-value": "localFile", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalHyperlinkTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", - "x-discriminator-value": "localHyperlink", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalIntegerTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", - "x-discriminator-value": "localInteger", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalLogicalTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", - "x-discriminator-value": "localLogical", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalLongTextTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", - "x-discriminator-value": "localLongText", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalPictureTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", - "x-discriminator-value": "localPicture", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalPointTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", - "x-discriminator-value": "localPoint", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalRangeTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", - "x-discriminator-value": "localRange", - "x-discriminator-name": "columnType" - }, - "GsaCreateLocalShortTextTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - { - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", - "x-discriminator-value": "localShortText", - "x-discriminator-name": "columnType" - }, - "GsaCreateLogicalAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", - "x-discriminator-value": "logical", - "x-discriminator-name": "type" - }, - "GsaCreateLongTextAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", - "x-discriminator-value": "longText", - "x-discriminator-name": "type" - }, - "GsaCreateMathsContent": { - "type": "object", - "properties": { - "curveLabel": { - "type": "string", - "nullable": true - }, - "transposeAxes": { - "type": "boolean" - }, - "useLogarithmicScale": { - "type": "boolean" - }, - "expression": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "freeParameter": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "parameterContents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateParameterContent" - } - } - }, - "additionalProperties": false, - "description": "\r\n\r\nexpression: Defaults to the first expression on the attribute, if there are any.\r\n\r\nfreeParameter: Defaults to the first parameter on the attribute, if there are any." - }, - "GsaCreateMathsFunctionalAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attributeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "expressions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "allowExtrapolation": { - "type": "boolean" - }, - "axisName": { - "$ref": "#/components/schemas/GsaCreateAxisName" - }, - "isRange": { - "type": "boolean" - }, - "defaultContent": { - "$ref": "#/components/schemas/GsaCreateMathsContent" - }, - "allowAllCompatibleExpressions": { - "type": "boolean" - }, - "allowAnonymousExpressions": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", - "x-discriminator-value": "mathsFunctional", - "x-discriminator-name": "type" - }, - "GsaCreateNumericParameter": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateParameter" - }, - { - "required": [ - "interpolationType", - "isRestricted", - "scaleType", - "values" - ], - "type": "object", - "properties": { - "isRestricted": { - "type": "boolean" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateNumericParameterValue" - }, - "description": "Numeric parameter values cannot be ordered - they are ordered by numeric value." - }, - "interpolationType": { - "$ref": "#/components/schemas/GsaParameterInterpolationType" - }, - "scaleType": { - "$ref": "#/components/schemas/GsaParameterScaleType" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameter](#model-GsaCreateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" - }, - "GsaCreateNumericParameterContent": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateParameterContent" - }, - { - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double", - "nullable": true - }, - "parameterRange": { - "$ref": "#/components/schemas/GsaCreateContinuousRange" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterContent](#model-GsaCreateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" - }, - "GsaCreateNumericParameterValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - { - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterValue](#model-GsaCreateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" - }, - "GsaCreateParameter": { - "required": [ - "defaultParameterValueIndex", - "name", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "defaultParameterValueIndex": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteParameter](#model-GsaCreateDiscreteParameter)\r\n * [GsaCreateNumericParameter](#model-GsaCreateNumericParameter)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaCreateDiscreteParameter", - "numeric": "#/components/schemas/GsaCreateNumericParameter" - } - } - }, - "GsaCreateParameterContent": { - "required": [ - "parameter", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "parameter": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false, - "description": "Set the range and/or default value for parameters used by the attribute.\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteParameterContent](#model-GsaCreateDiscreteParameterContent)\r\n * [GsaCreateNumericParameterContent](#model-GsaCreateNumericParameterContent)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaCreateDiscreteParameterContent", - "numeric": "#/components/schemas/GsaCreateNumericParameterContent" - } - } - }, - "GsaCreateParameterValue": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaParameterValueType" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteParameterValue](#model-GsaCreateDiscreteParameterValue)\r\n * [GsaCreateNumericParameterValue](#model-GsaCreateNumericParameterValue)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaCreateDiscreteParameterValue", - "numeric": "#/components/schemas/GsaCreateNumericParameterValue" - } - } - }, - "GsaCreatePermission": { - "required": [ - "name", - "role" - ], - "type": "object", - "properties": { - "role": { - "type": "string" - }, - "description": { - "type": "string", - "description": "The description of the permission.", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreatePermissionCategory": { - "required": [ - "name", - "permissions" - ], - "type": "object", - "properties": { - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreatePermission" - } - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreatePictureAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", - "x-discriminator-value": "picture", - "x-discriminator-name": "type" - }, - "GsaCreatePointAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object", - "properties": { - "isMultiValued": { - "type": "boolean" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "axisName": { - "$ref": "#/components/schemas/GsaCreateAxisName" - }, - "attributeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", - "x-discriminator-value": "point", - "x-discriminator-name": "type" - }, - "GsaCreateProfile": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "homepageUrl": { - "type": "string", - "nullable": true - }, - "groupName": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateProfileTable": { - "required": [ - "databaseGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "databaseGuid": { - "type": "string", - "format": "uuid" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "subsetGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "layoutGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreatePutDiscreteValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutDiscreteValue" - }, - { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutDiscreteValue](#model-GsaPutDiscreteValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'create'", - "x-discriminator-value": "create", - "x-discriminator-name": "type" - }, - "GsaCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutLayoutItem" - }, - { - "required": [ - "itemType" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaNewLayoutItemType" - } - }, - "discriminator": { - "propertyName": "itemType", - "mapping": { - "attribute": "#/components/schemas/GsaAttributeCreatePutLayoutItem", - "recordLink": "#/components/schemas/GsaRecordLinkCreatePutLayoutItem", - "smartLink": "#/components/schemas/GsaSmartLinkCreatePutLayoutItem", - "crossDatabaseLink": "#/components/schemas/GsaCrossDatabaseLinkCreatePutLayoutItem", - "associationChain": "#/components/schemas/GsaAssociationChainCreatePutLayoutItem" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutLayoutItem](#model-GsaPutLayoutItem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'create'\r\n\r\nThis is one of: \r\n * [GsaAttributeCreatePutLayoutItem](#model-GsaAttributeCreatePutLayoutItem)\r\n * [GsaRecordLinkCreatePutLayoutItem](#model-GsaRecordLinkCreatePutLayoutItem)\r\n * [GsaSmartLinkCreatePutLayoutItem](#model-GsaSmartLinkCreatePutLayoutItem)\r\n * [GsaCrossDatabaseLinkCreatePutLayoutItem](#model-GsaCrossDatabaseLinkCreatePutLayoutItem)\r\n * [GsaAssociationChainCreatePutLayoutItem](#model-GsaAssociationChainCreatePutLayoutItem)", - "x-discriminator-value": "create", - "x-discriminator-name": "type" - }, - "GsaCreatePutPermission": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermission" - }, - { - "required": [ - "name", - "role" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "role": { - "type": "string" - }, - "description": { - "type": "string", - "description": "The description of the permission.", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutPermission](#model-GsaPutPermission)\r\n\r\nThe value of discriminator property ('type') must be equal to 'create'", - "x-discriminator-value": "create", - "x-discriminator-name": "type" - }, - "GsaCreatePutPermissionCategory": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermissionCategory" - }, - { - "required": [ - "name", - "permissions" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreatePermission" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutPermissionCategory](#model-GsaPutPermissionCategory)\r\n\r\nThe value of discriminator property ('type') must be equal to 'create'", - "x-discriminator-value": "create", - "x-discriminator-name": "type" - }, - "GsaCreateQualityDiscreteValue": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Create dto for Quality Discrete Values" - }, - "GsaCreateQualitySystem": { - "required": [ - "name", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaQualitySystemType" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteQualitySystem](#model-GsaCreateDiscreteQualitySystem)\r\n * [GsaCreateContinuousQualitySystem](#model-GsaCreateContinuousQualitySystem)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaCreateDiscreteQualitySystem", - "continuous": "#/components/schemas/GsaCreateContinuousQualitySystem" - } - } - }, - "GsaCreateRangeAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "axisName": { - "$ref": "#/components/schemas/GsaCreateAxisName" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", - "x-discriminator-value": "range", - "x-discriminator-name": "type" - }, - "GsaCreateRecordHistory": { - "required": [ - "name", - "recordType" - ], - "type": "object", - "properties": { - "recordType": { - "$ref": "#/components/schemas/GsaRecordType" - }, - "name": { - "type": "string" - }, - "shortName": { - "type": "string", - "nullable": true - }, - "parent": { - "$ref": "#/components/schemas/GsaSlimRecordHistory" - }, - "recordColor": { - "$ref": "#/components/schemas/GsaRecordColor" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateRecordLinkGroup": { - "required": [ - "name", - "reverseName", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaRecordLinkGroupType" - }, - "reverseName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateStaticRecordLinkGroup](#model-GsaCreateStaticRecordLinkGroup)\r\n * [GsaCreateSmartRecordLinkGroup](#model-GsaCreateSmartRecordLinkGroup)\r\n * [GsaCreateCrossDatabaseRecordLinkGroup](#model-GsaCreateCrossDatabaseRecordLinkGroup)", - "discriminator": { - "propertyName": "type", - "mapping": { - "static": "#/components/schemas/GsaCreateStaticRecordLinkGroup", - "smart": "#/components/schemas/GsaCreateSmartRecordLinkGroup", - "crossDatabase": "#/components/schemas/GsaCreateCrossDatabaseRecordLinkGroup" - } - } - }, - "GsaCreateRecordList": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "items": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - }, - "identifier": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "notes": { - "type": "string", - "nullable": true - }, - "published": { - "type": "boolean" - }, - "awaitingApproval": { - "type": "boolean" - }, - "internalUse": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaCreateRecordListItemsInfo": { - "required": [ - "items" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateListItem" - } - } - }, - "additionalProperties": false - }, - "GsaCreateReplacementString": { - "required": [ - "name", - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateShortTextAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object", - "properties": { - "isUnique": { - "type": "boolean", - "description": "Whether or not the attribute is constrained to contain a unique value" - }, - "dataRule": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", - "x-discriminator-value": "shortText", - "x-discriminator-name": "type" - }, - "GsaCreateSmartLinkTarget": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateSmartRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - { - "required": [ - "attributePairs", - "linkTarget" - ], - "type": "object", - "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaCreateSmartLinkTarget" - }, - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" - }, - "description": "There must be at least one and not more than three attribute pairs." - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateRecordLinkGroup](#model-GsaCreateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "type" - }, - "GsaCreateStandardName": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "mappedAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "mappedParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "mappedStaticRecordLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateStaticRecordLinkGroupMapping" - }, - "nullable": true - }, - "mappedCrossDatabaseRecordLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateStaticLinkTarget": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateStaticRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - { - "required": [ - "linkTarget" - ], - "type": "object", - "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaCreateStaticLinkTarget" - }, - "includeIndirectLinks": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateRecordLinkGroup](#model-GsaCreateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", - "x-discriminator-value": "static", - "x-discriminator-name": "type" - }, - "GsaCreateStaticRecordLinkGroupMapping": { - "required": [ - "isReverse", - "staticRecordLinkGroup" - ], - "type": "object", - "properties": { - "staticRecordLinkGroup": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "isReverse": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaCreateSubset": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "associatedLayout": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateTable": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "isHiddenFromBrowse": { - "type": "boolean" - }, - "isHiddenFromSearch": { - "type": "boolean" - }, - "legalDisclaimer": { - "type": "string", - "nullable": true - }, - "datasheetHeader": { - "type": "string", - "nullable": true - }, - "datasheetFooter": { - "type": "string", - "nullable": true - }, - "tableTypes": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "shouldShowVersionControlSignatures": { - "type": "boolean" - }, - "qualitySystem": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateTabularAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - { - "type": "object", - "properties": { - "displayFullTable": { - "type": "boolean" - }, - "displaySummaryRowInline": { - "type": "boolean" - }, - "hideUnlinkedRows": { - "type": "boolean" - }, - "tabularColumns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateTabularColumn" - }, - "nullable": true - }, - "target": { - "$ref": "#/components/schemas/GsaTabularAttributeTarget" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "type" - }, - "GsaCreateTabularColumn": { - "required": [ - "columnType", - "name" - ], - "type": "object", - "properties": { - "columnType": { - "$ref": "#/components/schemas/GsaTabularColumnDtoType" - }, - "showAsLink": { - "type": "boolean" - }, - "summaryRowEnabled": { - "type": "boolean" - }, - "summaryRowText": { - "type": "string", - "nullable": true - }, - "rollUpType": { - "$ref": "#/components/schemas/GsaTabularColumnRollUpType" - }, - "summaryRowRollUpType": { - "$ref": "#/components/schemas/GsaTabularColumnRollUpType" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * [GsaCreateLinkedAttributeTabularColumn](#model-GsaCreateLinkedAttributeTabularColumn)\r\n * [GsaCreateLinkedColumnTabularColumn](#model-GsaCreateLinkedColumnTabularColumn)\r\n * [GsaCreateLinkedRecordTabularColumn](#model-GsaCreateLinkedRecordTabularColumn)\r\n * [GsaCreateLocalPointTabularColumn](#model-GsaCreateLocalPointTabularColumn)\r\n * [GsaCreateLocalRangeTabularColumn](#model-GsaCreateLocalRangeTabularColumn)\r\n * [GsaCreateLocalIntegerTabularColumn](#model-GsaCreateLocalIntegerTabularColumn)\r\n * [GsaCreateLocalLogicalTabularColumn](#model-GsaCreateLocalLogicalTabularColumn)\r\n * [GsaCreateLocalShortTextTabularColumn](#model-GsaCreateLocalShortTextTabularColumn)\r\n * [GsaCreateLocalLongTextTabularColumn](#model-GsaCreateLocalLongTextTabularColumn)\r\n * [GsaCreateLocalDateTimeTabularColumn](#model-GsaCreateLocalDateTimeTabularColumn)\r\n * [GsaCreateLocalDiscreteTabularColumn](#model-GsaCreateLocalDiscreteTabularColumn)\r\n * [GsaCreateLocalHyperlinkTabularColumn](#model-GsaCreateLocalHyperlinkTabularColumn)\r\n * [GsaCreateLocalFileTabularColumn](#model-GsaCreateLocalFileTabularColumn)\r\n * [GsaCreateLocalPictureTabularColumn](#model-GsaCreateLocalPictureTabularColumn)", - "discriminator": { - "propertyName": "columnType", - "mapping": { - "linkedAttribute": "#/components/schemas/GsaCreateLinkedAttributeTabularColumn", - "linkedColumn": "#/components/schemas/GsaCreateLinkedColumnTabularColumn", - "linkedRecord": "#/components/schemas/GsaCreateLinkedRecordTabularColumn", - "localPoint": "#/components/schemas/GsaCreateLocalPointTabularColumn", - "localRange": "#/components/schemas/GsaCreateLocalRangeTabularColumn", - "localInteger": "#/components/schemas/GsaCreateLocalIntegerTabularColumn", - "localLogical": "#/components/schemas/GsaCreateLocalLogicalTabularColumn", - "localShortText": "#/components/schemas/GsaCreateLocalShortTextTabularColumn", - "localLongText": "#/components/schemas/GsaCreateLocalLongTextTabularColumn", - "localDateTime": "#/components/schemas/GsaCreateLocalDateTimeTabularColumn", - "localDiscrete": "#/components/schemas/GsaCreateLocalDiscreteTabularColumn", - "localHyperlink": "#/components/schemas/GsaCreateLocalHyperlinkTabularColumn", - "localFile": "#/components/schemas/GsaCreateLocalFileTabularColumn", - "localPicture": "#/components/schemas/GsaCreateLocalPictureTabularColumn" - } - } - }, - "GsaCreateUnit": { - "required": [ - "name", - "symbol" - ], - "type": "object", - "properties": { - "symbol": { - "type": "string" - }, - "equation": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateUnitMapping": { - "required": [ - "equivalentUnit", - "unit" - ], - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "equivalentUnit": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false - }, - "GsaCreateUnitSystem": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "unitMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateUnitMapping" - }, - "description": "Unit mappings will default to each unit being mapped to itself but optionally one or more non-default mappings can be specified here.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Create dto for Unit Systems" - }, - "GsaCreatedByUserProperty": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaProperty" - }, - { - "type": "object", - "properties": { - "createdByUser": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdByUser'", - "x-discriminator-value": "createdByUser", - "x-discriminator-name": "propertyName" - }, - "GsaCreatedDateProperty": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaProperty" - }, - { - "type": "object", - "properties": { - "createdDate": { - "type": "string", - "format": "date-time" + "type": "text" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ], + "pagingOptions": { + "pageSize": 5, + "keepAliveInMinutes": 10, + "pageNumber": 1 + } + } + }, + "Example 28": { + "summary": "Float functional graph search", + "description": "A search on the float functional attribute 'Young's modulus with temperature' for records that have at least one series, use the Temperature parameter (00000001-000a-4fff-8fff-0000ffff0000) on the X-Axis and are not marked as 'Show as table'", + "value": { + "criterion": { + "innerCriterion": { + "xAxisParameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "numberOfSeriesGte": 1, + "showAsTable": false, + "type": "floatFunctionalGraph" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [ + { + "sortDirection": "ascending", + "type": "relevance" + } + ] + } + }, + "Example 29": { + "summary": "Float functional search by attribute value", + "description": "A search in MI_TRAINING on 'Young's modulus with temperature' for records that have a Young's Modulus of between 75 and 80 GPa at a temperature of 100°C", + "value": { + "criterion": { + "innerCriterion": { + "gte": 75.0, + "lte": 80.0, + "constraints": [ + { + "gte": 100.0, + "lte": 100.0, + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "type": "numeric" + } + ], + "type": "floatFunctionalData" + }, + "guid": "00000001-0001-4fff-8fff-dd92ffff0000", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + }, + "Example 30": { + "summary": "Discrete functional search", + "description": "A search in MI_TRAINING on 'Environmental Resistance' for records that have a resistance of 'Good' or 'Very good' in the Chemical Environment of 'Fresh Water'", + "value": { + "criterion": { + "innerCriterion": { + "anyGuids": [ + "00000032-0007-4fff-8fff-000cffff0000", + "00000033-0007-4fff-8fff-000cffff0000" + ], + "constraints": [ + { + "any": [ + "Fresh water" + ], + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "type": "discreteName" + } + ], + "type": "discreteFunctionalValues" + }, + "guid": "0cb16afc-c567-4e20-943c-9639b30fee62", + "isMetaAttribute": false, + "attributeCriterionType": "matches", + "type": "attribute" + }, + "sortCriteria": [] + } + } } } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdDate'", - "x-discriminator-value": "createdDate", - "x-discriminator-name": "propertyName" - }, - "GsaCriterion": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaCriterionType" - } }, - "additionalProperties": false, - "description": "The criterion to be used in a search.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\", \"all\", or \"none\" of the criterion.\r\nThese criterion can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * [GsaBooleanCriterion](#model-GsaBooleanCriterion)\r\n * [GsaFreeTextCriterion](#model-GsaFreeTextCriterion)\r\n * [GsaFreeTextPrefixCriterion](#model-GsaFreeTextPrefixCriterion)\r\n * [GsaRecordListMemberCriterion](#model-GsaRecordListMemberCriterion)\r\n * [GsaRecordPropertyCriterion](#model-GsaRecordPropertyCriterion)\r\n * [GsaRecordReferenceCriterion](#model-GsaRecordReferenceCriterion)\r\n * [GsaRecordAncestorCriterion](#model-GsaRecordAncestorCriterion)\r\n * [GsaRecordAncestorHistoryCriterion](#model-GsaRecordAncestorHistoryCriterion)\r\n * [GsaRecordSubsetCriterion](#model-GsaRecordSubsetCriterion)\r\n * [GsaTabularLinkingValueCriterion](#model-GsaTabularLinkingValueCriterion)\r\n * [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n * [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n * [GsaNamedCriterion](#model-GsaNamedCriterion)", - "discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#/components/schemas/GsaBooleanCriterion", - "text": "#/components/schemas/GsaFreeTextCriterion", - "textPrefix": "#/components/schemas/GsaFreeTextPrefixCriterion", - "recordListMember": "#/components/schemas/GsaRecordListMemberCriterion", - "recordProperty": "#/components/schemas/GsaRecordPropertyCriterion", - "reference": "#/components/schemas/GsaRecordReferenceCriterion", - "recordAncestor": "#/components/schemas/GsaRecordAncestorCriterion", - "recordAncestorHistory": "#/components/schemas/GsaRecordAncestorHistoryCriterion", - "subset": "#/components/schemas/GsaRecordSubsetCriterion", - "tabularLinkingValue": "#/components/schemas/GsaTabularLinkingValueCriterion", - "attribute": "#/components/schemas/GsaAttributeCriterion", - "localColumn": "#/components/schemas/GsaLocalColumnCriterion", - "namedCriterion": "#/components/schemas/GsaNamedCriterion" - } - } - }, - "GsaCriterionType": { - "enum": [ - "boolean", - "text", - "textPrefix", - "recordListMember", - "recordProperty", - "reference", - "recordAncestor", - "recordAncestorHistory", - "subset", - "tabularLinkingValue", - "attribute", - "localColumn", - "namedCriterion" - ], - "type": "string" - }, - "GsaCrossDatabaseLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" - }, - { - "required": [ - "includeIndirectLinks" - ], - "type": "object", - "properties": { - "includeIndirectLinks": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabaseLink'", - "x-discriminator-value": "crossDatabaseLink", - "x-discriminator-name": "type" - }, - "GsaCrossDatabaseLinkCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "linkGroupGuid", - "sourceDatabaseGuid", - "sourceTableGuid" - ], - "type": "object", - "properties": { - "sourceDatabaseGuid": { - "type": "string", - "format": "uuid" - }, - "sourceTableGuid": { - "type": "string", - "format": "uuid" - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'crossDatabaseLink'", - "x-discriminator-value": "crossDatabaseLink", - "x-discriminator-name": "itemType" - }, - "GsaCrossDatabaseRecordLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkBase" - }, - { - "type": "object", - "properties": { - "reverseNotes": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkBase](#model-GsaRecordLinkBase)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'crossDatabase'", - "x-discriminator-value": "crossDatabase", - "x-discriminator-name": "recordLinkGroupType" - }, - "GsaCrossDatabaseRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroup" - }, - { - "required": [ - "includeIndirectLinks" - ], - "type": "object", - "properties": { - "includeIndirectLinks": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkGroup](#model-GsaRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", - "x-discriminator-value": "crossDatabase", - "x-discriminator-name": "type" - }, - "GsaCrossDatabaseRecordLinkResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkResult" - }, - { - "required": [ - "linkedDatabaseKey" - ], - "type": "object", - "properties": { - "linkedDatabaseKey": { - "type": "string" + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } }, - "notes": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkResult](#model-GsaRecordLinkResult)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'crossDatabase'", - "x-discriminator-value": "crossDatabase", - "x-discriminator-name": "recordLinkGroupType" - }, - "GsaCurrenciesInfo": { - "required": [ - "currencies" - ], - "type": "object", - "properties": { - "currencies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCurrency" - } - } - }, - "additionalProperties": false - }, - "GsaCurrency": { - "required": [ - "code", - "factor", - "name" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The code of the currency." - }, - "name": { - "type": "string", - "description": "The unique name of the currency." - }, - "factor": { - "type": "number", - "description": "The conversion factor of the currency.", - "format": "double" - } - }, - "additionalProperties": false - }, - "GsaCurrencyErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaCurrencyErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNameMissingCurrencyErrorDetail](#model-GsaNameMissingCurrencyErrorDetail)\r\n * [GsaDuplicateNameCurrencyErrorDetail](#model-GsaDuplicateNameCurrencyErrorDetail)\r\n * [GsaNameWhitespaceCurrencyErrorDetail](#model-GsaNameWhitespaceCurrencyErrorDetail)\r\n * [GsaCodeMissingCurrencyErrorDetail](#model-GsaCodeMissingCurrencyErrorDetail)\r\n * [GsaDuplicateCodeCurrencyErrorDetail](#model-GsaDuplicateCodeCurrencyErrorDetail)\r\n * [GsaCodeWhitespaceCurrencyErrorDetail](#model-GsaCodeWhitespaceCurrencyErrorDetail)\r\n * [GsaTooLongCodeCurrencyErrorDetail](#model-GsaTooLongCodeCurrencyErrorDetail)\r\n * [GsaInvalidExchangeRateCurrencyErrorDetail](#model-GsaInvalidExchangeRateCurrencyErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "nameMissing": "#/components/schemas/GsaNameMissingCurrencyErrorDetail", - "duplicateName": "#/components/schemas/GsaDuplicateNameCurrencyErrorDetail", - "nameWhitespace": "#/components/schemas/GsaNameWhitespaceCurrencyErrorDetail", - "codeMissing": "#/components/schemas/GsaCodeMissingCurrencyErrorDetail", - "duplicateCode": "#/components/schemas/GsaDuplicateCodeCurrencyErrorDetail", - "codeWhitespace": "#/components/schemas/GsaCodeWhitespaceCurrencyErrorDetail", - "tooLongCode": "#/components/schemas/GsaTooLongCodeCurrencyErrorDetail", - "invalidExchangeRate": "#/components/schemas/GsaInvalidExchangeRateCurrencyErrorDetail" - } - } - }, - "GsaCurrencyErrorReason": { - "enum": [ - "nameMissing", - "duplicateName", - "nameWhitespace", - "codeMissing", - "duplicateCode", - "codeWhitespace", - "tooLongCode", - "invalidExchangeRate" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • nameMissing: The currency must have a name.
    • \r\n
  • duplicateName: The currency name is already in use.
    • \r\n
  • nameWhitespace: Currency name must not contain leading or trailing whitespace.
    • \r\n
  • codeMissing: The currency must have a code.
    • \r\n
  • duplicateCode: The currency code is already in use.
    • \r\n
  • codeWhitespace: Currency code must not contain leading or trailing whitespace.
    • \r\n
  • tooLongCode: Currency code cannot be longer than 3 characters.
    • \r\n
  • invalidExchangeRate: Currency conversion factor must be greater than zero.
    • \r\n
\r\n" - }, - "GsaCurrentUser": { - "type": "object", - "properties": { - "isAdmin": { - "type": "boolean" - }, - "username": { - "type": "string", - "nullable": true - }, - "hasWriteAccess": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaDataExportApplicableDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportDatum" - }, - { - "required": [ - "datumType" - ], - "type": "object", - "properties": { - "datumType": { - "$ref": "#/components/schemas/GsaAttributeType" - } - }, - "discriminator": { - "propertyName": "datumType", - "mapping": { - "logical": "#/components/schemas/GsaDataExportBooleanDatum", - "dateTime": "#/components/schemas/GsaDataExportDateTimeDatum", - "discrete": "#/components/schemas/GsaDataExportDiscreteDatum", - "file": "#/components/schemas/GsaDataExportFileDatum", - "floatFunctional": "#/components/schemas/GsaDataExportFloatFunctionalDatum", - "discreteFunctional": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum", - "hyperlink": "#/components/schemas/GsaDataExportHyperlinkDatum", - "link": "#/components/schemas/GsaDataExportLinkDatum", - "longText": "#/components/schemas/GsaDataExportLongTextDatum", - "integer": "#/components/schemas/GsaDataExportNumericDatum", - "picture": "#/components/schemas/GsaDataExportPictureDatum", - "point": "#/components/schemas/GsaDataExportPointDatum", - "range": "#/components/schemas/GsaDataExportRangeDatum", - "shortText": "#/components/schemas/GsaDataExportShortTextDatum" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDatum](#model-GsaDataExportDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * [GsaDataExportBooleanDatum](#model-GsaDataExportBooleanDatum)\r\n * [GsaDataExportDateTimeDatum](#model-GsaDataExportDateTimeDatum)\r\n * [GsaDataExportDiscreteDatum](#model-GsaDataExportDiscreteDatum)\r\n * [GsaDataExportFileDatum](#model-GsaDataExportFileDatum)\r\n * [GsaDataExportFloatFunctionalDatum](#model-GsaDataExportFloatFunctionalDatum)\r\n * [GsaDataExportDiscreteFunctionalDatum](#model-GsaDataExportDiscreteFunctionalDatum)\r\n * [GsaDataExportHyperlinkDatum](#model-GsaDataExportHyperlinkDatum)\r\n * [GsaDataExportLinkDatum](#model-GsaDataExportLinkDatum)\r\n * [GsaDataExportLongTextDatum](#model-GsaDataExportLongTextDatum)\r\n * [GsaDataExportNumericDatum](#model-GsaDataExportNumericDatum)\r\n * [GsaDataExportPictureDatum](#model-GsaDataExportPictureDatum)\r\n * [GsaDataExportPointDatum](#model-GsaDataExportPointDatum)\r\n * [GsaDataExportRangeDatum](#model-GsaDataExportRangeDatum)\r\n * [GsaDataExportShortTextDatum](#model-GsaDataExportShortTextDatum)", - "x-discriminator-value": "applicable", - "x-discriminator-name": "notApplicable" - }, - "GsaDataExportBinaryData": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "contentType": { - "type": "string", - "nullable": true - }, - "data": { - "type": "string", - "format": "byte", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDataExportBooleanDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "type": "object", - "properties": { - "datumValue": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", - "x-discriminator-value": "logical", - "x-discriminator-name": "datumType" - }, - "GsaDataExportCountRollupDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportRollupDatum" - }, - { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "A count of the number of populated values\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'countRollup'", - "x-discriminator-value": "countRollup", - "x-discriminator-name": "type" - }, - "GsaDataExportDateTimeDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "type": "object", - "properties": { - "datumValue": { - "type": "string", - "format": "date-time" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", - "x-discriminator-name": "datumType" - }, - "GsaDataExportDatum": { - "required": [ - "attributeGuid", - "attributeIdentity", - "notApplicable" - ], - "type": "object", - "properties": { - "attributeIdentity": { - "type": "integer", - "format": "int64" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "metaDatums": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportDatum" - }, - "nullable": true - }, - "notApplicable": { - "type": "string" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDataExportNotApplicableDatum](#model-GsaDataExportNotApplicableDatum)\r\n * [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n * [GsaDataExportUnknownDatum](#model-GsaDataExportUnknownDatum)", - "discriminator": { - "propertyName": "notApplicable", - "mapping": { - "notApplicable": "#/components/schemas/GsaDataExportNotApplicableDatum", - "applicable": "#/components/schemas/GsaDataExportApplicableDatum", - "unknown": "#/components/schemas/GsaDataExportUnknownDatum" - } - } - }, - "GsaDataExportDiscreteDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "type": "object", - "properties": { - "datumValue": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValue" - }, - "nullable": true + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } } } + }, + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" } + } + } + }, + "/v1alpha/searches/{searchIdentifier}/results": { + "post": { + "tags": [ + "Search" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "datumType" - }, - "GsaDataExportDiscreteFunctionalDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, + "summary": "Returns search results by identifier", + "operationId": "GetSearchResults", + "parameters": [ { - "required": [ - "graphType" - ], - "type": "object", - "properties": { - "graphType": { - "type": "string", - "nullable": true - }, - "xAxisParameter": { - "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" - }, - "nullable": true + "name": "searchIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResultsRequest" } }, - "discriminator": { - "propertyName": "graphType", - "mapping": { - "grid": "#/components/schemas/GsaDataExportDiscreteFunctionalGridDatum", - "series": "#/components/schemas/GsaDataExportDiscreteFunctionalSeriesDatum" + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResultsRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResultsRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResultsRequest" } } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * [GsaDataExportDiscreteFunctionalGridDatum](#model-GsaDataExportDiscreteFunctionalGridDatum)\r\n * [GsaDataExportDiscreteFunctionalSeriesDatum](#model-GsaDataExportDiscreteFunctionalSeriesDatum)", - "x-discriminator-value": "discreteFunctional", - "x-discriminator-name": "datumType" - }, - "GsaDataExportDiscreteFunctionalGridDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum" - }, - { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportDiscreteGridPoint" - }, - "nullable": true + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchResponse" + } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Search not found" } + } + } + }, + "/v1alpha/searches/{searchIdentifier}": { + "delete": { + "tags": [ + "Search" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDiscreteFunctionalDatum](#model-GsaDataExportDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", - "x-discriminator-value": "grid", - "x-discriminator-name": "graphType" - }, - "GsaDataExportDiscreteFunctionalSeriesDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum" - }, + "summary": "Delete search results by identifier", + "operationId": "DeleteSearchResults", + "parameters": [ { - "type": "object", - "properties": { - "series": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportDiscreteSeries" - }, - "nullable": true - } + "name": "searchIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDiscreteFunctionalDatum](#model-GsaDataExportDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", - "x-discriminator-value": "series", - "x-discriminator-name": "graphType" - }, - "GsaDataExportDiscreteGridPoint": { - "type": "object", - "properties": { - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" - }, - "nullable": true + "responses": { + "200": { + "description": "Ok" }, - "value": { - "$ref": "#/components/schemas/GsaDiscreteValue" + "403": { + "description": "Forbidden" }, - "isEstimated": { - "type": "boolean" + "404": { + "description": "Search not found" } - }, - "additionalProperties": false + } + } + }, + "/v1alpha/selection-searches": { + "get": { + "tags": [ + "SelectionSearches" + ], + "summary": "Returns all searches visible to the calling user.", + "operationId": "GetAll", + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + } + } + } + }, + "403": { + "description": "Forbidden" + } + } }, - "GsaDataExportDiscreteSeries": { - "type": "object", - "properties": { - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" + "post": { + "tags": [ + "SelectionSearches" + ], + "summary": "Creates a new search with the specified properties.", + "operationId": "CreateSearch", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } }, - "nullable": true - }, - "points": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportDiscreteSeriesPoint" + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } }, - "nullable": true + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } + } } }, - "additionalProperties": false - }, - "GsaDataExportDiscreteSeriesPoint": { - "type": "object", - "properties": { - "x": { - "type": "number", - "format": "double" - }, - "xName": { - "type": "string", - "nullable": true + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + } + } }, - "y": { - "$ref": "#/components/schemas/GsaDiscreteValue" + "400": { + "description": "Bad request" }, - "isEstimated": { - "type": "boolean" + "403": { + "description": "Forbidden" } - }, - "additionalProperties": false - }, - "GsaDataExportFileDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "type": "object", - "properties": { - "datumValue": { - "$ref": "#/components/schemas/GsaDataExportBinaryData" + } + } + }, + "/v1alpha/selection-searches/search": { + "post": { + "tags": [ + "SelectionSearches" + ], + "summary": "Retrieves a collection of searches that match the specified criteria.", + "operationId": "Search", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" } } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", - "x-discriminator-value": "file", - "x-discriminator-name": "datumType" - }, - "GsaDataExportFloatFunctionalDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "required": [ - "graphType" - ], - "type": "object", - "properties": { - "graphType": { - "type": "string", - "nullable": true - }, - "unitSymbol": { - "type": "string", - "nullable": true - }, - "xAxisParameter": { - "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" - }, - "nullable": true - }, - "isEstimated": { - "type": "boolean" + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } }, - "isRange": { - "type": "boolean" + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } }, - "isLogarithmic": { - "type": "boolean" - } - }, - "discriminator": { - "propertyName": "graphType", - "mapping": { - "grid": "#/components/schemas/GsaDataExportFunctionalGridDatum", - "series": "#/components/schemas/GsaDataExportFunctionalSeriesDatum" + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" } + } + } + }, + "/v1alpha/selection-searches/search/{searchIdentifier}": { + "get": { + "tags": [ + "SelectionSearches" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * [GsaDataExportFunctionalGridDatum](#model-GsaDataExportFunctionalGridDatum)\r\n * [GsaDataExportFunctionalSeriesDatum](#model-GsaDataExportFunctionalSeriesDatum)", - "x-discriminator-value": "floatFunctional", - "x-discriminator-name": "datumType" - }, - "GsaDataExportFunctionalGridDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportFloatFunctionalDatum" - }, + "summary": "Returns the given search if it exists and the calling user has access to it", + "operationId": "GetSearch", + "parameters": [ { - "type": "object", - "properties": { - "points": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportGridPoint" - }, - "nullable": true - }, - "graphDecoration": { - "$ref": "#/components/schemas/GsaDataExportGraphDecoration" - } + "name": "searchIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportFloatFunctionalDatum](#model-GsaDataExportFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", - "x-discriminator-value": "grid", - "x-discriminator-name": "graphType" - }, - "GsaDataExportFunctionalSeriesDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportFloatFunctionalDatum" - }, - { - "type": "object", - "properties": { - "series": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportSeries" - }, - "nullable": true + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } }, - "showAsTable": { - "type": "boolean" + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Search result not found" + }, + "410": { + "description": "Search result no longer available" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportFloatFunctionalDatum](#model-GsaDataExportFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", - "x-discriminator-value": "series", - "x-discriminator-name": "graphType" + } }, - "GsaDataExportGraphDecoration": { - "enum": [ - "Lines", - "Markers", - "LinesAndMarkers" + "put": { + "tags": [ + "SelectionSearches" ], - "type": "string", - "description": "Indicates how a graphical representation of a graph should be rendered

Possible values:

\r\n
    \r\n
  • Lines: Lines
    • \r\n
  • Markers: Markers
    • \r\n
  • LinesAndMarkers: Lines and Markers
    • \r\n
\r\n" - }, - "GsaDataExportGridPoint": { - "required": [ - "isEstimated" + "summary": "If the search exists, updates the properties of the search. This will overwrite all current properties.\r\nIf the search does not exist or the calling user does not have access to it, returns '404 not found' response.", + "operationId": "SaveSearch", + "parameters": [ + { + "name": "searchIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "type": "object", - "properties": { - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } }, - "nullable": true - }, - "lowValue": { - "type": "number", - "format": "double" - }, - "highValue": { - "type": "number", - "format": "double" - }, - "isEstimated": { - "type": "boolean" + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } + } } }, - "additionalProperties": false - }, - "GsaDataExportHyperlink": { - "type": "object", - "properties": { - "address": { - "type": "string", - "nullable": true + "responses": { + "200": { + "description": "Ok" }, - "formattedAddress": { - "type": "string", - "nullable": true + "400": { + "description": "Bad request" }, - "description": { - "type": "string", - "nullable": true + "403": { + "description": "Forbidden" }, - "target": { - "$ref": "#/components/schemas/GsaHyperlinkTarget" + "404": { + "description": "Search not found" } - }, - "additionalProperties": false + } }, - "GsaDataExportHyperlinkDatum": { - "type": "object", - "allOf": [ + "delete": { + "tags": [ + "SelectionSearches" + ], + "summary": "Delete an existing selection search.", + "operationId": "DeleteSearch", + "parameters": [ { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" + "name": "searchIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" }, - { - "type": "object", - "properties": { - "datumValue": { - "$ref": "#/components/schemas/GsaDataExportHyperlink" + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Selection search not found" + } + } + } + }, + "/v1alpha/serverManager/email": { + "get": { + "tags": [ + "Server Manager" + ], + "operationId": "GetSmtpProperties", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } } } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", - "x-discriminator-value": "hyperlink", - "x-discriminator-name": "datumType" + } }, - "GsaDataExportLinkDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "required": [ - "linkDatumType" - ], - "type": "object", - "properties": { - "linkDatumType": { - "type": "string", - "nullable": true + "put": { + "tags": [ + "Server Manager" + ], + "operationId": "Put", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" } }, - "discriminator": { - "propertyName": "linkDatumType", - "mapping": { - "linkGroup": "#/components/schemas/GsaDataExportLinkedRecordsDatum", - "tabular": "#/components/schemas/GsaDataExportTabularDatum" + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" } } } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/v1alpha/status": { + "get": { + "tags": [ + "Status" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'\r\n\r\nThis is one of: \r\n * [GsaDataExportLinkedRecordsDatum](#model-GsaDataExportLinkedRecordsDatum)\r\n * [GsaDataExportTabularDatum](#model-GsaDataExportTabularDatum)", - "x-discriminator-value": "link", - "x-discriminator-name": "datumType" - }, - "GsaDataExportLinkedRecordsDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportLinkDatum" - }, - { - "type": "object", - "properties": { - "linkGroupName": { - "type": "string", - "nullable": true - }, - "linkAttributeType": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - }, - "exportInReversedDirection": { - "type": "boolean" - }, - "targetDatabaseGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "linkedRecords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordWithData" - }, - "nullable": true - }, - "linkGroupNamesByDatabaseKey": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true + "summary": "Check whether the API is available", + "operationId": "Get", + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/v1alpha/status/databases": { + "get": { + "tags": [ + "Status" + ], + "summary": "Returns status information for all databases", + "operationId": "GetStatus", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + } }, - "linkGroupIdentitiesByDatabaseKey": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "nullable": true + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + } }, - "rolledUpData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportRollupDatum" - }, - "nullable": true + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + } } } } + } + } + }, + "/v1alpha/status/databases/{database-key}": { + "get": { + "tags": [ + "Status" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportLinkDatum](#model-GsaDataExportLinkDatum)\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'linkGroup'", - "x-discriminator-value": "linkGroup", - "x-discriminator-name": "linkDatumType" - }, - "GsaDataExportLongTextDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, + "summary": "Returns status information for a given database", + "operationId": "GetDatabaseStatus", + "parameters": [ { - "type": "object", - "properties": { - "datumValue": { - "type": "string", - "nullable": true - } + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", - "x-discriminator-value": "longText", - "x-discriminator-name": "datumType" - }, - "GsaDataExportNotApplicableDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportDatum" - }, - { - "required": [ - "datumType" - ], - "type": "object", - "properties": { - "datumType": { - "$ref": "#/components/schemas/GsaAttributeType" + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } } } } + } + } + }, + "/v1alpha/status/search-cluster": { + "get": { + "tags": [ + "Status" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDatum](#model-GsaDataExportDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", - "x-discriminator-value": "notApplicable", - "x-discriminator-name": "notApplicable" - }, - "GsaDataExportNumericDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "type": "object", - "properties": { - "datumValue": { - "type": "integer", - "format": "int64" + "summary": "Returns disk status information for the search cluster", + "operationId": "GetSearchClusterStatus", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchClusterStatus" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchClusterStatus" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchClusterStatus" + } } } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "datumType" - }, - "GsaDataExportNumericRollupDatum": { - "type": "object", - "allOf": [ + } + } + } + }, + "components": { + "schemas": { + "GrantaMIRecordPropertyFakeAttributeIdentities": { + "enum": [ { - "$ref": "#/components/schemas/GsaDataExportRollupDatum" + "name": "Breadcrumbs", + "identity": -10, + "guid": "00000007-0000-0000-0000-000000000000" }, { - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "unit": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "A statistical rollup of a set of numeric values\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'statisticalRollup'", - "x-discriminator-value": "statisticalRollup", - "x-discriminator-name": "type" - }, - "GsaDataExportParameterValue": { - "type": "object", - "properties": { - "parameter": { - "$ref": "#/components/schemas/GsaParameterInfo" + "name": "TreeName", + "identity": -9, + "guid": "00000006-0000-0000-0000-000000000000" }, - "valueName": { - "type": "string", - "nullable": true + { + "name": "TableIdentity", + "identity": -8, + "guid": "00000005-0000-0000-0000-000000000000" }, - "value": { - "type": "number", - "format": "double" - } - }, - "additionalProperties": false - }, - "GsaDataExportPictureDatum": { - "type": "object", - "allOf": [ { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" + "name": "TableName", + "identity": -7, + "guid": "00000004-0000-0000-0000-000000000000" }, { - "type": "object", - "properties": { - "datumValue": { - "$ref": "#/components/schemas/GsaDataExportBinaryData" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", - "x-discriminator-value": "picture", - "x-discriminator-name": "datumType" - }, - "GsaDataExportPoint": { - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" + "name": "RecordColor", + "identity": -6, + "guid": "00000003-0000-0000-0000-000000000000" }, - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDataExportPointDatum": { - "type": "object", - "allOf": [ { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" + "name": "DatabaseKey", + "identity": -5, + "guid": "00000002-0000-0000-0000-000000000000" }, { - "type": "object", - "properties": { - "datumValue": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportPoint" - }, - "nullable": true - }, - "isEstimated": { - "type": "boolean" - }, - "unit": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", - "x-discriminator-value": "point", - "x-discriminator-name": "datumType" - }, - "GsaDataExportRange": { - "type": "object", - "properties": { - "highEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "name": "RecordName", + "identity": -4, + "guid": "00000001-0000-0000-0000-000000000000" }, - "lowEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" - } - }, - "additionalProperties": false + { + "name": "RecordModifiedBy", + "identity": -3, + "guid": "00000009-0000-0000-0000-000000000000" + }, + { + "name": "RecordCreatedBy", + "identity": -2, + "guid": "00000008-0000-0000-0000-000000000000" + } + ], + "type": "string", + "description": "Values that can be used in place of an attribute identity to perform a search, aggregation or export of a record property. RecordCreatedBy and RecordModifiedBy cannot be used in free text search or aggregation.", + "format": "int32" }, - "GsaDataExportRangeDatum": { + "GsaAboutAttributeCannotBeMetaAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { - "type": "object", - "properties": { - "datumValue": { - "$ref": "#/components/schemas/GsaDataExportRange" - }, - "isEstimated": { - "type": "boolean" - }, - "unit": { - "type": "string", - "nullable": true - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", - "x-discriminator-value": "range", - "x-discriminator-name": "datumType" + "description": "Cannot have a meta-attribute as an 'About attribute'.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'aboutAttributeCannotBeMeta'", + "x-discriminator-value": "aboutAttributeCannotBeMeta", + "x-discriminator-name": "reason" }, - "GsaDataExportRequest": { + "GsaAddDatabase": { "required": [ - "attributes", - "recordProperties" + "connectionDetails", + "databaseKey" ], "type": "object", "properties": { - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeToExport" - } + "databaseKey": { + "type": "string" }, - "recordProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordProperty" - } + "connectionDetails": { + "$ref": "#/components/schemas/GsaConnectionDetails" }, - "recordHistoryGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "isReadOnly": { + "type": "boolean", + "description": "(Optional) True if the database should be set to read only after adding", "nullable": true }, - "recordVersionGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "Data can be exported for either record histories or record versions in each request, not both.", + "loadingOrder": { + "type": "integer", + "description": "(Optional) The MI loading order for the database", + "format": "int32", + "nullable": true + }, + "language": { + "type": "string", + "description": "(Optional) The language of the database, used when indexing the database. Currently \"english\" is the only supported value.", + "nullable": true + }, + "versionGuid": { + "type": "string", + "description": "(Optional) Overrides the database version guid stored in the database. This must be unique across all the loaded databases.", + "format": "uuid", "nullable": true } }, "additionalProperties": false, - "description": "Request object for exporting the attribute data from a list of records. Either the identity or GUID of the attributes to export must be provided" + "description": "\r\n\r\nconnectionDetails: The SQL server connection details for the database" }, - "GsaDataExportResponse": { - "required": [ - "failures", - "results" + "GsaAddDatabaseIssueType": { + "enum": [ + "schemaTooNew", + "schemaTooOld", + "duplicateGuid", + "duplicateVersionGuid", + "duplicateKey", + "invalidKey", + "unableToConnect", + "duplicateDatabase" ], - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordWithData" - } - }, - "failures": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaExportFailure" - }, - "description": "List the records that were requested, but that we failed to export any data for." - } - }, - "additionalProperties": false + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • schemaTooNew: The specified database schema is too new, you must upgrade MI:Server before this database can be used.
    • \r\n
  • schemaTooOld: The specified database schema is too old and must be upgraded.
    • \r\n
  • duplicateGuid: Duplicate Guid.
    • \r\n
  • duplicateVersionGuid: Duplicate version Guid.
    • \r\n
  • duplicateKey: Duplicate database key.
    • \r\n
  • invalidKey: Invalid database key.
    • \r\n
  • unableToConnect: Unable to connect to database.
    • \r\n
  • duplicateDatabase: Duplicate database - this database has already been added to MI.
    • \r\n
\r\n" }, - "GsaDataExportRollupDatum": { + "GsaAddDatabaseValidationIssue": { "required": [ - "pathAttributeGuids", - "pathAttributeIdentities", - "type" + "IssueType" ], "type": "object", "properties": { - "databaseKey": { - "type": "string", - "description": "The database key of the rolled up data", - "nullable": true - }, - "attributeIdentity": { - "type": "integer", - "description": "The attribute identity of the rolled up data.\r\nIf the data came from a local column, this is the column identity.\r\nIf the data came from linked records, this is the identity of the tabular attribute", - "format": "int64", - "nullable": true - }, - "attributeGuid": { - "type": "string", - "description": "The attribute GUID of the rolled up data.\r\nIf the data came from a local column, this is the column GUID.\r\nIf the data came from linked records, this is the GUID of the tabular attribute", - "format": "uuid", - "nullable": true - }, - "rollUpType": { - "$ref": "#/components/schemas/GsaTabularColumnRollUpType" - }, - "pathAttributeGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "The path from the exported link datum that contains this rollup, to the rolled up attribute.\r\nCan be used to distinguish rollups over the same attribute via different link attributes.\r\nOnly populated if the attributes were requested by GUID - if they were requested by identity, see pathAttributeIdentities." - }, - "pathAttributeIdentities": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "The path from the exported link datum that contains this rollup, to the rolled up attribute.\r\nCan be used to distinguish rollups over the same attribute via different link attributes.\r\nOnly populated if the attributes were requested by identity - if they were requested by GUID, see pathAttributeGuids." + "IssueType": { + "$ref": "#/components/schemas/GsaAddDatabaseIssueType" }, - "type": { + "additionalInformation": { "type": "string", "nullable": true } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDataExportNumericRollupDatum](#model-GsaDataExportNumericRollupDatum)\r\n * [GsaDataExportValueRollupDatum](#model-GsaDataExportValueRollupDatum)\r\n * [GsaDataExportValuesRollupDatum](#model-GsaDataExportValuesRollupDatum)\r\n * [GsaDataExportCountRollupDatum](#model-GsaDataExportCountRollupDatum)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDuplicateGuidAddDatabaseValidationIssue\r\n * GsaDuplicateVersionGuidAddDatabaseValidationIssue\r\n * GsaDuplicateKeyAddDatabaseValidationIssue\r\n * GsaInvalidKeyAddDatabaseValidationIssue\r\n * GsaSchemaTooNewAddDatabaseValidationIssue\r\n * GsaSchemaTooOldAddDatabaseValidationIssue\r\n * GsaUnableToConnectAddDatabaseValidationIssue\r\n * GsaDuplicateDatabaseAddDatabaseValidationIssue", "discriminator": { - "propertyName": "type", + "propertyName": "IssueType", "mapping": { - "statisticalRollup": "#/components/schemas/GsaDataExportNumericRollupDatum", - "valueRollup": "#/components/schemas/GsaDataExportValueRollupDatum", - "valuesRollup": "#/components/schemas/GsaDataExportValuesRollupDatum", - "countRollup": "#/components/schemas/GsaDataExportCountRollupDatum" + "duplicateGuid": "#/components/schemas/GsaDuplicateGuidAddDatabaseValidationIssue", + "duplicateVersionGuid": "#/components/schemas/GsaDuplicateVersionGuidAddDatabaseValidationIssue", + "duplicateKey": "#/components/schemas/GsaDuplicateKeyAddDatabaseValidationIssue", + "invalidKey": "#/components/schemas/GsaInvalidKeyAddDatabaseValidationIssue", + "schemaTooNew": "#/components/schemas/GsaSchemaTooNewAddDatabaseValidationIssue", + "schemaTooOld": "#/components/schemas/GsaSchemaTooOldAddDatabaseValidationIssue", + "unableToConnect": "#/components/schemas/GsaUnableToConnectAddDatabaseValidationIssue", + "duplicateDatabase": "#/components/schemas/GsaDuplicateDatabaseAddDatabaseValidationIssue" } } }, - "GsaDataExportSeries": { + "GsaAddDatabaseValidationResult": { "type": "object", "properties": { - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" - }, - "nullable": true - }, - "points": { + "addDatabaseIssues": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDataExportSeriesPoint" + "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" }, "nullable": true - }, - "graphDecoration": { - "$ref": "#/components/schemas/GsaDataExportGraphDecoration" } }, "additionalProperties": false }, - "GsaDataExportSeriesPoint": { + "GsaAddRecordHistoryToSubset": { "required": [ - "isEstimated" + "recordHistoryGuid" ], "type": "object", "properties": { - "xValue": { - "type": "number", - "format": "double" - }, - "xName": { + "recordHistoryGuid": { "type": "string", - "nullable": true - }, - "yLowValue": { - "type": "number", - "format": "double" - }, - "yHighValue": { - "type": "number", - "format": "double" + "format": "uuid" }, - "isEstimated": { + "recurseChildren": { "type": "boolean" } }, "additionalProperties": false }, - "GsaDataExportShortTextDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportApplicableDatum" - }, - { - "type": "object", - "properties": { - "datumValue": { - "type": "string", - "nullable": true - } - } - } + "GsaAggregation": { + "required": [ + "type" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", - "x-discriminator-value": "shortText", - "x-discriminator-name": "datumType" - }, - "GsaDataExportTabularDatum": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportLinkDatum" - }, - { - "type": "object", - "properties": { - "attributeName": { - "type": "string", - "nullable": true - }, - "tabularRows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportTabularRow" - }, - "nullable": true - }, - "summaryRow": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportRollupDatum" - }, - "nullable": true - } - } + "properties": { + "type": { + "$ref": "#/components/schemas/GsaAggregationType" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportLinkDatum](#model-GsaDataExportLinkDatum)\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'tabular'", - "x-discriminator-value": "tabular", - "x-discriminator-name": "linkDatumType" + "description": "The results of aggregation.\r\n\r\nThis is one of: \r\n * GsaAttributeAggregation\r\n * GsaFreeTextAggregation", + "discriminator": { + "propertyName": "type", + "mapping": { + "attribute": "#/components/schemas/GsaAttributeAggregation", + "text": "#/components/schemas/GsaFreeTextAggregation" + } + } }, - "GsaDataExportTabularRow": { + "GsaAggregationCriterion": { + "required": [ + "type" + ], "type": "object", "properties": { - "rowGuid": { - "type": "string", - "format": "uuid" - }, - "linkingValue": { - "type": "string", - "nullable": true - }, - "rowNumber": { - "type": "integer", - "format": "int32" - }, - "localData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportDatum" - }, - "nullable": true - }, - "linkedRecords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordHistoryReference" - }, - "description": "Records linked to this tabular row (only populated if the target table/attribute was provided in the request)", - "nullable": true - }, - "linkedData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordWithData" - }, - "description": "Data for the linked records, if the request included linked data to export", - "nullable": true - }, - "rolledUpData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataExportRollupDatum" - }, - "nullable": true + "type": { + "$ref": "#/components/schemas/GsaAggregationType" } }, - "additionalProperties": false - }, - "GsaDataExportUnknownDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportDatum" - }, - { - "required": [ - "datumType" - ], - "type": "object", - "properties": { - "datumType": { - "$ref": "#/components/schemas/GsaAttributeType" - } - } - } - ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDatum](#model-GsaDataExportDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'unknown'", - "x-discriminator-value": "unknown", - "x-discriminator-name": "notApplicable" - }, - "GsaDataExportValueRollupDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportRollupDatum" - }, - { - "type": "object", - "properties": { - "value": { - "type": "object", - "nullable": true - } - } + "description": "\r\n\r\nThis is one of: \r\n * GsaAttributeAggregationCriterion\r\n * GsaFreeTextAggregationCriterion", + "discriminator": { + "propertyName": "type", + "mapping": { + "attribute": "#/components/schemas/GsaAttributeAggregationCriterion", + "text": "#/components/schemas/GsaFreeTextAggregationCriterion" } - ], - "additionalProperties": false, - "description": "A rollup where the value is a single object (such as a discrete value)\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'valueRollup'", - "x-discriminator-value": "valueRollup", - "x-discriminator-name": "type" + } }, - "GsaDataExportValuesRollupDatum": { + "GsaAggregationDatum": { + "required": [ + "datumType" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDataExportRollupDatum" - }, - { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "type": "object" - }, - "nullable": true - }, - "unit": { - "type": "string", - "nullable": true - } - } + "properties": { + "datumType": { + "$ref": "#/components/schemas/GsaAggregationDatumType" } - ], + }, "additionalProperties": false, - "description": "A rollup to a list of values\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'valuesRollup'", - "x-discriminator-value": "valuesRollup", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis is one of: \r\n * GsaIntegerAggregation\r\n * GsaPointAggregation\r\n * GsaRangeAggregation\r\n * GsaIntegerHistogramAggregation\r\n * GsaPointHistogramAggregation\r\n * GsaRangeHistogramAggregation\r\n * GsaDateTimeAggregation\r\n * GsaDateTimeHistogramAggregation\r\n * GsaShortTextAggregation\r\n * GsaDiscreteTextAggregation\r\n * GsaLinkAggregation\r\n * GsaLogicalAggregation\r\n * GsaFloatFunctionalAggregation", + "discriminator": { + "propertyName": "datumType", + "mapping": { + "integer": "#/components/schemas/GsaIntegerAggregation", + "point": "#/components/schemas/GsaPointAggregation", + "range": "#/components/schemas/GsaRangeAggregation", + "integerHistogram": "#/components/schemas/GsaIntegerHistogramAggregation", + "pointHistogram": "#/components/schemas/GsaPointHistogramAggregation", + "rangeHistogram": "#/components/schemas/GsaRangeHistogramAggregation", + "dateTime": "#/components/schemas/GsaDateTimeAggregation", + "dateTimeHistogram": "#/components/schemas/GsaDateTimeHistogramAggregation", + "shortText": "#/components/schemas/GsaShortTextAggregation", + "discreteText": "#/components/schemas/GsaDiscreteTextAggregation", + "link": "#/components/schemas/GsaLinkAggregation", + "logical": "#/components/schemas/GsaLogicalAggregation", + "floatFunctionalGraph": "#/components/schemas/GsaFloatFunctionalAggregation" + } + } }, - "GsaDataModificationErrorDetail": { + "GsaAggregationDatumCriterion": { "required": [ - "message", - "reason" + "type" ], "type": "object", "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaDataModificationErrorReason" + "type": { + "$ref": "#/components/schemas/GsaAggregationDatumCriterionType" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDateTimeAggregationDatumCriterion\r\n * GsaDateTimeHistogramAggregationDatumCriterion\r\n * GsaDateTimeFixedWidthHistogramAggregationDatumCriterion\r\n * GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion\r\n * GsaDiscreteTextAggregationDatumCriterion\r\n * GsaIntegerAggregationDatumCriterion\r\n * GsaPointAggregationDatumCriterion\r\n * GsaRangeAggregationDatumCriterion\r\n * GsaIntegerHistogramAggregationDatumCriterion\r\n * GsaIntegerFixedWidthHistogramAggregationDatumCriterion\r\n * GsaPointHistogramAggregationDatumCriterion\r\n * GsaPointFixedWidthHistogramAggregationDatumCriterion\r\n * GsaRangeHistogramAggregationDatumCriterion\r\n * GsaRangeFixedWidthHistogramAggregationDatumCriterion\r\n * GsaShortTextAggregationDatumCriterion\r\n * GsaLinkAggregationDatumCriterion\r\n * GsaLogicalAggregationDatumCriterion\r\n * GsaFloatFunctionalAggregationDatumCriterion", "discriminator": { - "propertyName": "reason", + "propertyName": "type", "mapping": { - "usage": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "dateTime": "#/components/schemas/GsaDateTimeAggregationDatumCriterion", + "dateTimeHistogram": "#/components/schemas/GsaDateTimeHistogramAggregationDatumCriterion", + "dateTimeFixedWidthHistogram": "#/components/schemas/GsaDateTimeFixedWidthHistogramAggregationDatumCriterion", + "dateTimeFixedCalendarWidthHistogram": "#/components/schemas/GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion", + "discreteText": "#/components/schemas/GsaDiscreteTextAggregationDatumCriterion", + "integer": "#/components/schemas/GsaIntegerAggregationDatumCriterion", + "point": "#/components/schemas/GsaPointAggregationDatumCriterion", + "range": "#/components/schemas/GsaRangeAggregationDatumCriterion", + "integerHistogram": "#/components/schemas/GsaIntegerHistogramAggregationDatumCriterion", + "integerFixedWidthHistogram": "#/components/schemas/GsaIntegerFixedWidthHistogramAggregationDatumCriterion", + "pointHistogram": "#/components/schemas/GsaPointHistogramAggregationDatumCriterion", + "pointFixedWidthHistogram": "#/components/schemas/GsaPointFixedWidthHistogramAggregationDatumCriterion", + "rangeHistogram": "#/components/schemas/GsaRangeHistogramAggregationDatumCriterion", + "rangeFixedWidthHistogram": "#/components/schemas/GsaRangeFixedWidthHistogramAggregationDatumCriterion", + "shortText": "#/components/schemas/GsaShortTextAggregationDatumCriterion", + "link": "#/components/schemas/GsaLinkAggregationDatumCriterion", + "logical": "#/components/schemas/GsaLogicalAggregationDatumCriterion", + "floatFunctionalGraph": "#/components/schemas/GsaFloatFunctionalAggregationDatumCriterion" } } }, - "GsaDataModificationErrorReason": { + "GsaAggregationDatumCriterionType": { "enum": [ - "usage" + "dateTime", + "dateTimeHistogram", + "dateTimeFixedWidthHistogram", + "dateTimeFixedCalendarWidthHistogram", + "discreteText", + "integer", + "integerHistogram", + "integerFixedWidthHistogram", + "point", + "pointHistogram", + "pointFixedWidthHistogram", + "range", + "rangeHistogram", + "rangeFixedWidthHistogram", + "shortText", + "link", + "logical", + "floatFunctionalGraph" ], "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • usage: It is being used.
    • \r\n
\r\n" + "description": "

Possible values:

\r\n
    \r\n
  • dateTime: Aggregation datum criterion date time type
    • \r\n
  • dateTimeHistogram: Aggregation datum criterion date time histogram type
    • \r\n
  • dateTimeFixedWidthHistogram: Aggregation datum criterion date time fixed width histogram type
    • \r\n
  • dateTimeFixedCalendarWidthHistogram: Aggregation datum criterion date time fixed calendar width histogram type
    • \r\n
  • discreteText: Aggregation datum criterion discrete type
    • \r\n
  • integer: Aggregation datum criterion integer type
    • \r\n
  • integerHistogram: Aggregation datum criterion integer histogram type
    • \r\n
  • integerFixedWidthHistogram: Aggregation datum criterion integer fixed width histogram type
    • \r\n
  • point: Aggregation datum criterion point type
    • \r\n
  • pointHistogram: Aggregation datum criterion point histogram type
    • \r\n
  • pointFixedWidthHistogram: Aggregation datum criterion point fixed width histogram type
    • \r\n
  • range: Aggregation datum criterion range type
    • \r\n
  • rangeHistogram: Aggregation datum criterion range histogram type
    • \r\n
  • rangeFixedWidthHistogram: Aggregation datum criterion range fixed width histogram type
    • \r\n
  • shortText: Aggregation datum criterion short text type
    • \r\n
  • link: Aggregation datum criterion link type
    • \r\n
  • logical: Aggregation datum criterion logical type
    • \r\n
  • floatFunctionalGraph: Aggregation datum criterion float functional graph type
    • \r\n
\r\n" }, - "GsaDataRule": { - "required": [ - "description", - "guid", - "name", - "regularExpression", - "usedByAttributes" + "GsaAggregationDatumExistsCriterion": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/GsaAttributeType" + } + }, + "additionalProperties": false, + "description": "Inner criterion of an attribute search criterion for when the only bit of information about the datum that we want to convey is its type" + }, + "GsaAggregationDatumType": { + "enum": [ + "integer", + "point", + "range", + "integerHistogram", + "pointHistogram", + "rangeHistogram", + "dateTime", + "dateTimeHistogram", + "shortText", + "discreteText", + "link", + "logical", + "floatFunctionalGraph" + ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • integer: Aggregation datum integer type
    • \r\n
  • point: Aggregation datum point type
    • \r\n
  • range: Aggregation datum range type
    • \r\n
  • integerHistogram: Aggregation datum integer histogram type
    • \r\n
  • pointHistogram: Aggregation datum point histogram type
    • \r\n
  • rangeHistogram: Aggregation datum range histogram type
    • \r\n
  • dateTime: Aggregation datum date time type
    • \r\n
  • dateTimeHistogram: Aggregation datum date time histogram type
    • \r\n
  • shortText: Aggregation datum short text type
    • \r\n
  • discreteText: Aggregation datum discrete text type
    • \r\n
  • link: Aggregation datum link type
    • \r\n
  • logical: Aggregation datum logical type
    • \r\n
  • floatFunctionalGraph: Aggregation datum float functional graph type
    • \r\n
\r\n" + }, + "GsaAggregationType": { + "enum": [ + "attribute", + "text" ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • attribute: Aggregation attribute type
    • \r\n
  • text: Aggregation text type
    • \r\n
\r\n" + }, + "GsaAggregationsRequest": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "regularExpression": { - "type": "string" + "criterion": { + "$ref": "#/components/schemas/GsaCriterion" }, - "usedByAttributes": { + "aggregationCriteria": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimAttribute" - } - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaAggregationCriterion" + }, + "description": "The aggregations you wish to perform.", + "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "A request for aggregation information from a particular scope. The type of information\r\nrequested can vary: for example, for attributes, it could be a request for minimum/maximum\r\nvalues, or for common text terms.\r\n \r\nAn aggregation request is associated with a particular scope (database, table, integration\r\nschema, etc) based off the API invoked; however, the scope can be further narrowed down by\r\nproviding a criterion in the aggregation request. Only data from records matching that\r\ncriterion will be considered when aggregating data.\r\n \r\nNote that only some types of criterion will be supported: in particular, criteria that involve\r\n\"matches\" criteria against functional attributes, or link-attribute criteria against record\r\nlink groups, are not eligible to be used as an aggregation query criterion.\r\n\r\ncriterion: An optional query criterion, to be used to filter the collection of records to aggregate over." }, - "GsaDataRulesInfo": { + "GsaAggregationsResponse": { + "required": [ + "results" + ], "type": "object", "properties": { - "dataRules": { + "results": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDataRule" - }, - "nullable": true + "$ref": "#/components/schemas/GsaAggregation" + } } }, "additionalProperties": false }, - "GsaDataSource": { + "GsaAllProfilesInfo": { "type": "object", "properties": { - "value": { - "type": "string", + "profiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimProfile" + }, "nullable": true + }, + "defaultProfile": { + "$ref": "#/components/schemas/GsaSlimProfile" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Object containing list of all profiles as well as default profile if it is set and can be found within the list.\r\n\r\ndefaultProfile: Profile used by default in MI Applications. Null if no default profile is chosen or if default profile is not visible for current user." }, - "GsaDataUpdate": { - "required": [ - "header", - "token" - ], + "GsaAllValuesSpecifier": { "type": "object", - "properties": { - "token": { - "$ref": "#/components/schemas/GsaDataUpdateToken" - }, - "header": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" + "allOf": [ + { + "$ref": "#/components/schemas/GsaValueSpecifier" }, - "runInfo": { - "$ref": "#/components/schemas/GsaDataUpdateRunInfo" + { + "type": "object" } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "Specifies no filtering.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'all'", + "x-discriminator-value": "all", + "x-discriminator-name": "filterOn" }, - "GsaDataUpdateDeletionException": { + "GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDeletionException" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'dataUpdate'", - "x-discriminator-value": "dataUpdate", - "x-discriminator-name": "entityType" + "description": "Anonymous expressions cannot be allowed without allowing all compatible expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'anonymousExpressionsMustAllowAllCompatible'", + "x-discriminator-value": "anonymousExpressionsMustAllowAllCompatible", + "x-discriminator-name": "reason" }, - "GsaDataUpdateHeader": { - "required": [ - "containsFallbackIdentifiers", - "createDate", - "name", - "projectGuid", - "sourceVolumeGuid", - "supportedObjectsVersion", - "updateFormatVersion", - "updateGuid" - ], + "GsaAppNameLicenseCheckoutRequest": { "type": "object", "properties": { - "createDate": { - "type": "string", - "description": "The date and time that the update was created.", - "format": "date-time" - }, - "updateGuid": { - "type": "string", - "description": "A unique identity to disambiguate this update from all other updates.", - "format": "uuid" - }, - "prerequisiteUpdateGuid": { - "type": "string", - "description": "GUID for the previous update that need to have been applied before this update can be applied.", - "format": "uuid", - "nullable": true - }, - "prerequisiteUpdateName": { - "type": "string", - "description": "Name of the previous update that need to have been applied before this update can be applied. This is used only for display purposes.", - "nullable": true - }, - "miVersion": { - "type": "string", - "description": "Gets the version of MI that was used to create this update.", - "nullable": true - }, - "supportedObjectsVersion": { - "type": "integer", - "description": "Gets or sets the version number indicating the kinds of object that this update supports. A client will be\r\nable to process updates with an unrecognised SupportedObjectsVersion (although in doing so it will have to\r\nignore fields describing objects it does not recognise).", - "format": "int32" - }, - "updateFormatVersion": { - "type": "integer", - "description": "Gets or sets the version number of the format of the update. This will change if the meaning of any of the\r\nfields in the update changes. A client must not process an update with an UpdateFormatVersion field that it\r\ndoes not recognise, as it cannot be sure of the meaning of the fields it reads.", - "format": "int32" - }, - "sourceDatabaseKey": { - "type": "string", - "description": "Gets or sets the database key of the database from which this update was generated.", - "nullable": true - }, - "sourceVolumeGuid": { - "type": "string", - "description": "Gets or sets the guid of the volume from which the update was generated.", - "format": "uuid" - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the update." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the update.", - "nullable": true - }, - "projectName": { - "type": "string", - "description": "Gets or sets the name of the project this update was created for.", - "nullable": true - }, - "projectGuid": { - "type": "string", - "description": "Gets or sets the guid of the project this update was created for.", - "format": "uuid" - }, - "containsFallbackIdentifiers": { - "type": "boolean", - "description": "Gets or sets the flag informing whether or not this update contains fallback identifiers (mostly names)." - }, - "newVersionGuid": { - "type": "string", - "description": "Gets or sets the value Database Version GUID should be updated to.\r\nIf this field is set then we propose to retarget tabular attributes to link to new version of the database.", - "format": "uuid", + "appNames": { + "type": "array", + "items": { + "type": "string" + }, "nullable": true } }, "additionalProperties": false }, - "GsaDataUpdateRunInfo": { - "required": [ - "applyAddsAsState", - "databaseKey", - "matchMode", - "retargetTabularAttributes", - "status" - ], + "GsaAppNameLicenseCheckoutResponse": { "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, - "matchMode": { - "$ref": "#/components/schemas/GsaMatchMode" - }, - "applyAddsAsState": { - "type": "boolean" - }, - "retargetTabularAttributes": { - "type": "boolean" - }, - "status": { - "$ref": "#/components/schemas/GsaUpdateRunStatus" - }, - "progressPercentage": { - "type": "number", - "format": "double", - "nullable": true - }, - "appliedDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "errorMessage": { - "type": "string", + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResult" + }, "nullable": true } }, "additionalProperties": false }, - "GsaDataUpdateToken": { - "required": [ - "databaseKey", - "guid" - ], + "GsaAppNameLicenseCheckoutResult": { "type": "object", "properties": { - "guid": { + "appName": { "type": "string", - "format": "uuid" + "nullable": true }, - "databaseKey": { - "type": "string" + "licenseStateOk": { + "type": "boolean" } }, "additionalProperties": false }, - "GsaDataUpdaterJob": { + "GsaAppendDiscreteValues": { "required": [ - "databaseKey", - "id", - "jobType", - "status", - "timeStarted" + "discreteValues" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "Gets or sets the token which identifies this job.", - "format": "uuid" - }, - "updateToken": { - "$ref": "#/components/schemas/GsaDataUpdateToken" - }, - "jobType": { - "$ref": "#/components/schemas/GsaDataUpdaterJobType" - }, - "databaseKey": { - "type": "string", - "description": "Gets or sets the key of the database against which this job has been / will be run." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the update.", - "nullable": true - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the job.", - "nullable": true - }, - "status": { - "$ref": "#/components/schemas/GsaDataUpdaterJobStatus" - }, - "projectName": { - "type": "string", - "description": "Gets or sets the project.", - "nullable": true - }, - "timeStarted": { - "type": "string", - "description": "Gets or sets the time that the job started.", - "format": "date-time" - }, - "timeCompleted": { - "type": "string", - "description": "Gets or sets the time that the job completed.", - "format": "date-time", - "nullable": true - }, - "error": { - "type": "string", - "description": "The error that occurred (if any) when the job was run. If the\r\njob has not yet been run, or if the job completed successfully,\r\nthis will be null.", - "nullable": true + "discreteValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimEntity" + } } }, - "additionalProperties": false, - "description": "\r\n\r\nupdateToken: Gets or sets the token which links this job to the update on which it is working.\r\n\r\njobType: Gets or sets the type of job.\r\n\r\nstatus: Gets or sets the job status." - }, - "GsaDataUpdaterJobStatus": { - "enum": [ - "Unknown", - "Queued", - "InProgress", - "Completed", - "Cancelled", - "Cancelling", - "Failed", - "NotFound" - ], - "type": "string", - "description": "The status of a data updater job.

Possible values:

\r\n
    \r\n
  • Unknown: This job is in an unknown state.
    • \r\n
  • Queued: This job is in the queue and has not been started.
    • \r\n
  • InProgress: This job is in progress.
    • \r\n
  • Completed: This job completed successfully.
    • \r\n
  • Cancelled: This job was cancelled.
    • \r\n
  • Cancelling: This job is in the process of being cancelled.
    • \r\n
  • Failed: This job failed.
    • \r\n
  • NotFound: This job cannot be found.
    • \r\n
\r\n" - }, - "GsaDataUpdaterJobType": { - "enum": [ - "NoAction", - "CreateUpdate", - "Ship", - "DryRunUpdate", - "ApplyUpdate" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • NoAction: A job that takes no action.
    • \r\n
  • CreateUpdate: A job that creates an update.
    • \r\n
  • Ship: A job that ships an update.
    • \r\n
  • DryRunUpdate: A job that performs a dry run of an update on a database.
    • \r\n
  • ApplyUpdate: A job that applies an update to a database.
    • \r\n
\r\n" + "additionalProperties": false }, - "GsaDataUpdaterProject": { + "GsaAppendPointValues": { "required": [ - "guid", - "includeDbDependencies", - "includeDeselectedDbDependencies", - "includeForeignCategoryItems", - "name", - "recordAndAttributeSelectionType" + "values" ], "type": "object", "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - }, - "recordAndAttributeSelectionType": { - "$ref": "#/components/schemas/GsaRecordAndAttributeSelectionType" - }, - "includeDbDependencies": { - "type": "boolean" - }, - "includeDeselectedDbDependencies": { - "type": "boolean" - }, - "includeForeignCategoryItems": { - "type": "boolean" - }, - "lastUpdateFileName": { - "type": "string", - "nullable": true - }, - "lastMarkedReadyForSendingByUserName": { - "type": "string", - "nullable": true - }, - "timeLastUpdateMarkedReadyForSending": { - "type": "string", - "format": "date-time" - }, - "lastMarkedReadyForSendingAtRevision": { - "type": "integer", - "format": "int32" - }, - "lastUpdateGeneratedByUserName": { - "type": "string", - "nullable": true - }, - "timeLastUpdateGenerated": { - "type": "string", - "format": "date-time" - }, - "profileId": { - "type": "string", - "nullable": true - }, - "selection": { - "$ref": "#/components/schemas/GsaSelection" + "values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSetPointDatumValue" + } } }, "additionalProperties": false }, - "GsaDataUsageDataModificationErrorDetail": { + "GsaApplicableDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "$ref": "#/components/schemas/GsaDatum" }, { "required": [ - "entityInUse" + "datumType" ], "type": "object", "properties": { - "entityInUse": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "datumType": { + "$ref": "#/components/schemas/GsaDatumType" + } + }, + "discriminator": { + "propertyName": "datumType", + "mapping": { + "integer": "#/components/schemas/GsaIntegerDatum", + "logical": "#/components/schemas/GsaLogicalDatum", + "shortText": "#/components/schemas/GsaShortTextDatum", + "longText": "#/components/schemas/GsaLongTextDatum", + "hyperlink": "#/components/schemas/GsaHyperlinkDatum", + "dateTime": "#/components/schemas/GsaDateTimeDatum", + "discrete": "#/components/schemas/GsaDiscreteDatum", + "range": "#/components/schemas/GsaRangeDatum", + "point": "#/components/schemas/GsaPointDatum", + "picture": "#/components/schemas/GsaPictureDatum", + "file": "#/components/schemas/GsaFileDatum", + "floatFunctional": "#/components/schemas/GsaFloatFunctionalDatum", + "discreteFunctional": "#/components/schemas/GsaDiscreteFunctionalDatum", + "tabular": "#/components/schemas/GsaTabularDatum" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'data'", - "x-discriminator-value": "data", - "x-discriminator-name": "referencedByType" + "description": "\r\n\r\nThis extends: GsaDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * GsaIntegerDatum\r\n * GsaLogicalDatum\r\n * GsaShortTextDatum\r\n * GsaLongTextDatum\r\n * GsaHyperlinkDatum\r\n * GsaDateTimeDatum\r\n * GsaDiscreteDatum\r\n * GsaRangeDatum\r\n * GsaPointDatum\r\n * GsaPictureDatum\r\n * GsaFileDatum\r\n * GsaFloatFunctionalDatum\r\n * GsaDiscreteFunctionalDatum\r\n * GsaTabularDatum", + "x-discriminator-value": "applicable", + "x-discriminator-name": "notApplicable" }, - "GsaDatabase": { + "GsaApplicationsInfo": { + "type": "object", + "properties": { + "applications": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaAttribute": { "required": [ - "isLocked", - "isReadOnly", - "key", - "status", - "userCapabilities" + "defaultThresholdType", + "displayNames", + "guid", + "info", + "isHiddenFromSearchCriteria", + "name", + "table", + "type" ], "type": "object", "properties": { - "author": { - "type": "string", - "nullable": true - }, - "company": { - "type": "string", - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" }, - "notes": { - "type": "string", - "nullable": true + "axisName": { + "$ref": "#/components/schemas/GsaAxisName" }, - "currencyCode": { + "helpPath": { "type": "string", "nullable": true }, - "isAccessControlled": { - "type": "boolean", - "nullable": true - }, - "isImplicitProfileDisabled": { - "type": "boolean", - "description": "When a database is added to the Granta MI system, it automatically has a standalone database Profile known as an implicit Profile.\r\nThe implicit Profile for this database can be disabled by setting this flag.", - "nullable": true + "info": { + "$ref": "#/components/schemas/GsaAttributeInfo" }, - "defaultTable": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "type": { + "$ref": "#/components/schemas/GsaAttributeType" }, - "key": { - "type": "string" + "aboutAttribute": { + "$ref": "#/components/schemas/GsaSlimTypedAttribute" }, - "status": { - "$ref": "#/components/schemas/GsaDatabaseStatus" + "isHiddenFromSearchCriteria": { + "type": "boolean", + "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches." }, - "isReadOnly": { - "type": "boolean" + "table": { + "$ref": "#/components/schemas/GsaSlimEntity" }, - "isLocked": { - "type": "boolean" + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + } }, "name": { - "type": "string", - "nullable": true + "type": "string" }, "guid": { "type": "string", - "format": "uuid", - "nullable": true - }, - "versionGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "indexInSync": { - "type": "boolean", - "nullable": true - }, - "indexUpToDate": { - "type": "boolean", - "nullable": true - }, - "indexOutOfDateDuration": { - "type": "string", - "format": "date-span", - "nullable": true - }, - "schemaVersion": { - "type": "string", - "nullable": true - }, - "userCapabilities": { - "$ref": "#/components/schemas/GsaDatabaseUserCapabilities" + "format": "uuid" + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaPointAttribute\r\n * GsaIntegerAttribute\r\n * GsaRangeAttribute\r\n * GsaLogicalAttribute\r\n * GsaShortTextAttribute\r\n * GsaLongTextAttribute\r\n * GsaDateTimeAttribute\r\n * GsaDiscreteAttribute\r\n * GsaHyperlinkAttribute\r\n * GsaFileAttribute\r\n * GsaPictureAttribute\r\n * GsaTabularAttribute\r\n * GsaFloatFunctionalAttribute\r\n * GsaDiscreteFunctionalAttribute\r\n * GsaMathsFunctionalAttribute", + "discriminator": { + "propertyName": "type", + "mapping": { + "point": "#/components/schemas/GsaPointAttribute", + "integer": "#/components/schemas/GsaIntegerAttribute", + "range": "#/components/schemas/GsaRangeAttribute", + "logical": "#/components/schemas/GsaLogicalAttribute", + "shortText": "#/components/schemas/GsaShortTextAttribute", + "longText": "#/components/schemas/GsaLongTextAttribute", + "dateTime": "#/components/schemas/GsaDateTimeAttribute", + "discrete": "#/components/schemas/GsaDiscreteAttribute", + "hyperlink": "#/components/schemas/GsaHyperlinkAttribute", + "file": "#/components/schemas/GsaFileAttribute", + "picture": "#/components/schemas/GsaPictureAttribute", + "link": "#/components/schemas/GsaTabularAttribute", + "floatFunctional": "#/components/schemas/GsaFloatFunctionalAttribute", + "discreteFunctional": "#/components/schemas/GsaDiscreteFunctionalAttribute", + "mathsFunctional": "#/components/schemas/GsaMathsFunctionalAttribute" + } + } + }, + "GsaAttributeAggregation": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregation" }, - "configurationDetails": { - "$ref": "#/components/schemas/GsaConfigurationDetails" + { + "required": [ + "attributeAggregationType" + ], + "type": "object", + "properties": { + "attributeIdentity": { + "type": "integer", + "description": "The identity of the attribute that was aggregated over.", + "format": "int32", + "nullable": true + }, + "attributeGuid": { + "type": "string", + "description": "The GUID of the attribute that was aggregated over.", + "format": "uuid", + "nullable": true + }, + "attributeAggregationType": { + "$ref": "#/components/schemas/GsaAttributeAggregationType" + }, + "count": { + "type": "integer", + "description": "The number of records that have a populated (applicable) value for this attribute.\r\n(For multi-valued attributes: the number of records that have one or more populated\r\n(applicable) values for this attribute.)\r\n \r\nFor a tabular attribute, this will be the number of records that have at least one\r\ntabular row in this attribute, even if those rows might be filtered out from users'\r\nviews in some clients.", + "format": "int32" + } + }, + "discriminator": { + "propertyName": "attributeAggregationType", + "mapping": { + "value": "#/components/schemas/GsaAttributeValueAggregation", + "exists": "#/components/schemas/GsaAttributeExistsAggregation" + } + } + } + ], + "additionalProperties": false, + "description": "The results of aggregation over an attribute. In all cases this will report the number of records in\r\nthe aggregation scope that have a value for the attribute. In some cases, depending on the attribute\r\ntype, we may be able to report more information. For example, aggregating over a numeric attribute will\r\nalso provide the minimum and maximum values that attribute takes across records in the aggregation\r\nscope.\r\n\r\nThis extends: GsaAggregation\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * GsaAttributeValueAggregation\r\n * GsaAttributeExistsAggregation", + "x-discriminator-value": "attribute", + "x-discriminator-name": "type" + }, + "GsaAttributeAggregationCriterion": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregationCriterion" }, - "issues": { - "$ref": "#/components/schemas/GsaDatabaseIssues" + { + "required": [ + "attributeAggregationCriterionType" + ], + "type": "object", + "properties": { + "identity": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "guid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "isMetaAttribute": { + "type": "boolean" + }, + "attributeAggregationCriterionType": { + "$ref": "#/components/schemas/GsaAttributeAggregationType" + } + }, + "discriminator": { + "propertyName": "attributeAggregationCriterionType", + "mapping": { + "value": "#/components/schemas/GsaAttributeAggregationValueCriterion", + "exists": "#/components/schemas/GsaAttributeAggregationExistsCriterion" + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute. Exactly one of the identity or GUID must be provided.\r\n\r\nThis extends: GsaAggregationCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * GsaAttributeAggregationValueCriterion\r\n * GsaAttributeAggregationExistsCriterion", + "x-discriminator-value": "attribute", + "x-discriminator-name": "type" }, - "GsaDatabaseAccessControlEntity": { + "GsaAttributeAggregationExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlEntity" + "$ref": "#/components/schemas/GsaAttributeAggregationCriterion" }, { - "type": "object" + "required": [ + "innerCriterion" + ], + "type": "object", + "properties": { + "innerCriterion": { + "$ref": "#/components/schemas/GsaAggregationDatumExistsCriterion" + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlEntity](#model-GsaAccessControlEntity)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'database'", - "x-discriminator-value": "database", - "x-discriminator-name": "entityType" + "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute.\r\n\r\nThis extends: GsaAttributeAggregationCriterion\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'exists'", + "x-discriminator-value": "exists", + "x-discriminator-name": "attributeAggregationCriterionType" }, - "GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail": { + "GsaAttributeAggregationType": { + "enum": [ + "value", + "exists" + ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • value: Attribute aggregation value type
    • \r\n
  • exists: Attribute aggregation exists type
    • \r\n
\r\n" + }, + "GsaAttributeAggregationValueCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "$ref": "#/components/schemas/GsaAttributeAggregationCriterion" }, { - "type": "object" + "type": "object", + "properties": { + "innerCriterion": { + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'databaseCurrencyUnit'", - "x-discriminator-value": "databaseCurrencyUnit", - "x-discriminator-name": "referencedByType" + "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute,\r\nincluding summary information about the values assumed by the attribute.\r\n \r\nFor a numeric attribute (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the attribute on some record.\r\n \r\nFor a simple text attribute (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that attribute.\r\n \r\nThis can also be used within the inner criteria of a 'link' attribute aggregation, to request\r\nan aggregation over a local tabular column.\r\n\r\nThis extends: GsaAttributeAggregationCriterion\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'value'", + "x-discriminator-value": "value", + "x-discriminator-name": "attributeAggregationCriterionType" }, - "GsaDatabaseIssues": { - "required": [ - "databaseRevisionIdentityHasDecreased" - ], + "GsaAttributeCreationException": { "type": "object", "properties": { - "databaseRevisionIdentityHasDecreased": { - "type": "boolean" + "message": { + "type": "string", + "nullable": true }, - "loadingExceptionInfo": { - "$ref": "#/components/schemas/GsaExceptionInformation" + "code": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAttributeErrorDetail" + }, + "nullable": true } }, "additionalProperties": false }, - "GsaDatabaseKeyProperty": { + "GsaAttributeCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaProperty" + "$ref": "#/components/schemas/GsaCriterion" }, { + "required": [ + "attributeCriterionType" + ], "type": "object", "properties": { - "databaseKey": { + "identity": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "guid": { "type": "string", + "format": "uuid", "nullable": true + }, + "isMetaAttribute": { + "type": "boolean" + }, + "attributeCriterionType": { + "$ref": "#/components/schemas/GsaAttributeCriterionType" + } + }, + "discriminator": { + "propertyName": "attributeCriterionType", + "mapping": { + "matches": "#/components/schemas/GsaAttributeMatchesCriterion", + "exists": "#/components/schemas/GsaAttributeExistsCriterion", + "notApplicable": "#/components/schemas/GsaAttributeNotApplicableCriterion" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'databaseKey'", - "x-discriminator-value": "databaseKey", - "x-discriminator-name": "propertyName" + "description": "Base class for attribute criterions. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * GsaAttributeMatchesCriterion\r\n * GsaAttributeExistsCriterion\r\n * GsaAttributeNotApplicableCriterion", + "x-discriminator-value": "attribute", + "x-discriminator-name": "type" }, - "GsaDatabaseSecurityGroups": { - "required": [ - "adminGroup", - "databaseKey", - "grantGroup", - "powerUserGroup", - "readGroup", - "writeGroup" + "GsaAttributeCriterionType": { + "enum": [ + "matches", + "exists", + "notApplicable" ], + "type": "string" + }, + "GsaAttributeDeletionException": { "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, - "adminGroup": { - "type": "string" - }, - "grantGroup": { - "type": "string" - }, - "powerUserGroup": { - "type": "string" + "message": { + "type": "string", + "nullable": true }, - "writeGroup": { - "type": "string" + "code": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, - "readGroup": { - "type": "string" + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataModificationErrorDetail" + }, + "nullable": true } }, - "additionalProperties": false, - "description": "The security groups of a particular database, falling back to global settings for any unfilled groups." + "additionalProperties": false }, - "GsaDatabaseSecurityGroupsInfo": { + "GsaAttributeErrorDetail": { "required": [ - "databaseSecurityGroups" + "message", + "reason" ], "type": "object", "properties": { - "databaseSecurityGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroups" - } + "message": { + "type": "string" + }, + "reason": { + "$ref": "#/components/schemas/GsaAttributeErrorReason" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaAboutAttributeCannotBeMetaAttributeErrorDetail\r\n * GsaDuplicateParameterGuidsAttributeErrorDetail\r\n * GsaEmptyAxisNameAttributeErrorDetail\r\n * GsaFuncNoParamsAttributeErrorDetail\r\n * GsaMathsFunctionalAttributeErrorDetail\r\n * GsaMissingParameterGuidAttributeErrorDetail\r\n * GsaNamedEntityAttributeErrorDetail\r\n * GsaNoSuchEntityAttributeErrorDetail\r\n * GsaPointParametersRequiresMultiValuedAttributeErrorDetail\r\n * GsaTargetAttributeNotInTableAttributeErrorDetail\r\n * GsaTargetAttributeTypeAttributeErrorDetail\r\n * GsaThresholdTypeAttributeErrorDetail\r\n * GsaDuplicateTabularColumnGuidsErrorDetail\r\n * GsaExistingTabularColumnGuidErrorDetail\r\n * GsaTabularColumnNameNotProvidedErrorDetail\r\n * GsaDuplicateTabularColumnNamesErrorDetail\r\n * GsaNoSuchEntityTabularColumnErrorDetail", + "discriminator": { + "propertyName": "reason", + "mapping": { + "aboutAttributeCannotBeMeta": "#/components/schemas/GsaAboutAttributeCannotBeMetaAttributeErrorDetail", + "duplicateParameterGuids": "#/components/schemas/GsaDuplicateParameterGuidsAttributeErrorDetail", + "emptyAxisName": "#/components/schemas/GsaEmptyAxisNameAttributeErrorDetail", + "funcNoParams": "#/components/schemas/GsaFuncNoParamsAttributeErrorDetail", + "mathsFunctional": "#/components/schemas/GsaMathsFunctionalAttributeErrorDetail", + "missingParameterGuid": "#/components/schemas/GsaMissingParameterGuidAttributeErrorDetail", + "namedEntity": "#/components/schemas/GsaNamedEntityAttributeErrorDetail", + "noSuchEntity": "#/components/schemas/GsaNoSuchEntityAttributeErrorDetail", + "pointParametersRequiresMultiValued": "#/components/schemas/GsaPointParametersRequiresMultiValuedAttributeErrorDetail", + "targetAttributeNotInTable": "#/components/schemas/GsaTargetAttributeNotInTableAttributeErrorDetail", + "targetAttributeType": "#/components/schemas/GsaTargetAttributeTypeAttributeErrorDetail", + "thresholdType": "#/components/schemas/GsaThresholdTypeAttributeErrorDetail", + "duplicateTabularColumnGuids": "#/components/schemas/GsaDuplicateTabularColumnGuidsErrorDetail", + "existingTabularColumnGuid": "#/components/schemas/GsaExistingTabularColumnGuidErrorDetail", + "tabularColumnNameNotProvided": "#/components/schemas/GsaTabularColumnNameNotProvidedErrorDetail", + "duplicateTabularColumnNames": "#/components/schemas/GsaDuplicateTabularColumnNamesErrorDetail", + "tabularColumnNoSuchEntity": "#/components/schemas/GsaNoSuchEntityTabularColumnErrorDetail" + } + } }, - "GsaDatabaseStatus": { + "GsaAttributeErrorReason": { "enum": [ - "Unknown", - "Ok", - "Unloaded", - "Loading", - "Unloading", - "FailedToLoad", - "FailedToUnload", - "SchemaUpgradeRequired", - "SchemaDowngradeRequired", - "Missing" + "aboutAttributeCannotBeMeta", + "duplicateParameterGuids", + "emptyAxisName", + "funcNoParams", + "mathsFunctional", + "missingParameterGuid", + "namedEntity", + "noSuchEntity", + "pointParametersRequiresMultiValued", + "targetAttributeNotInTable", + "targetAttributeType", + "thresholdType", + "duplicateTabularColumnGuids", + "existingTabularColumnGuid", + "tabularColumnNameNotProvided", + "duplicateTabularColumnNames", + "tabularColumnNoSuchEntity" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • Unknown: The current state is unknown.
    • \r\n
  • Ok: The database is working correctly.
    • \r\n
  • Unloaded: The database is not loaded.
    • \r\n
  • Loading: The database is currently being loaded.
    • \r\n
  • Unloading: The database is currently being unloaded.
    • \r\n
  • FailedToLoad: The database failed to be loaded.
    • \r\n
  • FailedToUnload: The database failed to be unloaded.
    • \r\n
  • SchemaUpgradeRequired: The database is at a lower version of the database schema than the current software
    • \r\n
  • SchemaDowngradeRequired: The database is at a higher version of the database schema than the current software
    • \r\n
  • Missing: The database is currently missing.
    • \r\n
\r\n" + "type": "string" }, - "GsaDatabaseStatusInformation": { + "GsaAttributeExistsAggregation": { "type": "object", - "properties": { - "databaseKey": { - "type": "string", - "description": "Gets the database key for this database.", - "nullable": true - }, - "databaseIsReadOnly": { - "type": "boolean", - "description": "Gets a value indicating whether the database is read only." - }, - "isLocked": { - "type": "boolean", - "description": "Gets a value indicating whether the database is locked for non-admin users." + "allOf": [ + { + "$ref": "#/components/schemas/GsaAttributeAggregation" }, - "state": { - "$ref": "#/components/schemas/GsaDatabaseStatus" + { + "type": "object" + } + ], + "additionalProperties": false, + "description": "The results of aggregation over an attribute, reporting only the number of records with a value\r\nfor the attribute.\r\n\r\nThis extends: GsaAttributeAggregation\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'exists'", + "x-discriminator-value": "exists", + "x-discriminator-name": "attributeAggregationType" + }, + "GsaAttributeExistsCriterion": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaAttributeCriterion" }, - "schemaVersion": { - "type": "string", - "description": "Gets the schema version of the database.", - "nullable": true + { + "required": [ + "innerCriterion" + ], + "type": "object", + "properties": { + "innerCriterion": { + "$ref": "#/components/schemas/GsaDatumExistsCriterion" + } + } + } + ], + "additionalProperties": false, + "description": "Criterion for matching record where there is data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaAttributeCriterion\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'exists'", + "x-discriminator-value": "exists", + "x-discriminator-name": "attributeCriterionType" + }, + "GsaAttributeExportFailure": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaExportFailure" }, - "searchIndexInSync": { - "type": "boolean", - "description": "Whether the search indexes for this database are in sync with the database changes" + { + "required": [ + "failedAttributes" + ], + "type": "object", + "properties": { + "failedAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAttributeReference" + } + } + } } - }, + ], "additionalProperties": false, - "description": "\r\n\r\nstate: Gets the state of this database." + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", + "x-discriminator-value": "attribute", + "x-discriminator-name": "type" }, - "GsaDatabaseUserCapabilities": { + "GsaAttributeInfo": { "required": [ - "canRead", - "canWrite" + "chartable", + "expressionable", + "extendedName", + "foreignDataLinkGroups", + "isMetaAttribute", + "linkable", + "primaryDataLinkGroups", + "standardNames", + "typeCode" ], "type": "object", "properties": { - "canRead": { + "typeCode": { + "type": "string" + }, + "chartable": { "type": "boolean", - "description": "Specifies whether the current user can read from the database." + "description": "Determines whether or not this attribute is chartable in an X/Y bubble chart." }, - "canWrite": { + "expressionable": { "type": "boolean", - "description": "Specifies whether the current user can write to the database." + "description": "Determines whether or not this attribute can be used in an expression." + }, + "linkable": { + "type": "boolean", + "description": "Determines whether or not this attribute can be linked to from a tabular column." + }, + "extendedName": { + "type": "string" + }, + "isMetaAttribute": { + "type": "boolean" + }, + "orderedMetaAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimTypedAttribute" + }, + "nullable": true + }, + "standardNames": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + }, + "primaryDataLinkGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + }, + "foreignDataLinkGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + }, + "primaryDynamicLinkGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "nullable": true + }, + "foreignDynamicLinkGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "nullable": true } }, "additionalProperties": false }, - "GsaDatabasesInfo": { + "GsaAttributeInterpolationMethod": { + "enum": [ + "auto", + "none", + "linear", + "cubicSpline" + ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • auto: The default interpolation method should be applied.
    • \r\n
  • none: No interpolation should be performed to infer values between data points.
    • \r\n
  • linear: Linear interpolation should be performed to infer values between data points.
    • \r\n
  • cubicSpline: Cubic-spline interpolation should be performed to infer values between data points.
    • \r\n
\r\n" + }, + "GsaAttributeLinkPair": { "type": "object", "properties": { - "databases": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDatabase" - }, - "nullable": true + "attributeSource": { + "$ref": "#/components/schemas/GsaSlimAttribute" + }, + "attributeTarget": { + "$ref": "#/components/schemas/GsaSlimAttribute" } }, "additionalProperties": false }, - "GsaDateTimeAggregation": { + "GsaAttributeMatchesCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatum" + "$ref": "#/components/schemas/GsaAttributeCriterion" }, { + "required": [ + "innerCriterion" + ], "type": "object", "properties": { - "minimum": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "maximum": { - "type": "string", - "format": "date-time", - "nullable": true + "innerCriterion": { + "$ref": "#/components/schemas/GsaDatumCriterion" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", - "x-discriminator-name": "datumType" + "description": "Criterion for a search matching values in a given attribute. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaAttributeCriterion\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'matches'", + "x-discriminator-value": "matches", + "x-discriminator-name": "attributeCriterionType" }, - "GsaDateTimeAggregationDatumCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" - }, - { - "type": "object" - } + "GsaAttributeNoSuchEntityType": { + "enum": [ + "dataRule", + "discreteType", + "parameter", + "unit" ], - "additionalProperties": false, - "description": "Criterion for aggregating data within a datetime attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", - "x-discriminator-name": "type" + "type": "string" }, - "GsaDateTimeAttribute": { + "GsaAttributeNotApplicableCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaAttributeCriterion" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", - "x-discriminator-name": "type" + "description": "Criterion for matching record where there is not applicable data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaAttributeCriterion\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'notApplicable'", + "x-discriminator-value": "notApplicable", + "x-discriminator-name": "attributeCriterionType" }, - "GsaDateTimeDatum": { + "GsaAttributeReference": { + "required": [ + "databaseKey" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaApplicableDatum" + "properties": { + "databaseKey": { + "type": "string" }, - { - "required": [ - "dateTime" - ], - "type": "object", - "properties": { - "dateTime": { - "type": "string", - "format": "date-time" - } - } + "attributeIdentity": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "attributeGuid": { + "type": "string", + "format": "uuid", + "nullable": true } + }, + "additionalProperties": false + }, + "GsaAttributeScaleType": { + "enum": [ + "notSet", + "linear", + "logarithmic" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", - "x-discriminator-name": "datumType" + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • notSet: No scale type has been chosen, the default value should be applied.
    • \r\n
  • linear: Use a linear scale
    • \r\n
  • logarithmic: Use a logarithmic scale
    • \r\n
\r\n" }, - "GsaDateTimeDatumCriterion": { + "GsaAttributeSortCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaSortCriterion" }, { "type": "object", "properties": { - "gte": { - "type": "string", - "description": "Greater than or equal to", - "format": "date-time", + "identity": { + "type": "integer", + "format": "int32", "nullable": true }, - "lte": { + "guid": { "type": "string", - "description": "Less than or equal to", - "format": "date-time", + "format": "uuid", "nullable": true + }, + "attributeType": { + "$ref": "#/components/schemas/GsaAttributeType" + }, + "sortType": { + "$ref": "#/components/schemas/GsaSortType" } } } ], "additionalProperties": false, - "description": "dateTime: Criterion for matching records where the datetime data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", + "description": "Specifies an attribute based sort criterion for a search query. Either the GUID or identity of the sorting attribute must be provided.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: GsaSortCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", + "x-discriminator-value": "attribute", "x-discriminator-name": "type" }, - "GsaDateTimeDatumExistsCriterion": { + "GsaAttributeThresholdType": { + "enum": [ + "exists", + "doesNotExist", + "atLeast", + "atMost", + "equal", + "between", + "isOneOf", + "contains", + "isNot", + "isAllOf", + "none" + ], + "type": "string" + }, + "GsaAttributeToExport": { + "required": [ + "attributeType" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "properties": { + "identity": { + "type": "integer", + "format": "int32", + "nullable": true }, - { - "type": "object" + "guid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "attributeType": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaLinkAttributeToExport\r\n * GsaSimpleAttributeToExport", + "discriminator": { + "propertyName": "attributeType", + "mapping": { + "link": "#/components/schemas/GsaLinkAttributeToExport", + "simple": "#/components/schemas/GsaSimpleAttributeToExport" } + } + }, + "GsaAttributeType": { + "enum": [ + "integer", + "point", + "range", + "logical", + "shortText", + "longText", + "dateTime", + "discrete", + "hyperlink", + "file", + "picture", + "link", + "floatFunctional", + "discreteFunctional", + "mathsFunctional", + "tabular" ], - "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", - "x-discriminator-value": "dateTime", - "x-discriminator-name": "type" + "type": "string", + "description": "The types of attribute that are supported by the API.

Possible values:

\r\n
    \r\n
  • integer: Integer
    • \r\n
  • point: Point
    • \r\n
  • range: Range
    • \r\n
  • logical: Logical
    • \r\n
  • shortText: Short Text
    • \r\n
  • longText: Long Text
    • \r\n
  • dateTime: Date and Time
    • \r\n
  • discrete: Discrete Value
    • \r\n
  • hyperlink: Hyperlink
    • \r\n
  • file: File
    • \r\n
  • picture: Picture
    • \r\n
  • link: Link
    • \r\n
  • floatFunctional: Float functional
    • \r\n
  • discreteFunctional: Discrete functional
    • \r\n
  • mathsFunctional: Maths functional. Also known as Embedded Equations and Logic (EEL).
    • \r\n
  • tabular: Tabular data
    • \r\n
\r\n" }, - "GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion": { + "GsaAttributeUsageDataModificationErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" }, { - "required": [ - "interval" - ], "type": "object", "properties": { - "interval": { - "$ref": "#/components/schemas/GsaCalendarInterval" - }, - "offset": { - "type": "string", - "description": "Optional offset of the lowest bucket boundary, in SI time units. Must be an integer followed by one of the following units: ms (milliseconds), s (seconds), m (minutes), h (hours), d (days). Defaults to 0. Must be less than the interval. Negative offsets (e.g. \"-6h\") are supported", + "referencedBy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimAttribute" + }, "nullable": true } } } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed calendar interval.\r\n\r\ninterval: Fixed size of the resulting histogram buckets, in a calendar interval\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedCalendarWidthHistogram'", - "x-discriminator-value": "dateTimeFixedCalendarWidthHistogram", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'attribute'", + "x-discriminator-value": "attribute", + "x-discriminator-name": "referencedByType" }, - "GsaDateTimeFixedWidthHistogramAggregationDatumCriterion": { + "GsaAttributeValidateResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean", + "description": "Gets whether the provided value was valid based on the attributes data rules." + }, + "hasValidationRules": { + "type": "boolean", + "description": "Gets whether the attribute has any validation rules that were checked." + }, + "valueChanged": { + "type": "boolean", + "description": "Gets whether the provided value was a new value compared to the existing value. Null if no record was provided.", + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaAttributeValueAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaAttributeAggregation" }, { - "required": [ - "interval" - ], "type": "object", "properties": { - "interval": { - "type": "string", - "description": "Fixed size of the resulting histogram buckets, in SI time units. Must be an integer followed by one of the following units: ms (milliseconds), s (seconds), m (minutes), h (hours), d (days)" - }, - "offset": { - "type": "string", - "description": "Optional offset of the lowest bucket boundary, in SI time units. Must be an integer followed by one of the following units: ms (milliseconds), s (seconds), m (minutes), h (hours), d (days). Defaults to 0. Must be less than the interval. Negative offsets (e.g. \"-6h\") are supported", - "nullable": true + "aggregationDatum": { + "$ref": "#/components/schemas/GsaAggregationDatum" } } } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedWidthHistogram'", - "x-discriminator-value": "dateTimeFixedWidthHistogram", - "x-discriminator-name": "type" + "description": "The results of aggregation over an attribute, reporting the number of records that have a value for\r\nthe attribute, plus additional aggregation information about the attribute values. The exact type of\r\nadditional information will depend on the type of attribute.\r\n\r\naggregationDatum: The type of datum associated with this attribute. (Note: a tabular attribute will be listed as type 'link'.)\r\n\r\nThis extends: GsaAttributeAggregation\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'value'", + "x-discriminator-value": "value", + "x-discriminator-name": "attributeAggregationType" }, - "GsaDateTimeHistogram": { + "GsaAttributesInfo": { + "required": [ + "attributes" + ], "type": "object", "properties": { - "buckets": { + "attributes": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDateTimeHistogramBucket" - }, - "nullable": true + "$ref": "#/components/schemas/GsaSlimAttribute" + } } }, "additionalProperties": false }, - "GsaDateTimeHistogramAggregation": { + "GsaAxisName": { + "required": [ + "displayNames", + "name" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAggregationDatum" + "properties": { + "name": { + "type": "string" }, - { + "displayNames": { "type": "object", - "properties": { - "histogram": { - "$ref": "#/components/schemas/GsaDateTimeHistogram" - } + "additionalProperties": { + "type": "string", + "nullable": true } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTimeHistogram'", - "x-discriminator-value": "dateTimeHistogram", - "x-discriminator-name": "datumType" + }, + "additionalProperties": false }, - "GsaDateTimeHistogramAggregationDatumCriterion": { + "GsaBooleanCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaCriterion" }, { "type": "object", "properties": { - "maximumNumberOfBuckets": { - "type": "integer", - "description": "The maximum number of buckets to return.", - "format": "int32" + "all": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCriterion" + }, + "description": "Only records that match all of these criteria are returned.", + "nullable": true + }, + "any": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCriterion" + }, + "description": "Only results that match any of these criteria are returned.", + "nullable": true + }, + "none": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCriterion" + }, + "description": "Only results that match none of these criteria are returned.", + "nullable": true } } } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an datetime attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeHistogram'", - "x-discriminator-value": "dateTimeHistogram", + "description": "boolean: Criterion that wraps other criteria in order to specify how the results should be joined together.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'boolean'", + "x-discriminator-value": "boolean", "x-discriminator-name": "type" }, - "GsaDateTimeHistogramBucket": { + "GsaBoostByGuid": { "type": "object", "properties": { - "lower": { + "guid": { "type": "string", - "format": "date-time" + "format": "uuid" }, - "count": { + "boostFactor": { + "type": "number", + "format": "double" + } + }, + "additionalProperties": false + }, + "GsaBoostByIdentity": { + "type": "object", + "properties": { + "identity": { "type": "integer", "format": "int32" + }, + "boostFactor": { + "type": "number", + "format": "double" } }, "additionalProperties": false }, - "GsaDatum": { + "GsaBulkInfo": { "required": [ - "notApplicable" + "data" ], "type": "object", "properties": { - "notApplicable": { - "type": "string", - "nullable": true + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBulkResponseItem" + } } }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n * [GsaNotApplicableDatum](#model-GsaNotApplicableDatum)", - "discriminator": { - "propertyName": "notApplicable", - "mapping": { - "applicable": "#/components/schemas/GsaApplicableDatum", - "notApplicable": "#/components/schemas/GsaNotApplicableDatum" - } - } + "additionalProperties": false }, - "GsaDatumCriterion": { + "GsaBulkRequest": { "required": [ - "type" + "requests" ], "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/GsaDatumCriterionType" + "requests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBulkRequestItem" + } } }, - "additionalProperties": false, - "description": "Inner criterion of an attribute search criterion. The specific criterion used should match the type of the attribute specified on the outer criterion (Note that there are multiple types that can be used with a discrete attribute, depending on the type of search.)\r\n\r\nThis is one of: \r\n * [GsaDateTimeDatumCriterion](#model-GsaDateTimeDatumCriterion)\r\n * [GsaDiscreteFunctionalRangeDatumCriterion](#model-GsaDiscreteFunctionalRangeDatumCriterion)\r\n * [GsaDiscreteFunctionalValuesDatumCriterion](#model-GsaDiscreteFunctionalValuesDatumCriterion)\r\n * [GsaDiscreteIdentityDatumCriterion](#model-GsaDiscreteIdentityDatumCriterion)\r\n * [GsaDiscreteIdentityValuesDatumCriterion](#model-GsaDiscreteIdentityValuesDatumCriterion)\r\n * [GsaDiscreteGuidDatumCriterion](#model-GsaDiscreteGuidDatumCriterion)\r\n * [GsaDiscreteGuidValuesDatumCriterion](#model-GsaDiscreteGuidValuesDatumCriterion)\r\n * [GsaDiscreteRangeDatumCriterion](#model-GsaDiscreteRangeDatumCriterion)\r\n * [GsaDiscreteTextDatumCriterion](#model-GsaDiscreteTextDatumCriterion)\r\n * [GsaDiscreteTextPrefixDatumCriterion](#model-GsaDiscreteTextPrefixDatumCriterion)\r\n * [GsaDiscreteTextValuesDatumCriterion](#model-GsaDiscreteTextValuesDatumCriterion)\r\n * [GsaFileDatumCriterion](#model-GsaFileDatumCriterion)\r\n * [GsaFilePrefixDatumCriterion](#model-GsaFilePrefixDatumCriterion)\r\n * [GsaFloatFunctionalDatumCriterion](#model-GsaFloatFunctionalDatumCriterion)\r\n * [GsaFloatFunctionalGraphDatumCriterion](#model-GsaFloatFunctionalGraphDatumCriterion)\r\n * [GsaHyperlinkDatumCriterion](#model-GsaHyperlinkDatumCriterion)\r\n * [GsaHyperlinkPrefixDatumCriterion](#model-GsaHyperlinkPrefixDatumCriterion)\r\n * [GsaIntegerDatumCriterion](#model-GsaIntegerDatumCriterion)\r\n * [GsaLinkDatumCriterion](#model-GsaLinkDatumCriterion)\r\n * [GsaLogicalDatumCriterion](#model-GsaLogicalDatumCriterion)\r\n * [GsaLongTextDatumCriterion](#model-GsaLongTextDatumCriterion)\r\n * [GsaLongTextPrefixDatumCriterion](#model-GsaLongTextPrefixDatumCriterion)\r\n * [GsaMathsFunctionalDatumCriterion](#model-GsaMathsFunctionalDatumCriterion)\r\n * [GsaPictureDatumCriterion](#model-GsaPictureDatumCriterion)\r\n * [GsaPointDatumCriterion](#model-GsaPointDatumCriterion)\r\n * [GsaRangeDatumCriterion](#model-GsaRangeDatumCriterion)\r\n * [GsaShortTextDatumCriterion](#model-GsaShortTextDatumCriterion)\r\n * [GsaShortTextPrefixDatumCriterion](#model-GsaShortTextPrefixDatumCriterion)\r\n * [GsaLinkingValueExistsDatumCriterion](#model-GsaLinkingValueExistsDatumCriterion)", - "discriminator": { - "propertyName": "type", - "mapping": { - "dateTime": "#/components/schemas/GsaDateTimeDatumCriterion", - "discreteFunctionalRange": "#/components/schemas/GsaDiscreteFunctionalRangeDatumCriterion", - "discreteFunctionalValues": "#/components/schemas/GsaDiscreteFunctionalValuesDatumCriterion", - "discreteIdentity": "#/components/schemas/GsaDiscreteIdentityDatumCriterion", - "discreteIdentityValues": "#/components/schemas/GsaDiscreteIdentityValuesDatumCriterion", - "discreteGuid": "#/components/schemas/GsaDiscreteGuidDatumCriterion", - "discreteGuidValues": "#/components/schemas/GsaDiscreteGuidValuesDatumCriterion", - "discreteRange": "#/components/schemas/GsaDiscreteRangeDatumCriterion", - "discreteText": "#/components/schemas/GsaDiscreteTextDatumCriterion", - "discreteTextPrefix": "#/components/schemas/GsaDiscreteTextPrefixDatumCriterion", - "discreteTextValues": "#/components/schemas/GsaDiscreteTextValuesDatumCriterion", - "file": "#/components/schemas/GsaFileDatumCriterion", - "filePrefix": "#/components/schemas/GsaFilePrefixDatumCriterion", - "floatFunctionalData": "#/components/schemas/GsaFloatFunctionalDatumCriterion", - "floatFunctionalGraph": "#/components/schemas/GsaFloatFunctionalGraphDatumCriterion", - "hyperlink": "#/components/schemas/GsaHyperlinkDatumCriterion", - "hyperlinkPrefix": "#/components/schemas/GsaHyperlinkPrefixDatumCriterion", - "integer": "#/components/schemas/GsaIntegerDatumCriterion", - "link": "#/components/schemas/GsaLinkDatumCriterion", - "logical": "#/components/schemas/GsaLogicalDatumCriterion", - "longText": "#/components/schemas/GsaLongTextDatumCriterion", - "longTextPrefix": "#/components/schemas/GsaLongTextPrefixDatumCriterion", - "mathsFunctional": "#/components/schemas/GsaMathsFunctionalDatumCriterion", - "picture": "#/components/schemas/GsaPictureDatumCriterion", - "point": "#/components/schemas/GsaPointDatumCriterion", - "range": "#/components/schemas/GsaRangeDatumCriterion", - "shortText": "#/components/schemas/GsaShortTextDatumCriterion", - "shortTextPrefix": "#/components/schemas/GsaShortTextPrefixDatumCriterion", - "smartLinkingValue": "#/components/schemas/GsaLinkingValueExistsDatumCriterion" - } - } + "additionalProperties": false }, - "GsaDatumCriterionType": { + "GsaBulkRequestHttpMethod": { "enum": [ - "dateTime", - "discreteFunctionalRange", - "discreteFunctionalValues", - "discreteIdentity", - "discreteIdentityValues", - "discreteGuid", - "discreteGuidValues", - "discreteRange", - "discreteText", - "discreteTextPrefix", - "discreteTextValues", - "file", - "filePrefix", - "floatFunctionalData", - "floatFunctionalGraph", - "hyperlink", - "hyperlinkPrefix", - "integer", - "link", - "logical", - "longText", - "longTextPrefix", - "mathsFunctional", - "picture", - "point", - "range", - "shortText", - "shortTextPrefix", - "smartLinkingValue" + "GET", + "POST", + "DELETE", + "PATCH", + "PUT" ], "type": "string" }, - "GsaDatumDiscreteRollup": { + "GsaBulkRequestItem": { + "required": [ + "method", + "path" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumRollup" + "properties": { + "path": { + "type": "string", + "description": "The relative path for this request." }, - { - "required": [ - "value" - ], + "method": { + "$ref": "#/components/schemas/GsaBulkRequestHttpMethod" + }, + "body": { "type": "object", - "properties": { - "value": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" - } - } + "description": "The request body. The type of this object depends on the request being sent.\r\nIt should be the same as if this request were being sent separately.", + "nullable": true + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "description": "Any additional headers to set on this request. Headers from the bulk request will also be included.\r\nHeaders set in this field override any headers also set on the bulk request.", + "nullable": true + }, + "query": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "description": "Query string parameters.", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" + }, + "additionalProperties": false }, - "GsaDatumDoubleRollup": { + "GsaBulkResponseItem": { + "required": [ + "status" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumRollup" + "properties": { + "status": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, - { - "required": [ - "value" - ], + "body": { "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" - } - } + "description": "The response body. The type of this object depends on the request being sent.\r\nIt should be the same as if the request were sent separately.", + "nullable": true + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "nullable": true } + }, + "additionalProperties": false + }, + "GsaCalendarInterval": { + "enum": [ + "minute", + "hour", + "day", + "week", + "month", + "quarter", + "year" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", - "x-discriminator-value": "double", - "x-discriminator-name": "type" + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • minute: Minute
    • \r\n
  • hour: Hour
    • \r\n
  • day: Day
    • \r\n
  • week: Week
    • \r\n
  • month: Month
    • \r\n
  • quarter: Quarter
    • \r\n
  • year: Year
    • \r\n
\r\n" }, - "GsaDatumExistsCriterion": { + "GsaConfiguration": { "required": [ - "type" + "guid", + "name" ], "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/GsaAttributeType" + "description": { + "type": "string", + "nullable": true + }, + "value": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, - "additionalProperties": false, - "description": "Inner criterion of an attribute search criterion for when the only bit of information about the datum that we want to convey is its type\r\nFor link datum types, linking information must also be provided.\r\n\r\nThis is one of: \r\n * [GsaIntegerDatumExistsCriterion](#model-GsaIntegerDatumExistsCriterion)\r\n * [GsaPointDatumExistsCriterion](#model-GsaPointDatumExistsCriterion)\r\n * [GsaRangeDatumExistsCriterion](#model-GsaRangeDatumExistsCriterion)\r\n * [GsaLogicalDatumExistsCriterion](#model-GsaLogicalDatumExistsCriterion)\r\n * [GsaShortTextDatumExistsCriterion](#model-GsaShortTextDatumExistsCriterion)\r\n * [GsaLongTextDatumExistsCriterion](#model-GsaLongTextDatumExistsCriterion)\r\n * [GsaDateTimeDatumExistsCriterion](#model-GsaDateTimeDatumExistsCriterion)\r\n * [GsaDiscreteDatumExistsCriterion](#model-GsaDiscreteDatumExistsCriterion)\r\n * [GsaHyperlinkDatumExistsCriterion](#model-GsaHyperlinkDatumExistsCriterion)\r\n * [GsaFileDatumExistsCriterion](#model-GsaFileDatumExistsCriterion)\r\n * [GsaPictureDatumExistsCriterion](#model-GsaPictureDatumExistsCriterion)\r\n * [GsaLinkExistsDatumCriterion](#model-GsaLinkExistsDatumCriterion)\r\n * [GsaFloatFunctionalDatumExistsCriterion](#model-GsaFloatFunctionalDatumExistsCriterion)\r\n * [GsaDiscreteFunctionalDatumExistsCriterion](#model-GsaDiscreteFunctionalDatumExistsCriterion)\r\n * [GsaMathsFunctionalDatumExistsCriterion](#model-GsaMathsFunctionalDatumExistsCriterion)\r\n * [GsaTabularDatumExistsCriterion](#model-GsaTabularDatumExistsCriterion)", - "discriminator": { - "propertyName": "type", - "mapping": { - "integer": "#/components/schemas/GsaIntegerDatumExistsCriterion", - "point": "#/components/schemas/GsaPointDatumExistsCriterion", - "range": "#/components/schemas/GsaRangeDatumExistsCriterion", - "logical": "#/components/schemas/GsaLogicalDatumExistsCriterion", - "shortText": "#/components/schemas/GsaShortTextDatumExistsCriterion", - "longText": "#/components/schemas/GsaLongTextDatumExistsCriterion", - "dateTime": "#/components/schemas/GsaDateTimeDatumExistsCriterion", - "discrete": "#/components/schemas/GsaDiscreteDatumExistsCriterion", - "hyperlink": "#/components/schemas/GsaHyperlinkDatumExistsCriterion", - "file": "#/components/schemas/GsaFileDatumExistsCriterion", - "picture": "#/components/schemas/GsaPictureDatumExistsCriterion", - "link": "#/components/schemas/GsaLinkExistsDatumCriterion", - "floatFunctional": "#/components/schemas/GsaFloatFunctionalDatumExistsCriterion", - "discreteFunctional": "#/components/schemas/GsaDiscreteFunctionalDatumExistsCriterion", - "mathsFunctional": "#/components/schemas/GsaMathsFunctionalDatumExistsCriterion", - "tabular": "#/components/schemas/GsaTabularDatumExistsCriterion" + "additionalProperties": false + }, + "GsaConfigurationsInfo": { + "required": [ + "configurations" + ], + "type": "object", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimConfiguration" + } } - } + }, + "additionalProperties": false }, - "GsaDatumExportFailure": { + "GsaConnectionDetails": { + "required": [ + "dataSource", + "initialCatalog" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaExportFailure" + "properties": { + "dataSource": { + "type": "string", + "description": "The SQL server data source" }, - { - "required": [ - "failedDatum" - ], - "type": "object", - "properties": { - "failedDatum": { - "$ref": "#/components/schemas/GsaDatumReference" - } - } + "useIntegratedSecurity": { + "type": "boolean", + "description": "Set to true if the SQL connection to the new database should use Windows authentication", + "nullable": true + }, + "sqlUsername": { + "type": "string", + "description": "The username to use if the new database should use SQL authentication. The password must also be provided.", + "nullable": true + }, + "sqlPassword": { + "type": "string", + "description": "The password to use if the new database should use SQL authentication. The username must also be provided.", + "nullable": true + }, + "initialCatalog": { + "type": "string", + "description": "The name of the database in SQL server" + }, + "additionalSqlParameters": { + "type": "string", + "description": "(Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format.", + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaConstant": { + "required": [ + "guid", + "name", + "value" + ], + "type": "object", + "properties": { + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" + }, + "value": { + "type": "number", + "format": "double" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'datum'", - "x-discriminator-value": "datum", - "x-discriminator-name": "type" + "description": "Constant used in equations" }, - "GsaDatumIntegerRollup": { + "GsaConstantDeletionException": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumRollup" + "properties": { + "message": { + "type": "string", + "nullable": true }, - { - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "integer", - "format": "int32" - } - } + "code": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataModificationErrorDetail" + }, + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "type" + }, + "additionalProperties": false }, - "GsaDatumListRollup": { + "GsaConstantsInfo": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumRollup" + "properties": { + "constants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimConstant" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaContinuousRange": { + "type": "object", + "properties": { + "lowValue": { + "type": "number", + "format": "double", + "nullable": true }, - { - "required": [ - "listRollupDatums" - ], - "type": "object", - "properties": { - "listRollupDatums": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListRollupDatum" - } - } - } + "highValue": { + "type": "number", + "format": "double", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'list'", - "x-discriminator-value": "list", - "x-discriminator-name": "type" + }, + "additionalProperties": false }, - "GsaDatumReference": { + "GsaCopyRecordHistory": { "required": [ - "attributeIdentity", - "databaseKey", - "recordHistoryGuid" + "subsetOption" ], "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, - "recordHistoryGuid": { - "type": "string", - "format": "uuid" + "newParent": { + "$ref": "#/components/schemas/GsaSlimRecordHistory" }, - "attributeIdentity": { - "type": "integer", - "format": "int32" + "subsetOption": { + "$ref": "#/components/schemas/GsaRecordPropertyInheritanceType" }, - "attributeGuid": { + "newShortName": { "type": "string", - "format": "uuid", "nullable": true } }, "additionalProperties": false }, - "GsaDatumRollup": { + "GsaCreateAttribute": { "required": [ + "name", "type" ], "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/GsaDatumRollupType" + "$ref": "#/components/schemas/GsaAttributeType" + }, + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + }, + "helpPath": { + "type": "string", + "nullable": true + }, + "isHiddenFromSearchCriteria": { + "type": "boolean", + "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches.\r\nIf not specified, it will be set to the default value for the attribute type.", + "nullable": true + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDatumListRollup](#model-GsaDatumListRollup)\r\n * [GsaDatumIntegerRollup](#model-GsaDatumIntegerRollup)\r\n * [GsaDatumDoubleRollup](#model-GsaDatumDoubleRollup)\r\n * [GsaDatumDiscreteRollup](#model-GsaDatumDiscreteRollup)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreatePointAttribute\r\n * GsaCreateIntegerAttribute\r\n * GsaCreateRangeAttribute\r\n * GsaCreateLogicalAttribute\r\n * GsaCreateShortTextAttribute\r\n * GsaCreateLongTextAttribute\r\n * GsaCreateDateTimeAttribute\r\n * GsaCreateDiscreteAttribute\r\n * GsaCreateHyperlinkAttribute\r\n * GsaCreateFileAttribute\r\n * GsaCreatePictureAttribute\r\n * GsaCreateTabularAttribute\r\n * GsaCreateFloatFunctionalAttribute\r\n * GsaCreateDiscreteFunctionalAttribute\r\n * GsaCreateMathsFunctionalAttribute", "discriminator": { "propertyName": "type", "mapping": { - "list": "#/components/schemas/GsaDatumListRollup", - "integer": "#/components/schemas/GsaDatumIntegerRollup", - "double": "#/components/schemas/GsaDatumDoubleRollup", - "discrete": "#/components/schemas/GsaDatumDiscreteRollup" + "point": "#/components/schemas/GsaCreatePointAttribute", + "integer": "#/components/schemas/GsaCreateIntegerAttribute", + "range": "#/components/schemas/GsaCreateRangeAttribute", + "logical": "#/components/schemas/GsaCreateLogicalAttribute", + "shortText": "#/components/schemas/GsaCreateShortTextAttribute", + "longText": "#/components/schemas/GsaCreateLongTextAttribute", + "dateTime": "#/components/schemas/GsaCreateDateTimeAttribute", + "discrete": "#/components/schemas/GsaCreateDiscreteAttribute", + "hyperlink": "#/components/schemas/GsaCreateHyperlinkAttribute", + "file": "#/components/schemas/GsaCreateFileAttribute", + "picture": "#/components/schemas/GsaCreatePictureAttribute", + "link": "#/components/schemas/GsaCreateTabularAttribute", + "floatFunctional": "#/components/schemas/GsaCreateFloatFunctionalAttribute", + "discreteFunctional": "#/components/schemas/GsaCreateDiscreteFunctionalAttribute", + "mathsFunctional": "#/components/schemas/GsaCreateMathsFunctionalAttribute" } } }, - "GsaDatumRollupType": { - "enum": [ - "list", - "integer", - "double", - "discrete" - ], - "type": "string", - "description": "The datum rollups supported by the API.

Possible values:

\r\n
    \r\n
  • list: List datum rollup
    • \r\n
  • integer: Integer datum rollup
    • \r\n
  • double: Double datum rollup
    • \r\n
  • discrete: Discrete datum rollup
    • \r\n
\r\n" - }, - "GsaDatumType": { - "enum": [ - "integer", - "logical", - "shortText", - "longText", - "hyperlink", - "dateTime", - "discrete", - "range", - "point", - "picture", - "file", - "floatFunctional", - "discreteFunctional", - "tabular" + "GsaCreateAttributeLinkPair": { + "required": [ + "attributeSourceGuid", + "attributeTargetGuid" ], - "type": "string", - "description": "The types of datum that are supported by the API.

Possible values:

\r\n
    \r\n
  • integer: Integer
    • \r\n
  • logical: Logical
    • \r\n
  • shortText: Short Text
    • \r\n
  • longText: Integer
    • \r\n
  • hyperlink: Integer
    • \r\n
  • dateTime: Date and Time
    • \r\n
  • discrete: Discrete
    • \r\n
  • range: Range
    • \r\n
  • point: Point
    • \r\n
  • picture: Picture
    • \r\n
  • file: File
    • \r\n
  • floatFunctional: Float Functional
    • \r\n
  • discreteFunctional: Discrete Functional
    • \r\n
  • tabular: Tabular
    • \r\n
\r\n" - }, - "GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "properties": { + "attributeSourceGuid": { + "type": "string", + "format": "uuid" }, - { - "type": "object" + "attributeTargetGuid": { + "type": "string", + "format": "uuid" } - ], - "additionalProperties": false, - "description": "Default expression must be from attribute's expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultExpressionNotFound'", - "x-discriminator-value": "defaultExpressionNotFound", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaDefaultFallbackSecurityGroups": { + "GsaCreateAxisName": { "required": [ - "adminGroup", - "grantGroup", - "powerUserGroup", - "readGroup", - "systemGroup", - "writeGroup" + "name" ], "type": "object", "properties": { - "systemGroup": { + "name": { "type": "string" + } + }, + "additionalProperties": false + }, + "GsaCreateConfiguration": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "description": { + "type": "string", + "nullable": true }, - "adminGroup": { + "value": { "type": "string" }, - "grantGroup": { + "name": { "type": "string" }, - "powerUserGroup": { - "type": "string" + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaCreateConstant": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "unitGuid": { + "type": "string", + "format": "uuid", + "nullable": true }, - "writeGroup": { - "type": "string" + "value": { + "type": "number", + "format": "double" }, - "readGroup": { + "name": { "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false }, - "GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail": { + "GsaCreateContinuousRange": { + "required": [ + "highValue", + "lowValue" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "properties": { + "lowValue": { + "type": "number", + "format": "double" }, - { - "type": "object" + "highValue": { + "type": "number", + "format": "double" } - ], - "additionalProperties": false, - "description": "Default free parameter must be from attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultFreeParameterNotFound'", - "x-discriminator-value": "defaultFreeParameterNotFound", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaDefaultLayoutGuidErrorDetail": { + "GsaCreateCrossDatabaseRecordLinkGroup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTableErrorDetail" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, { "type": "object", "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "layoutGuid": { - "type": "string", - "format": "uuid" + "includeIndirectLinks": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultLayoutGuid'", - "x-discriminator-value": "defaultLayoutGuid", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaCreateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", + "x-discriminator-value": "crossDatabase", + "x-discriminator-name": "type" }, - "GsaDefaultParameterValueGuidParameterErrorDetail": { + "GsaCreateDataRule": { + "required": [ + "description", + "name", + "regularExpression" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "properties": { + "description": { + "type": "string" }, - { - "type": "object", - "properties": { - "defaultParameterValueGuid": { - "type": "string", - "format": "uuid" - } - } + "regularExpression": { + "type": "string" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } - ], - "additionalProperties": false, - "description": "Default parameter value GUID does not match any parameter value.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueGuid'", - "x-discriminator-value": "defaultParameterValueGuid", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaDefaultParameterValueIndexAndGuidParameterErrorDetail": { + "GsaCreateDateTimeAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { "type": "object" } ], "additionalProperties": false, - "description": "Default parameter value can be specified by either index or GUID, not both.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueIndexAndGuid'", - "x-discriminator-value": "defaultParameterValueIndexAndGuid", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", + "x-discriminator-name": "type" }, - "GsaDefaultParameterValueIndexParameterErrorDetail": { + "GsaCreateDiscreteAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { + "required": [ + "discreteType" + ], "type": "object", "properties": { - "defaultParameterValueIndex": { - "type": "integer", - "format": "int32" + "discreteType": { + "$ref": "#/components/schemas/GsaSlimEntity" }, - "numberOfParameterValues": { - "type": "integer", - "format": "int32" + "isMultiValued": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "Default parameter value index out of range.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueIndex'", - "x-discriminator-value": "defaultParameterValueIndex", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail": { + "GsaCreateDiscreteFunctionalAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { - "type": "object" + "required": [ + "attributeParameters", + "discreteType" + ], + "type": "object", + "properties": { + "discreteType": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "attributeParameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeParameter" + } + } + } } ], "additionalProperties": false, - "description": "Default parameter value index can only be used when values are being updated.\r\nUse DefaultParameterValueGuid when values are not being updated.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueIndexWithoutValues'", - "x-discriminator-value": "defaultParameterValueIndexWithoutValues", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "x-discriminator-value": "discreteFunctional", + "x-discriminator-name": "type" }, - "GsaDefaultParameterValueUsageDataModificationErrorDetail": { + "GsaCreateDiscreteFunctionalAttributeDiscreteParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "$ref": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeParameter" }, { "type": "object", "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true + "defaultValue": { + "$ref": "#/components/schemas/GsaSlimEntity" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'defaultParameterValue'", - "x-discriminator-value": "defaultParameterValue", - "x-discriminator-name": "referencedByType" + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaCreateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaDefaultSubsetGuidErrorDetail": { + "GsaCreateDiscreteFunctionalAttributeNumericParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTableErrorDetail" + "$ref": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeParameter" }, { "type": "object", "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "subsetGuid": { - "type": "string", - "format": "uuid" + "defaultValue": { + "type": "number", + "description": "If there is no default value, fallback to the parameter default.", + "format": "double", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultSubsetGuid'", - "x-discriminator-value": "defaultSubsetGuid", - "x-discriminator-name": "reason" - }, - "GsaDeleteRecordListItem": { - "required": [ - "databaseGuid", - "recordHistoryGuid" - ], - "type": "object", - "properties": { - "databaseGuid": { - "type": "string", - "format": "uuid" - }, - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "recordVersion": { - "type": "integer", - "description": "Optional version. If not provided, only matching items with no version will be deleted. If provided, only items matching the version exactly will be deleted.", - "format": "int32", - "nullable": true - } - }, - "additionalProperties": false + "description": "\r\n\r\nThis extends: GsaCreateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" }, - "GsaDeleteRecordListItems": { + "GsaCreateDiscreteFunctionalAttributeParameter": { "required": [ - "items" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDeleteRecordListItem" - } - } - }, - "additionalProperties": false - }, - "GsaDeletionEntityType": { - "enum": [ - "attribute", - "constant", - "dataUpdate", - "discreteType", - "expression", "parameter", - "parameterValue", - "table", - "unit", - "qualitySystem" - ], - "type": "string" - }, - "GsaDeletionException": { - "required": [ - "entityGuid", - "entityType" + "type" ], "type": "object", "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "entityType": { - "$ref": "#/components/schemas/GsaDeletionEntityType" - }, - "entityGuid": { - "type": "string", - "format": "uuid" + "type": { + "$ref": "#/components/schemas/GsaParameterType" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataModificationErrorDetail" - }, - "nullable": true + "parameter": { + "$ref": "#/components/schemas/GsaSlimEntity" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAttributeDeletionException](#model-GsaAttributeDeletionException)\r\n * [GsaConstantDeletionException](#model-GsaConstantDeletionException)\r\n * [GsaDataUpdateDeletionException](#model-GsaDataUpdateDeletionException)\r\n * [GsaDiscreteTypeDeletionException](#model-GsaDiscreteTypeDeletionException)\r\n * [GsaExpressionDeletionException](#model-GsaExpressionDeletionException)\r\n * [GsaParameterDeletionException](#model-GsaParameterDeletionException)\r\n * [GsaParameterValueDeletionException](#model-GsaParameterValueDeletionException)\r\n * [GsaTableDeletionException](#model-GsaTableDeletionException)\r\n * [GsaUnitDeletionException](#model-GsaUnitDeletionException)\r\n * [GsaQualitySystemDeletionException](#model-GsaQualitySystemDeletionException)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaCreateDiscreteFunctionalAttributeNumericParameter", "discriminator": { - "propertyName": "entityType", + "propertyName": "type", "mapping": { - "attribute": "#/components/schemas/GsaAttributeDeletionException", - "constant": "#/components/schemas/GsaConstantDeletionException", - "dataUpdate": "#/components/schemas/GsaDataUpdateDeletionException", - "discreteType": "#/components/schemas/GsaDiscreteTypeDeletionException", - "expression": "#/components/schemas/GsaExpressionDeletionException", - "parameter": "#/components/schemas/GsaParameterDeletionException", - "parameterValue": "#/components/schemas/GsaParameterValueDeletionException", - "table": "#/components/schemas/GsaTableDeletionException", - "unit": "#/components/schemas/GsaUnitDeletionException", - "qualitySystem": "#/components/schemas/GsaQualitySystemDeletionException" + "discrete": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeDiscreteParameter", + "numeric": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeNumericParameter" } } }, - "GsaDescriptionLengthFileErrorDetail": { + "GsaCreateDiscreteParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFileErrorDetail" + "$ref": "#/components/schemas/GsaCreateParameter" }, { + "required": [ + "values" + ], "type": "object", "properties": { - "maxLengthOfFileDescription": { - "type": "integer", - "format": "int32" + "values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCreateDiscreteParameterValue" + } } } } ], "additionalProperties": false, - "description": "The description exceeds the maximum number of allowed characters.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'descriptionLength'", - "x-discriminator-value": "descriptionLength", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaCreateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaDiscreteAttribute": { + "GsaCreateDiscreteParameterContent": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaCreateParameterContent" }, { - "required": [ - "discreteType", - "isMultiValued" - ], "type": "object", "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "parameterValue": { + "$ref": "#/components/schemas/GsaSlimEntity" }, - "isMultiValued": { - "type": "boolean" + "parameterRange": { + "$ref": "#/components/schemas/GsaCreateDiscreteRange" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaCreateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, - "GsaDiscreteChartData": { + "GsaCreateDiscreteParameterValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaChartData" + "$ref": "#/components/schemas/GsaCreateParameterValue" }, { - "type": "object", - "properties": { - "order": { - "type": "integer", - "format": "int32" - }, + "required": [ + "name" + ], + "type": "object", + "properties": { "name": { - "type": "string", - "nullable": true + "type": "string" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaCreateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, - "GsaDiscreteDatum": { + "GsaCreateDiscreteRange": { + "required": [ + "parameterValues" + ], + "type": "object", + "properties": { + "parameterValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimEntity" + } + } + }, + "additionalProperties": false + }, + "GsaCreateDiscreteType": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "isOrdered": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaCreateDynamicRecordLinkGroup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaApplicableDatum" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, { "required": [ - "discreteValues" + "attributePairs" ], "type": "object", "properties": { - "discreteValues": { + "forbidOrphans": { + "type": "boolean" + }, + "referentialIntegrityModel": { + "$ref": "#/components/schemas/GsaReferentialIntegrityModel" + }, + "attributePairs": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" } } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "datumType" + "description": "\r\n\r\nThis extends: GsaCreateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamic'", + "x-discriminator-value": "dynamic", + "x-discriminator-name": "type" }, - "GsaDiscreteDatumExistsCriterion": { + "GsaCreateExpression": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaCreateFileAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { "type": "object" } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "x-discriminator-value": "file", "x-discriminator-name": "type" }, - "GsaDiscreteFunctionalAttribute": { + "GsaCreateFloatFunctionalAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { "required": [ - "attributeParameters", - "discreteType" + "attributeParameters" ], "type": "object", "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "axisName": { + "$ref": "#/components/schemas/GsaCreateAxisName" }, "attributeParameters": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter" + "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter" } + }, + "isRange": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", - "x-discriminator-value": "discreteFunctional", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "x-discriminator-value": "floatFunctional", "x-discriminator-name": "type" }, - "GsaDiscreteFunctionalAttributeDiscreteParameter": { + "GsaCreateFloatFunctionalAttributeDiscreteParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter" + "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter" }, { "type": "object", "properties": { "defaultValue": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "$ref": "#/components/schemas/GsaSlimEntity" } } } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaDiscreteFunctionalAttributeParameter](#model-GsaDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaCreateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, - "GsaDiscreteFunctionalAttributeNumericParameter": { + "GsaCreateFloatFunctionalAttributeNumericParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter" + "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter" }, { "type": "object", @@ -102729,16 +68130,22 @@ "description": "If there is no default value, fallback to the parameter default.", "format": "double", "nullable": true + }, + "interpolationMethod": { + "$ref": "#/components/schemas/GsaAttributeInterpolationMethod" + }, + "scaleType": { + "$ref": "#/components/schemas/GsaAttributeScaleType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteFunctionalAttributeParameter](#model-GsaDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: GsaCreateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, - "GsaDiscreteFunctionalAttributeParameter": { + "GsaCreateFloatFunctionalAttributeParameter": { "required": [ "parameter", "type" @@ -102749,787 +68156,669 @@ "$ref": "#/components/schemas/GsaParameterType" }, "parameter": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "$ref": "#/components/schemas/GsaSlimEntity" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteFunctionalAttributeDiscreteParameter](#model-GsaDiscreteFunctionalAttributeDiscreteParameter)\r\n * [GsaDiscreteFunctionalAttributeNumericParameter](#model-GsaDiscreteFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateFloatFunctionalAttributeDiscreteParameter\r\n * GsaCreateFloatFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { - "discrete": "#/components/schemas/GsaDiscreteFunctionalAttributeDiscreteParameter", - "numeric": "#/components/schemas/GsaDiscreteFunctionalAttributeNumericParameter" + "discrete": "#/components/schemas/GsaCreateFloatFunctionalAttributeDiscreteParameter", + "numeric": "#/components/schemas/GsaCreateFloatFunctionalAttributeNumericParameter" } } }, - "GsaDiscreteFunctionalDatum": { + "GsaCreateFolder": { + "required": [ + "name", + "parentGuid" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaApplicableDatum" + "properties": { + "parentGuid": { + "type": "string", + "format": "uuid" }, - { - "required": [ - "graphType", - "parameterSettings" - ], - "type": "object", - "properties": { - "graphType": { - "$ref": "#/components/schemas/GsaGraphType" - }, - "parameterSettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFunctionalParameterSetting" - } - } - }, - "discriminator": { - "propertyName": "graphType", - "mapping": { - "series": "#/components/schemas/GsaDiscreteFunctionalSeriesDatum", - "grid": "#/components/schemas/GsaDiscreteFunctionalGridDatum" - } - } + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * [GsaDiscreteFunctionalSeriesDatum](#model-GsaDiscreteFunctionalSeriesDatum)\r\n * [GsaDiscreteFunctionalGridDatum](#model-GsaDiscreteFunctionalGridDatum)", - "x-discriminator-value": "discreteFunctional", - "x-discriminator-name": "datumType" + }, + "additionalProperties": false }, - "GsaDiscreteFunctionalDatumExistsCriterion": { + "GsaCreateHyperlinkAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { "type": "object" } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", - "x-discriminator-value": "discreteFunctional", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "x-discriminator-value": "hyperlink", "x-discriminator-name": "type" }, - "GsaDiscreteFunctionalGridDatum": { + "GsaCreateIntegerAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteFunctionalDatum" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { - "required": [ - "graph" - ], "type": "object", "properties": { - "graph": { - "$ref": "#/components/schemas/GsaDiscreteGridGraph" + "isUnique": { + "type": "boolean", + "description": "Whether or not the attribute is constrained to contain a unique value" + }, + "axisName": { + "$ref": "#/components/schemas/GsaCreateAxisName" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteFunctionalDatum](#model-GsaDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", - "x-discriminator-value": "grid", - "x-discriminator-name": "graphType" + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "x-discriminator-value": "integer", + "x-discriminator-name": "type" }, - "GsaDiscreteFunctionalRangeDatumCriterion": { + "GsaCreateJobRequest": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumCriterion" + "properties": { + "name": { + "type": "string", + "nullable": true }, - { - "type": "object", - "properties": { - "gte": { - "type": "integer", - "description": "Greater than or equal to", - "format": "int32", - "nullable": true - }, - "lte": { - "type": "integer", - "description": "Less than or equal to", - "format": "int32", - "nullable": true - }, - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterConstraint" - }, - "description": "Optional unit string. If not included, the gte and lte values are assumed to be in database units.", - "nullable": true - } - } + "description": { + "type": "string", + "nullable": true + }, + "culture": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "nullable": true + }, + "version": { + "type": "integer", + "format": "int32" + }, + "scheduledExecutionDate": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "inputFileIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Names of temporary input files that were uploaded prior to creating this job.", + "nullable": true + }, + "parameters": { + "type": "string", + "nullable": true } - ], - "additionalProperties": false, - "description": "discreteFunctionalRange: Criterion for matching records with discrete functional data where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalRange'", - "x-discriminator-value": "discreteFunctionalRange", - "x-discriminator-name": "type" + }, + "additionalProperties": false }, - "GsaDiscreteFunctionalSeriesDatum": { + "GsaCreateLayout": { + "required": [ + "name" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDiscreteFunctionalDatum" + "properties": { + "applicableApplications": { + "type": "array", + "items": { + "type": "string" + }, + "description": "If there are no ApplicableApplications, the layout is applicable in all applications.", + "nullable": true }, - { - "required": [ - "graph" - ], - "type": "object", - "properties": { - "graph": { - "$ref": "#/components/schemas/GsaDiscreteSeriesGraph" - } - } + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteFunctionalDatum](#model-GsaDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", - "x-discriminator-value": "series", - "x-discriminator-name": "graphType" + "description": "Create dto for Layouts" }, - "GsaDiscreteFunctionalValuesDatumCriterion": { + "GsaCreateLayoutSection": { + "required": [ + "name" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumCriterion" + "properties": { + "name": { + "type": "string" }, - { - "type": "object", - "properties": { - "anyIdentities": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Match any of these discrete type identities", - "nullable": true - }, - "anyGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "Match any of these discrete type GUIDs", - "nullable": true - }, - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterConstraint" - }, - "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.", - "nullable": true - } - } + "guid": { + "type": "string", + "format": "uuid" } - ], + }, "additionalProperties": false, - "description": "discreteFunctionalValues: Criterion for matching records with discrete functional data where the discrete values are one of the given values. Either identities or GUIDs should be provided.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalValues'", - "x-discriminator-value": "discreteFunctionalValues", - "x-discriminator-name": "type" + "description": "Create dto for Layout Sections\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types" }, - "GsaDiscreteGraphParameterValue": { + "GsaCreateLinkedAttributeTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaGraphParameterValue" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "required": [ - "parameterValueGuid" + "linkedAttribute" ], "type": "object", "properties": { - "parameterValueGuid": { - "type": "string", - "format": "uuid" + "linkedAttribute": { + "$ref": "#/components/schemas/GsaSlimEntity" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphParameterValue](#model-GsaGraphParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "parameterType" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", + "x-discriminator-value": "linkedAttribute", + "x-discriminator-name": "columnType" }, - "GsaDiscreteGraphValue": { + "GsaCreateLinkedColumnTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaGraphValue" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "required": [ - "value" + "linkedColumn" ], "type": "object", "properties": { - "value": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + "linkedColumn": { + "$ref": "#/components/schemas/GsaSlimEntity" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphValue](#model-GsaGraphValue)\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "graphValueType" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", + "x-discriminator-value": "linkedColumn", + "x-discriminator-name": "columnType" }, - "GsaDiscreteGridGraph": { + "GsaCreateLinkedRecordTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaGridGraph" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { - "required": [ - "points" - ], - "type": "object", - "properties": { - "points": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteGridPoint" - } - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGridGraph](#model-GsaGridGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "functionalType" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", + "x-discriminator-value": "linkedRecord", + "x-discriminator-name": "columnType" }, - "GsaDiscreteGridPoint": { + "GsaCreateListItem": { "required": [ - "constraints", - "estimated", - "value" + "databaseGuid", + "recordHistoryGuid" ], "type": "object", "properties": { - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterWithDataValue" - } + "databaseGuid": { + "type": "string", + "format": "uuid" }, - "value": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + "recordHistoryGuid": { + "type": "string", + "format": "uuid" }, - "estimated": { - "type": "boolean" + "recordVersion": { + "type": "integer", + "description": "Optional record version. Note that versioned items should not be used in lists used in the Favorites App, which considers all items to be versionless.", + "format": "int32", + "nullable": true + }, + "tableGuid": { + "type": "string", + "description": "Optional table GUID. If the item exists in a loaded database, the GUID will be calculated if not provided.", + "format": "uuid", + "nullable": true } }, "additionalProperties": false }, - "GsaDiscreteGuidDatumCriterion": { + "GsaCreateLocalDateTimeTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateTabularColumn" + }, + { + "type": "object", + "properties": { + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", + "x-discriminator-value": "localDateTime", + "x-discriminator-name": "columnType" + }, + "GsaCreateLocalDiscreteTabularColumn": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "required": [ - "value" + "discreteType" ], "type": "object", "properties": { - "value": { - "type": "string", - "format": "uuid" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + }, + "discreteType": { + "$ref": "#/components/schemas/GsaSlimEntity" } } } ], "additionalProperties": false, - "description": "discreteGuid: Criterion for matching records where the GUID of the discrete data matches the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuid'", - "x-discriminator-value": "discreteGuid", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", + "x-discriminator-value": "localDiscrete", + "x-discriminator-name": "columnType" }, - "GsaDiscreteGuidValuesDatumCriterion": { + "GsaCreateLocalFileTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "type": "object", "properties": { - "all": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "Match all of these discrete value GUIDs", - "nullable": true - }, - "any": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "Match any of these discrete type GUIDs", - "nullable": true - }, - "none": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "Match none of the discrete type GUIDs", - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "discreteGuidValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value GUIDs. One or more field can be null.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuidValues'", - "x-discriminator-value": "discreteGuidValues", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", + "x-discriminator-value": "localFile", + "x-discriminator-name": "columnType" }, - "GsaDiscreteIdentityDatumCriterion": { + "GsaCreateLocalHyperlinkTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { - "required": [ - "value" - ], "type": "object", "properties": { - "value": { - "type": "integer", - "format": "int32" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "discreteIdentity: Criterion for matching records where the identity of the discrete data matches the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentity'", - "x-discriminator-value": "discreteIdentity", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", + "x-discriminator-value": "localHyperlink", + "x-discriminator-name": "columnType" }, - "GsaDiscreteIdentityValuesDatumCriterion": { + "GsaCreateLocalIntegerTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "type": "object", "properties": { - "all": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Match all of these discrete value identities", - "nullable": true - }, - "any": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Match any of these discrete type identities", - "nullable": true - }, - "none": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Match none of the discrete type identities", - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "discreteIdentityValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value identities. One or more field can be null.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentityValues'", - "x-discriminator-value": "discreteIdentityValues", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", + "x-discriminator-value": "localInteger", + "x-discriminator-name": "columnType" }, - "GsaDiscreteParameter": { + "GsaCreateLocalLogicalTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameter" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { - "required": [ - "values" - ], "type": "object", "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteParameterValue" - } + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameter](#model-GsaParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", + "x-discriminator-value": "localLogical", + "x-discriminator-name": "columnType" }, - "GsaDiscreteParameterContent": { + "GsaCreateLocalLongTextTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterContent" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "type": "object", "properties": { - "parameterValue": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "parameterRange": { - "$ref": "#/components/schemas/GsaDiscreteRange" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterContent](#model-GsaParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", + "x-discriminator-value": "localLongText", + "x-discriminator-name": "columnType" }, - "GsaDiscreteParameterDataValue": { + "GsaCreateLocalPictureTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterDataValue" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { - "required": [ - "parameterValue" - ], "type": "object", "properties": { - "parameterValue": { - "$ref": "#/components/schemas/GsaDiscreteParameterValue" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterDataValue](#model-GsaParameterDataValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "parameterType" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", + "x-discriminator-value": "localPicture", + "x-discriminator-name": "columnType" }, - "GsaDiscreteParameterNameConstraint": { + "GsaCreateLocalPointTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterConstraint" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "type": "object", "properties": { - "any": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" }, - "none": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterConstraint](#model-GsaParameterConstraint)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteName'", - "x-discriminator-value": "discreteName", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", + "x-discriminator-value": "localPoint", + "x-discriminator-name": "columnType" }, - "GsaDiscreteParameterValue": { + "GsaCreateLocalRangeTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterValue" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { - "required": [ - "name" - ], "type": "object", "properties": { - "name": { - "type": "string" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterValue](#model-GsaParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", + "x-discriminator-value": "localRange", + "x-discriminator-name": "columnType" }, - "GsaDiscreteParameterValueConstraint": { + "GsaCreateLocalShortTextTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterConstraint" + "$ref": "#/components/schemas/GsaCreateTabularColumn" }, { "type": "object", "properties": { - "any": { - "type": "array", - "items": { - "type": "number", - "format": "double" - }, - "nullable": true - }, - "none": { - "type": "array", - "items": { - "type": "number", - "format": "double" - }, - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterConstraint](#model-GsaParameterConstraint)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteValue'", - "x-discriminator-value": "discreteValue", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", + "x-discriminator-value": "localShortText", + "x-discriminator-name": "columnType" }, - "GsaDiscreteQualitySystem": { + "GsaCreateLogicalAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaQualitySystem" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { - "required": [ - "qualityDiscreteValues", - "thresholdValue" - ], - "type": "object", - "properties": { - "thresholdValue": { - "$ref": "#/components/schemas/GsaQualityDiscreteValue" - }, - "qualityDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQualityDiscreteValue" - } - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystem](#model-GsaQualitySystem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "x-discriminator-value": "logical", "x-discriminator-name": "type" }, - "GsaDiscreteRange": { - "required": [ - "parameterValues" - ], - "type": "object", - "properties": { - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - } - }, - "additionalProperties": false - }, - "GsaDiscreteRangeDatumCriterion": { + "GsaCreateLongTextAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { - "type": "object", - "properties": { - "gte": { - "type": "integer", - "description": "Greater than or equal to", - "format": "int32", - "nullable": true - }, - "lte": { - "type": "integer", - "description": "Less than or equal to", - "format": "int32", - "nullable": true - } - } + "type": "object" } ], "additionalProperties": false, - "description": "discreteRange: Criterion for matching records for where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteRange'", - "x-discriminator-value": "discreteRange", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "x-discriminator-value": "longText", "x-discriminator-name": "type" }, - "GsaDiscreteSeries": { - "required": [ - "constraints", - "points" - ], + "GsaCreateMathsContent": { "type": "object", "properties": { - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterWithDataValue" - } + "curveLabel": { + "type": "string", + "nullable": true }, - "points": { + "transposeAxes": { + "type": "boolean" + }, + "useLogarithmicScale": { + "type": "boolean" + }, + "expression": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "freeParameter": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "parameterContents": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDiscreteSeriesPoint" + "$ref": "#/components/schemas/GsaCreateParameterContent" } } }, - "additionalProperties": false + "additionalProperties": false, + "description": "\r\n\r\nexpression: Defaults to the first expression on the attribute, if there are any.\r\n\r\nfreeParameter: Defaults to the first parameter on the attribute, if there are any." }, - "GsaDiscreteSeriesGraph": { + "GsaCreateMathsFunctionalAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaSeriesGraph" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { - "required": [ - "series" - ], "type": "object", "properties": { - "series": { + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "attributeParameters": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDiscreteSeries" - } + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "nullable": true + }, + "expressions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "nullable": true + }, + "allowExtrapolation": { + "type": "boolean" + }, + "axisName": { + "$ref": "#/components/schemas/GsaCreateAxisName" + }, + "isRange": { + "type": "boolean" + }, + "defaultContent": { + "$ref": "#/components/schemas/GsaCreateMathsContent" + }, + "allowAllCompatibleExpressions": { + "type": "boolean" + }, + "allowAnonymousExpressions": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSeriesGraph](#model-GsaSeriesGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "functionalType" - }, - "GsaDiscreteSeriesPoint": { - "required": [ - "estimated", - "value", - "xValue" - ], - "type": "object", - "properties": { - "xValue": { - "type": "number", - "format": "double" - }, - "value": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" - }, - "estimated": { - "type": "boolean" - } - }, - "additionalProperties": false + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "x-discriminator-value": "mathsFunctional", + "x-discriminator-name": "type" }, - "GsaDiscreteTextAggregation": { + "GsaCreateNumericParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatum" + "$ref": "#/components/schemas/GsaCreateParameter" }, { + "required": [ + "interpolationType", + "isRestricted", + "scaleType", + "values" + ], "type": "object", "properties": { - "terms": { + "isRestricted": { + "type": "boolean" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "values": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaTermWithCount" - }, - "nullable": true + "$ref": "#/components/schemas/GsaCreateNumericParameterValue" + } + }, + "interpolationType": { + "$ref": "#/components/schemas/GsaParameterInterpolationType" + }, + "scaleType": { + "$ref": "#/components/schemas/GsaParameterScaleType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteText'", - "x-discriminator-value": "discreteText", - "x-discriminator-name": "datumType" + "description": "\r\n\r\nThis extends: GsaCreateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" }, - "GsaDiscreteTextAggregationDatumCriterion": { + "GsaCreateNumericParameterContent": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaCreateParameterContent" }, { "type": "object", "properties": { - "numberOfTerms": { - "type": "integer", - "description": "The maximum number of terms to return in this aggregation.", - "format": "int32" - }, - "prefix": { - "type": "string", - "description": "An optional textual prefix. If provided, only terms that start with this prefix will be\r\nconsidered in the aggregation.", + "value": { + "type": "number", + "format": "double", "nullable": true + }, + "parameterRange": { + "$ref": "#/components/schemas/GsaCreateContinuousRange" } } } ], "additionalProperties": false, - "description": "Criterion for aggregating textual data within a discrete attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", - "x-discriminator-value": "discreteText", + "description": "\r\n\r\nThis extends: GsaCreateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, - "GsaDiscreteTextDatumCriterion": { + "GsaCreateNumericParameterValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateParameterValue" }, { "required": [ @@ -103538,105 +68827,171 @@ "type": "object", "properties": { "value": { - "type": "string" + "type": "number", + "format": "double" }, - "textMatchBehavior": { - "$ref": "#/components/schemas/GsaTextMatchBehavior" + "name": { + "type": "string", + "nullable": true } } } ], "additionalProperties": false, - "description": "discreteText: Criterion for matching records where the text of the discrete data contains the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", - "x-discriminator-value": "discreteText", + "description": "\r\n\r\nThis extends: GsaCreateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, - "GsaDiscreteTextPrefixDatumCriterion": { + "GsaCreateParameter": { + "required": [ + "defaultParameterValueIndex", + "name", + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/GsaParameterType" + }, + "helpPath": { + "type": "string", + "nullable": true + }, + "defaultParameterValueIndex": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteParameter\r\n * GsaCreateNumericParameter", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaCreateDiscreteParameter", + "numeric": "#/components/schemas/GsaCreateNumericParameter" + } + } + }, + "GsaCreateParameterContent": { + "required": [ + "parameter", + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/GsaParameterType" + }, + "parameter": { + "$ref": "#/components/schemas/GsaSlimEntity" + } + }, + "additionalProperties": false, + "description": "Set the range and/or default value for parameters used by the attribute.\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteParameterContent\r\n * GsaCreateNumericParameterContent", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaCreateDiscreteParameterContent", + "numeric": "#/components/schemas/GsaCreateNumericParameterContent" + } + } + }, + "GsaCreateParameterValue": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/GsaParameterValueType" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteParameterValue\r\n * GsaCreateNumericParameterValue", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaCreateDiscreteParameterValue", + "numeric": "#/components/schemas/GsaCreateNumericParameterValue" + } + } + }, + "GsaCreatePictureAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { - "required": [ - "prefix" - ], - "type": "object", - "properties": { - "prefix": { - "type": "string" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "discreteTextPrefix: Criterion for matching records where the text of the discrete data begins with the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextPrefix'", - "x-discriminator-value": "discreteTextPrefix", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "x-discriminator-value": "picture", "x-discriminator-name": "type" }, - "GsaDiscreteTextValuesDatumCriterion": { + "GsaCreatePointAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { "type": "object", "properties": { - "all": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "isMultiValued": { + "type": "boolean" }, - "any": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" }, - "none": { + "axisName": { + "$ref": "#/components/schemas/GsaCreateAxisName" + }, + "attributeParameters": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GsaSlimEntity" }, "nullable": true - }, - "textMatchBehavior": { - "$ref": "#/components/schemas/GsaTextMatchBehavior" } } } ], "additionalProperties": false, - "description": "discreteTextValues: Criterion for matching records where the text in the discrete data matches all, any and/or none of the specified text strings. One of more field can be null.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextValues'", - "x-discriminator-value": "discreteTextValues", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "x-discriminator-value": "point", "x-discriminator-name": "type" }, - "GsaDiscreteType": { + "GsaCreateProfile": { "required": [ - "discreteValues", - "guid", - "isOrdered", - "isProtected", "name" ], "type": "object", "properties": { - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" - } + "description": { + "type": "string", + "nullable": true }, - "isOrdered": { - "type": "boolean" + "homepageUrl": { + "type": "string", + "nullable": true }, - "isProtected": { - "type": "boolean", - "description": "If true, the discrete type is protected from all changes." + "groupName": { + "type": "string", + "nullable": true }, "name": { "type": "string" @@ -103648,909 +69003,1230 @@ }, "additionalProperties": false }, - "GsaDiscreteTypeCreationException": { + "GsaCreateProfileTable": { "required": [ - "name" + "databaseGuid", + "tableGuid" ], "type": "object", "properties": { - "message": { + "databaseGuid": { "type": "string", - "nullable": true + "format": "uuid" }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "tableGuid": { + "type": "string", + "format": "uuid" }, - "name": { - "type": "string" + "subsetGuid": { + "type": "string", + "format": "uuid", + "nullable": true }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteTypeErrorDetail" - }, + "layoutGuid": { + "type": "string", + "format": "uuid", "nullable": true + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false }, - "GsaDiscreteTypeDeletionException": { + "GsaCreateRangeAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDeletionException" + "$ref": "#/components/schemas/GsaCreateAttribute" }, { - "type": "object" + "type": "object", + "properties": { + "unit": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "axisName": { + "$ref": "#/components/schemas/GsaCreateAxisName" + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'discreteType'", - "x-discriminator-value": "discreteType", - "x-discriminator-name": "entityType" + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "x-discriminator-value": "range", + "x-discriminator-name": "type" }, - "GsaDiscreteTypeErrorDetail": { + "GsaCreateRecordHistory": { "required": [ - "message", - "reason" + "name", + "recordType" ], "type": "object", "properties": { - "message": { + "recordType": { + "$ref": "#/components/schemas/GsaRecordType" + }, + "name": { "type": "string" }, - "reason": { - "$ref": "#/components/schemas/GsaDiscreteTypeErrorReason" + "shortName": { + "type": "string", + "nullable": true + }, + "parent": { + "$ref": "#/components/schemas/GsaSlimRecordHistory" + }, + "recordColor": { + "$ref": "#/components/schemas/GsaRecordColor" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaCreateRecordLinkGroup": { + "required": [ + "linkTarget", + "name", + "reverseName", + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/GsaRecordLinkGroupType" + }, + "linkTarget": { + "$ref": "#/components/schemas/GsaLinkTarget" + }, + "reverseName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityDiscreteTypeErrorDetail](#model-GsaNamedEntityDiscreteTypeErrorDetail)\r\n * [GsaDiscreteValuesErrorDetail](#model-GsaDiscreteValuesErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateStaticRecordLinkGroup\r\n * GsaCreateDynamicRecordLinkGroup\r\n * GsaCreateCrossDatabaseRecordLinkGroup", "discriminator": { - "propertyName": "reason", + "propertyName": "type", "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityDiscreteTypeErrorDetail", - "discreteValues": "#/components/schemas/GsaDiscreteValuesErrorDetail" + "static": "#/components/schemas/GsaCreateStaticRecordLinkGroup", + "dynamic": "#/components/schemas/GsaCreateDynamicRecordLinkGroup", + "crossDatabase": "#/components/schemas/GsaCreateCrossDatabaseRecordLinkGroup" } } }, - "GsaDiscreteTypeErrorReason": { - "enum": [ - "namedEntity", - "discreteValues", - "discreteValuesUpdate" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • discreteValues: One or more errors occurred when creating or updating the discrete values for the discrete type.
    • \r\n
  • discreteValuesUpdate: One or more errors occurred when updating the discrete values for an existing discrete type.
    • \r\n
\r\n" - }, - "GsaDiscreteTypeUpdateException": { + "GsaCreateRecordList": { "required": [ - "discreteTypeGuid" + "name" ], "type": "object", "properties": { - "message": { + "items": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + }, + "identifier": { "type": "string", + "format": "uuid", "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "name": { + "type": "string" }, - "discreteTypeGuid": { + "description": { "type": "string", - "format": "uuid" + "nullable": true }, - "errors": { + "notes": { + "type": "string", + "nullable": true + }, + "published": { + "type": "boolean" + }, + "awaitingApproval": { + "type": "boolean" + }, + "internalUse": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "GsaCreateRecordListItemsInfo": { + "required": [ + "items" + ], + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDiscreteTypeErrorDetail" - }, + "$ref": "#/components/schemas/GsaCreateListItem" + } + } + }, + "additionalProperties": false + }, + "GsaCreateReplacementString": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaCreateSearchRequest": { + "type": "object", + "properties": { + "searchConfig": { + "type": "string", "nullable": true + }, + "detail": { + "$ref": "#/components/schemas/GsaSearchDetail" } }, "additionalProperties": false }, - "GsaDiscreteTypeUsage": { + "GsaCreateShortTextAttribute": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaCreateAttribute" + }, + { + "type": "object", + "properties": { + "isUnique": { + "type": "boolean", + "description": "Whether or not the attribute is constrained to contain a unique value" + }, + "dataRule": { + "$ref": "#/components/schemas/GsaSlimEntity" + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "x-discriminator-value": "shortText", + "x-discriminator-name": "type" + }, + "GsaCreateStandardName": { + "required": [ + "name" + ], "type": "object", "properties": { - "attributes": { + "mappedAttributes": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimAttribute" + "$ref": "#/components/schemas/GsaSlimEntity" }, "nullable": true }, - "tabularColumns": { + "mappedParameters": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaTabularAttributeWithColumns" + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "nullable": true + }, + "mappedRecordLinkGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "nullable": true + }, + "mappedCrossDatabaseRecordLinkGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimEntity" }, "nullable": true + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false }, - "GsaDiscreteTypeUsageType": { - "enum": [ - "attributes", - "tabularColumns" + "GsaCreateStaticRecordLinkGroup": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" + }, + { + "type": "object", + "properties": { + "includeIndirectLinks": { + "type": "boolean" + } + } + } ], - "type": "string" + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaCreateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", + "x-discriminator-value": "static", + "x-discriminator-name": "type" }, - "GsaDiscreteTypesInfo": { + "GsaCreateSubset": { + "required": [ + "name" + ], "type": "object", "properties": { - "discreteTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimDiscreteType" - }, - "nullable": true + "associatedLayout": { + "$ref": "#/components/schemas/GsaSlimEntity" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false }, - "GsaDiscreteValue": { + "GsaCreateTable": { + "required": [ + "name" + ], "type": "object", "properties": { - "value": { - "type": "string", - "nullable": true + "isHiddenFromBrowse": { + "type": "boolean" }, - "order": { - "type": "integer", - "format": "int32", - "nullable": true + "isHiddenFromSearch": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false }, - "GsaDiscreteValueCreationException": { + "GsaCreateTabularAttribute": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaCreateAttribute" + }, + { + "type": "object", + "properties": { + "displayFullTable": { + "type": "boolean" + }, + "displaySummaryRowInline": { + "type": "boolean" + }, + "hideUnlinkedRows": { + "type": "boolean" + }, + "tabularColumns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCreateTabularColumn" + }, + "nullable": true + }, + "target": { + "$ref": "#/components/schemas/GsaTabularAttributeTarget" + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "x-discriminator-value": "link", + "x-discriminator-name": "type" + }, + "GsaCreateTabularColumn": { "required": [ + "columnType", "name" ], "type": "object", "properties": { - "message": { + "columnType": { + "$ref": "#/components/schemas/GsaTabularColumnDtoType" + }, + "showAsLink": { + "type": "boolean" + }, + "summaryRowEnabled": { + "type": "boolean" + }, + "summaryRowText": { "type": "string", "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "rollUpType": { + "$ref": "#/components/schemas/GsaTabularColumnRollUpType" + }, + "summaryRowRollUpType": { + "$ref": "#/components/schemas/GsaTabularColumnRollUpType" }, "name": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValueErrorDetail" - }, - "nullable": true + "guid": { + "type": "string", + "format": "uuid" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * GsaCreateLinkedAttributeTabularColumn\r\n * GsaCreateLinkedColumnTabularColumn\r\n * GsaCreateLinkedRecordTabularColumn\r\n * GsaCreateLocalPointTabularColumn\r\n * GsaCreateLocalRangeTabularColumn\r\n * GsaCreateLocalIntegerTabularColumn\r\n * GsaCreateLocalLogicalTabularColumn\r\n * GsaCreateLocalShortTextTabularColumn\r\n * GsaCreateLocalLongTextTabularColumn\r\n * GsaCreateLocalDateTimeTabularColumn\r\n * GsaCreateLocalDiscreteTabularColumn\r\n * GsaCreateLocalHyperlinkTabularColumn\r\n * GsaCreateLocalFileTabularColumn\r\n * GsaCreateLocalPictureTabularColumn", + "discriminator": { + "propertyName": "columnType", + "mapping": { + "linkedAttribute": "#/components/schemas/GsaCreateLinkedAttributeTabularColumn", + "linkedColumn": "#/components/schemas/GsaCreateLinkedColumnTabularColumn", + "linkedRecord": "#/components/schemas/GsaCreateLinkedRecordTabularColumn", + "localPoint": "#/components/schemas/GsaCreateLocalPointTabularColumn", + "localRange": "#/components/schemas/GsaCreateLocalRangeTabularColumn", + "localInteger": "#/components/schemas/GsaCreateLocalIntegerTabularColumn", + "localLogical": "#/components/schemas/GsaCreateLocalLogicalTabularColumn", + "localShortText": "#/components/schemas/GsaCreateLocalShortTextTabularColumn", + "localLongText": "#/components/schemas/GsaCreateLocalLongTextTabularColumn", + "localDateTime": "#/components/schemas/GsaCreateLocalDateTimeTabularColumn", + "localDiscrete": "#/components/schemas/GsaCreateLocalDiscreteTabularColumn", + "localHyperlink": "#/components/schemas/GsaCreateLocalHyperlinkTabularColumn", + "localFile": "#/components/schemas/GsaCreateLocalFileTabularColumn", + "localPicture": "#/components/schemas/GsaCreateLocalPictureTabularColumn" + } + } }, - "GsaDiscreteValueDeletionException": { + "GsaCreateUnit": { + "required": [ + "name", + "symbol" + ], "type": "object", "properties": { - "message": { + "symbol": { + "type": "string" + }, + "equation": { "type": "string", "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "name": { + "type": "string" }, - "discreteValueGuid": { + "guid": { "type": "string", "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValueUsedInDataErrorDetail" - }, - "nullable": true } }, "additionalProperties": false }, - "GsaDiscreteValueErrorDetail": { + "GsaCreateUnitSystem": { "required": [ - "message", - "reason" + "name" ], "type": "object", "properties": { - "message": { + "name": { "type": "string" }, - "reason": { - "$ref": "#/components/schemas/GsaDiscreteValueErrorReason" + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityDiscreteValueErrorDetail](#model-GsaNamedEntityDiscreteValueErrorDetail)\r\n * [GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail](#model-GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail)\r\n * [GsaDiscreteValueUsedInDataErrorDetail](#model-GsaDiscreteValueUsedInDataErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityDiscreteValueErrorDetail", - "noSuchDiscreteValuesInDiscreteValues": "#/components/schemas/GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail", - "discreteValueUsedInData": "#/components/schemas/GsaDiscreteValueUsedInDataErrorDetail" - } - } + "description": "Create dto for Unit Systems\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types" }, - "GsaDiscreteValueErrorReason": { - "enum": [ - "namedEntity", - "noSuchDiscreteValuesInDiscreteValues", - "discreteValueUsedInData" + "GsaCreatedByUserProperty": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaProperty" + }, + { + "type": "object", + "properties": { + "createdByUser": { + "type": "string", + "nullable": true + } + } + } ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noSuchDiscreteValuesInDiscreteValues: One or more discrete values specified for update do not exist in the discrete type.
    • \r\n
  • discreteValueUsedInData: One or more discrete values are being used by data.
    • \r\n
\r\n" + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdByUser'", + "x-discriminator-value": "createdByUser", + "x-discriminator-name": "propertyName" }, - "GsaDiscreteValueNotInDiscreteTypeErrorDetail": { + "GsaCreatedDateProperty": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" + "$ref": "#/components/schemas/GsaProperty" }, { - "required": [ - "discreteTypeGuid", - "discreteValueGuid" - ], "type": "object", "properties": { - "discreteValueGuid": { - "type": "string", - "format": "uuid" - }, - "discreteTypeGuid": { + "createdDate": { "type": "string", - "format": "uuid" + "format": "date-time" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'discreteValueNotInDiscreteType'", - "x-discriminator-value": "discreteValueNotInDiscreteType", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdDate'", + "x-discriminator-value": "createdDate", + "x-discriminator-name": "propertyName" }, - "GsaDiscreteValueUpdateException": { + "GsaCriterion": { "required": [ - "discreteValueGuid" + "type" ], "type": "object", "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "discreteValueGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValueErrorDetail" - }, - "nullable": true + "type": { + "$ref": "#/components/schemas/GsaCriterionType" + } + }, + "additionalProperties": false, + "description": "The criterion to be used in a search.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\", \"all\", or \"none\" of the criterion.\r\nThese criterion can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * GsaBooleanCriterion\r\n * GsaFreeTextCriterion\r\n * GsaFreeTextPrefixCriterion\r\n * GsaRecordListMemberCriterion\r\n * GsaRecordPropertyCriterion\r\n * GsaRecordReferenceCriterion\r\n * GsaRecordAncestorCriterion\r\n * GsaRecordAncestorHistoryCriterion\r\n * GsaRecordSubsetCriterion\r\n * GsaTabularLinkingValueCriterion\r\n * GsaAttributeCriterion\r\n * GsaLocalColumnCriterion\r\n * GsaNamedCriterion", + "discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#/components/schemas/GsaBooleanCriterion", + "text": "#/components/schemas/GsaFreeTextCriterion", + "textPrefix": "#/components/schemas/GsaFreeTextPrefixCriterion", + "recordListMember": "#/components/schemas/GsaRecordListMemberCriterion", + "recordProperty": "#/components/schemas/GsaRecordPropertyCriterion", + "reference": "#/components/schemas/GsaRecordReferenceCriterion", + "recordAncestor": "#/components/schemas/GsaRecordAncestorCriterion", + "recordAncestorHistory": "#/components/schemas/GsaRecordAncestorHistoryCriterion", + "subset": "#/components/schemas/GsaRecordSubsetCriterion", + "tabularLinkingValue": "#/components/schemas/GsaTabularLinkingValueCriterion", + "attribute": "#/components/schemas/GsaAttributeCriterion", + "localColumn": "#/components/schemas/GsaLocalColumnCriterion", + "namedCriterion": "#/components/schemas/GsaNamedCriterion" } - }, - "additionalProperties": false + } + }, + "GsaCriterionType": { + "enum": [ + "boolean", + "text", + "textPrefix", + "recordListMember", + "recordProperty", + "reference", + "recordAncestor", + "recordAncestorHistory", + "subset", + "tabularLinkingValue", + "attribute", + "localColumn", + "namedCriterion" + ], + "type": "string" }, - "GsaDiscreteValueUsedInDataErrorDetail": { + "GsaCrossDatabaseRecordLinkGroup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteValueErrorDetail" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, { "required": [ - "discreteValueInUse" + "includeIndirectLinks" ], "type": "object", "properties": { - "discreteValueInUse": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "includeIndirectLinks": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteValueErrorDetail](#model-GsaDiscreteValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'discreteValueUsedInData'", - "x-discriminator-value": "discreteValueUsedInData", - "x-discriminator-name": "reason" - }, - "GsaDiscreteValuesCreateDiscreteValue": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Create dto for Discrete Values\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types" + "description": "\r\n\r\nThis extends: GsaRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", + "x-discriminator-value": "crossDatabase", + "x-discriminator-name": "type" }, - "GsaDiscreteValuesDiscreteValue": { - "required": [ - "guid", - "isProtected", - "name" - ], + "GsaCurrentUser": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "description": "If true, the discrete value is protected from all changes." - }, - "name": { - "type": "string" + "isAdmin": { + "type": "boolean" }, - "guid": { + "username": { "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaDiscreteValuesDiscreteValuesInfo": { - "type": "object", - "properties": { - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" - }, "nullable": true + }, + "hasWriteAccess": { + "type": "boolean" } }, "additionalProperties": false }, - "GsaDiscreteValuesErrorDetail": { + "GsaDataExportApplicableDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteTypeErrorDetail" + "$ref": "#/components/schemas/GsaDataExportDatum" }, { "required": [ - "errors" + "datumType" ], "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValueErrorDetail" - } + "datumType": { + "$ref": "#/components/schemas/GsaAttributeType" + } + }, + "discriminator": { + "propertyName": "datumType", + "mapping": { + "logical": "#/components/schemas/GsaDataExportBooleanDatum", + "dateTime": "#/components/schemas/GsaDataExportDateTimeDatum", + "discrete": "#/components/schemas/GsaDataExportDiscreteDatum", + "file": "#/components/schemas/GsaDataExportFileDatum", + "floatFunctional": "#/components/schemas/GsaDataExportFloatFunctionalDatum", + "discreteFunctional": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum", + "hyperlink": "#/components/schemas/GsaDataExportHyperlinkDatum", + "link": "#/components/schemas/GsaDataExportLinkDatum", + "longText": "#/components/schemas/GsaDataExportLongTextDatum", + "integer": "#/components/schemas/GsaDataExportNumericDatum", + "picture": "#/components/schemas/GsaDataExportPictureDatum", + "point": "#/components/schemas/GsaDataExportPointDatum", + "range": "#/components/schemas/GsaDataExportRangeDatum", + "shortText": "#/components/schemas/GsaDataExportShortTextDatum" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteTypeErrorDetail](#model-GsaDiscreteTypeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'discreteValues'", - "x-discriminator-value": "discreteValues", - "x-discriminator-name": "reason" - }, - "GsaDiscreteValuesReplaceDiscreteValuesInfo": { - "type": "object", - "properties": { - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutDiscreteValue" - }, - "nullable": true - } - }, - "additionalProperties": false + "description": "\r\n\r\nThis extends: GsaDataExportDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * GsaDataExportBooleanDatum\r\n * GsaDataExportDateTimeDatum\r\n * GsaDataExportDiscreteDatum\r\n * GsaDataExportFileDatum\r\n * GsaDataExportFloatFunctionalDatum\r\n * GsaDataExportDiscreteFunctionalDatum\r\n * GsaDataExportHyperlinkDatum\r\n * GsaDataExportLinkDatum\r\n * GsaDataExportLongTextDatum\r\n * GsaDataExportNumericDatum\r\n * GsaDataExportPictureDatum\r\n * GsaDataExportPointDatum\r\n * GsaDataExportRangeDatum\r\n * GsaDataExportShortTextDatum", + "x-discriminator-value": "applicable", + "x-discriminator-name": "notApplicable" }, - "GsaDiscreteValuesUpdateDiscreteValue": { + "GsaDataExportBinaryData": { "type": "object", "properties": { "name": { - "type": "string" + "type": "string", + "nullable": true }, - "guid": { + "description": { "type": "string", - "format": "uuid" + "nullable": true + }, + "contentType": { + "type": "string", + "nullable": true + }, + "data": { + "type": "string", + "format": "byte", + "nullable": true } }, "additionalProperties": false }, - "GsaDiskStatus": { - "enum": [ - "Ok", - "LowWatermarkReached", - "HighWatermarkReached", - "FloodStageReached" - ], - "type": "string", - "description": "The status of the amount of space remaining on the disk.

Possible values:

\r\n
    \r\n
  • Ok: There is enough space.
    • \r\n
  • LowWatermarkReached: Once the disk reaches this point, Elasticsearch will not allocate any more shards to this node.
    • \r\n
  • HighWatermarkReached: At this point, Elasticsearch will attempt to relocate shards away from this node.
    • \r\n
  • FloodStageReached: At this point, Elastic search will enforce a read only block on the index.
    • \r\n
\r\n" - }, - "GsaDisplayNameEmptyErrorDetail": { + "GsaDataExportBooleanDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "type": "object", "properties": { - "language": { - "type": "string", - "nullable": true + "datumValue": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "Display name cannot be empty. Display names are optional and can be set to null to remove, but cannot be an empty string or white space only.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'displayNameEmpty'", - "x-discriminator-value": "displayNameEmpty", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", + "x-discriminator-value": "logical", + "x-discriminator-name": "datumType" }, - "GsaDisplayNameLanguageNotProvidedErrorDetail": { + "GsaDataExportCountRollupDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + "$ref": "#/components/schemas/GsaDataExportRollupDatum" }, { "type": "object", "properties": { - "displayName": { - "type": "string", - "nullable": true + "count": { + "type": "integer", + "format": "int32" } } } ], "additionalProperties": false, - "description": "Display name must have a language.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'displayNameLanguageNotProvided'", - "x-discriminator-value": "displayNameLanguageNotProvided", - "x-discriminator-name": "reason" + "description": "A count of the number of populated values\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'countRollup'", + "x-discriminator-value": "countRollup", + "x-discriminator-name": "type" }, - "GsaDisplayNameLanguageNotSupportedErrorDetail": { + "GsaDataExportDateTimeDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "type": "object", "properties": { - "language": { + "datumValue": { "type": "string", - "nullable": true + "format": "date-time" } } } ], "additionalProperties": false, - "description": "Display name language is not supported. Language must be a .NET culture, e.g. \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\"\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'displayNameLanguageNotSupported'", - "x-discriminator-value": "displayNameLanguageNotSupported", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", + "x-discriminator-name": "datumType" }, - "GsaDisplayNamesImportErrorDetail": { + "GsaDataExportDatum": { "required": [ - "message", - "reason" + "attributeGuid", + "attributeIdentity", + "notApplicable" ], "type": "object", "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaDisplayNamesImportErrorReason" - }, - "rowIndex": { + "attributeIdentity": { "type": "integer", - "format": "int64", - "nullable": true - }, - "fieldValue": { - "type": "string", - "nullable": true - }, - "columnHeader": { - "type": "string", - "nullable": true + "format": "int64" }, - "itemType": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDisplayNamesImportErrorReason": { - "enum": [ - "unknown", - "malformedLine", - "incorrectNumberOfColumns", - "invalidSchemaType", - "invalidLanguage", - "schemaItemNotFound", - "emptyColumn", - "extraInfoMissing", - "translationTooLong" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • unknown: An error occurred
    • \r\n
  • malformedLine: Invalid format.
    • \r\n
  • incorrectNumberOfColumns: Incorrect number of columns.
    • \r\n
  • invalidSchemaType: Type is not a supported type for Display Names.
    • \r\n
  • invalidLanguage: Invalid language code.
    • \r\n
  • schemaItemNotFound: Schema item was not found in the database.
    • \r\n
  • emptyColumn: Column must be specified.
    • \r\n
  • extraInfoMissing: Item in column must be specified.
    • \r\n
  • translationTooLong: The Display Name translation is too long.
    • \r\n
\r\n" - }, - "GsaDisplayNamesImportException": { - "type": "object", - "properties": { - "message": { + "attributeGuid": { "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "format": "uuid" }, - "errors": { + "metaDatums": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDisplayNamesImportErrorDetail" + "$ref": "#/components/schemas/GsaDataExportDatum" }, "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDisplayNamesInfo": { - "type": "object", - "properties": { - "displayNames": { - "$ref": "#/components/schemas/GsaGrid" - } - }, - "additionalProperties": false - }, - "GsaDivideByZeroUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" }, - { - "type": "object" + "notApplicable": { + "type": "string" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'divideByZero'", - "x-discriminator-value": "divideByZero", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis is one of: \r\n * GsaDataExportNotApplicableDatum\r\n * GsaDataExportApplicableDatum\r\n * GsaDataExportUnknownDatum", + "discriminator": { + "propertyName": "notApplicable", + "mapping": { + "notApplicable": "#/components/schemas/GsaDataExportNotApplicableDatum", + "applicable": "#/components/schemas/GsaDataExportApplicableDatum", + "unknown": "#/components/schemas/GsaDataExportUnknownDatum" + } + } }, - "GsaDoubleSortingValue": { + "GsaDataExportDiscreteDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaSortingValue" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "type": "object", "properties": { - "value": { - "type": "number", - "format": "double" + "datumValue": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDiscreteValue" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSortingValue](#model-GsaSortingValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", - "x-discriminator-value": "double", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "datumType" }, - "GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail": { + "GsaDataExportDiscreteFunctionalDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "required": [ - "duplicateGuids", - "duplicateNames" + "graphType" ], "type": "object", "properties": { - "duplicateNames": { - "type": "array", - "items": { - "type": "string" - } + "graphType": { + "type": "string", + "nullable": true + }, + "xAxisParameter": { + "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" }, - "duplicateGuids": { + "parameters": { "type": "array", "items": { - "type": "string", - "format": "uuid" - } + "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" + }, + "nullable": true + } + }, + "discriminator": { + "propertyName": "graphType", + "mapping": { + "grid": "#/components/schemas/GsaDataExportDiscreteFunctionalGridDatum", + "series": "#/components/schemas/GsaDataExportDiscreteFunctionalSeriesDatum" } } } ], "additionalProperties": false, - "description": "Duplicate categories were specified, either by name or GUID.\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateCategories'", - "x-discriminator-value": "duplicateCategories", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * GsaDataExportDiscreteFunctionalGridDatum\r\n * GsaDataExportDiscreteFunctionalSeriesDatum", + "x-discriminator-value": "discreteFunctional", + "x-discriminator-name": "datumType" }, - "GsaDuplicateCategoryGuidsAccessControlErrorDetail": { + "GsaDataExportDiscreteFunctionalGridDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" + "$ref": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum" }, { - "required": [ - "duplicateGuids" - ], "type": "object", "properties": { - "duplicateGuids": { + "values": { "type": "array", "items": { - "type": "string", - "format": "uuid" - } + "$ref": "#/components/schemas/GsaDataExportDiscreteGridPoint" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "Duplicate permission category GUIDs were specified in the request.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateCategoryGuids'", - "x-discriminator-value": "duplicateCategoryGuids", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "x-discriminator-value": "grid", + "x-discriminator-name": "graphType" }, - "GsaDuplicateCodeCurrencyErrorDetail": { + "GsaDataExportDiscreteFunctionalSeriesDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" + "$ref": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum" }, { "type": "object", "properties": { - "currencyCode": { - "type": "string", + "series": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportDiscreteSeries" + }, "nullable": true } } } ], "additionalProperties": false, - "description": "Currency with specified code already exists.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateCode'", - "x-discriminator-value": "duplicateCode", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "x-discriminator-value": "series", + "x-discriminator-name": "graphType" }, - "GsaDuplicateDatabaseAddDatabaseValidationIssue": { + "GsaDataExportDiscreteGridPoint": { + "type": "object", + "properties": { + "parameterValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" + }, + "nullable": true + }, + "value": { + "$ref": "#/components/schemas/GsaDiscreteValue" + }, + "isEstimated": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "GsaDataExportDiscreteSeries": { + "type": "object", + "properties": { + "parameterValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" + }, + "nullable": true + }, + "points": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportDiscreteSeriesPoint" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaDataExportDiscreteSeriesPoint": { + "type": "object", + "properties": { + "x": { + "type": "number", + "format": "double" + }, + "xName": { + "type": "string", + "nullable": true + }, + "y": { + "$ref": "#/components/schemas/GsaDiscreteValue" + }, + "isEstimated": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "GsaDataExportFileDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { - "required": [ - "databaseKey", - "databaseName" - ], "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, - "databaseName": { - "type": "string" + "datumValue": { + "$ref": "#/components/schemas/GsaDataExportBinaryData" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateDatabase'", - "x-discriminator-value": "duplicateDatabase", - "x-discriminator-name": "IssueType" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", + "x-discriminator-value": "file", + "x-discriminator-name": "datumType" }, - "GsaDuplicateDiscreteValueErrorDetail": { + "GsaDataExportFloatFunctionalDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "required": [ - "discreteValueGuid" + "graphType" ], "type": "object", "properties": { - "discreteValueGuid": { + "graphType": { "type": "string", - "format": "uuid" + "nullable": true + }, + "unitSymbol": { + "type": "string", + "nullable": true + }, + "xAxisParameter": { + "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaFunctionalDatumParameterInfo" + }, + "nullable": true + }, + "isEstimated": { + "type": "boolean" + }, + "isRange": { + "type": "boolean" + }, + "isLogarithmic": { + "type": "boolean" + } + }, + "discriminator": { + "propertyName": "graphType", + "mapping": { + "grid": "#/components/schemas/GsaDataExportFunctionalGridDatum", + "series": "#/components/schemas/GsaDataExportFunctionalSeriesDatum" } } } ], "additionalProperties": false, - "description": "A discrete value GUID has been specified more than once in the request.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateDiscreteValue'", - "x-discriminator-value": "duplicateDiscreteValue", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * GsaDataExportFunctionalGridDatum\r\n * GsaDataExportFunctionalSeriesDatum", + "x-discriminator-value": "floatFunctional", + "x-discriminator-name": "datumType" }, - "GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail": { + "GsaDataExportFunctionalGridDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "$ref": "#/components/schemas/GsaDataExportFloatFunctionalDatum" }, { "type": "object", "properties": { - "duplicatedGuids": { + "points": { "type": "array", "items": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaDataExportGridPoint" }, "nullable": true + }, + "graphDecoration": { + "$ref": "#/components/schemas/GsaDataExportGraphDecoration" } } } ], "additionalProperties": false, - "description": "No duplicate expression GUIDs allowed.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateExpressionGuids'", - "x-discriminator-value": "duplicateExpressionGuids", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "x-discriminator-value": "grid", + "x-discriminator-name": "graphType" }, - "GsaDuplicateGuidAddDatabaseValidationIssue": { + "GsaDataExportFunctionalSeriesDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" + "$ref": "#/components/schemas/GsaDataExportFloatFunctionalDatum" }, { - "required": [ - "clashingDatabases" - ], "type": "object", "properties": { - "clashingDatabases": { + "series": { "type": "array", "items": { - "type": "string" - } + "$ref": "#/components/schemas/GsaDataExportSeries" + }, + "nullable": true + }, + "showAsTable": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateGuid'", - "x-discriminator-value": "duplicateGuid", - "x-discriminator-name": "IssueType" + "description": "\r\n\r\nThis extends: GsaDataExportFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "x-discriminator-value": "series", + "x-discriminator-name": "graphType" }, - "GsaDuplicateKeyAddDatabaseValidationIssue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" - }, - { - "type": "object" - } + "GsaDataExportGraphDecoration": { + "enum": [ + "Lines", + "Markers", + "LinesAndMarkers" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateKey'", - "x-discriminator-value": "duplicateKey", - "x-discriminator-name": "IssueType" + "type": "string", + "description": "Indicates how a graphical representation of a graph should be rendered

Possible values:

\r\n
    \r\n
  • Lines: Lines
    • \r\n
  • Markers: Markers
    • \r\n
  • LinesAndMarkers: Lines and Markers
    • \r\n
\r\n" }, - "GsaDuplicateMappedAttributeGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "type": "object" - } + "GsaDataExportGridPoint": { + "required": [ + "isEstimated" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedAttributeGuids'", - "x-discriminator-value": "duplicateMappedAttributeGuids", - "x-discriminator-name": "reason" - }, - "GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" + "properties": { + "parameterValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" + }, + "nullable": true }, - { - "type": "object" + "lowValue": { + "type": "number", + "format": "double" + }, + "highValue": { + "type": "number", + "format": "double" + }, + "isEstimated": { + "type": "boolean" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedCrossDatabaseRecordLinkGroupGuids'", - "x-discriminator-value": "duplicateMappedCrossDatabaseRecordLinkGroupGuids", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaDuplicateMappedParameterGuidsErrorDetail": { + "GsaDataExportHyperlink": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" + "properties": { + "address": { + "type": "string", + "nullable": true }, - { - "type": "object" + "formattedAddress": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "target": { + "$ref": "#/components/schemas/GsaHyperlinkTarget" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedParameterGuids'", - "x-discriminator-value": "duplicateMappedParameterGuids", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail": { + "GsaDataExportHyperlinkDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { - "type": "object" + "type": "object", + "properties": { + "datumValue": { + "$ref": "#/components/schemas/GsaDataExportHyperlink" + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedRecordLinkGroupGuids'", - "x-discriminator-value": "duplicateMappedRecordLinkGroupGuids", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", + "x-discriminator-value": "hyperlink", + "x-discriminator-name": "datumType" }, - "GsaDuplicateNameCurrencyErrorDetail": { + "GsaDataExportLinkDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { + "required": [ + "linkDatumType" + ], "type": "object", "properties": { - "name": { + "linkDatumType": { "type": "string", "nullable": true } + }, + "discriminator": { + "propertyName": "linkDatumType", + "mapping": { + "linkGroup": "#/components/schemas/GsaDataExportLinkedRecordsDatum", + "tabular": "#/components/schemas/GsaDataExportTabularDatum" + } } } ], "additionalProperties": false, - "description": "Currency with specified name already exists.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateName'", - "x-discriminator-value": "duplicateName", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'\r\n\r\nThis is one of: \r\n * GsaDataExportLinkedRecordsDatum\r\n * GsaDataExportTabularDatum", + "x-discriminator-value": "link", + "x-discriminator-name": "datumType" }, - "GsaDuplicateParameterGuidsAttributeErrorDetail": { + "GsaDataExportLinkedRecordsDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaDataExportLinkDatum" }, { "type": "object", "properties": { - "duplicatedGuids": { + "linkGroupName": { + "type": "string", + "nullable": true + }, + "linkAttributeType": { + "$ref": "#/components/schemas/GsaLinkAttributeType" + }, + "exportInReversedDirection": { + "type": "boolean" + }, + "targetDatabaseGuid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "linkedRecords": { "type": "array", "items": { + "$ref": "#/components/schemas/GsaRecordWithData" + }, + "nullable": true + }, + "linkGroupNamesByDatabaseKey": { + "type": "object", + "additionalProperties": { "type": "string", - "format": "uuid" + "nullable": true + }, + "nullable": true + }, + "linkGroupIdentitiesByDatabaseKey": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "nullable": true + }, + "rolledUpData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportRollupDatum" }, "nullable": true } @@ -104558,397 +70234,454 @@ } ], "additionalProperties": false, - "description": "No duplicate parameter GUIDs allowed.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateParameterGuids'", - "x-discriminator-value": "duplicateParameterGuids", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportLinkDatum\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'linkGroup'", + "x-discriminator-value": "linkGroup", + "x-discriminator-name": "linkDatumType" }, - "GsaDuplicatePermissionGuidsAccessControlErrorDetail": { + "GsaDataExportLongTextDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { - "required": [ - "categoryGuid", - "duplicateGuids" - ], "type": "object", "properties": { - "categoryGuid": { + "datumValue": { "type": "string", - "format": "uuid" - }, - "duplicateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "nullable": true } } } ], "additionalProperties": false, - "description": "Duplicate permission GUIDs were specified within a category in the request.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicatePermissionGuids'", - "x-discriminator-value": "duplicatePermissionGuids", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", + "x-discriminator-value": "longText", + "x-discriminator-name": "datumType" }, - "GsaDuplicatePermissionsPermissionCategoryErrorDetail": { + "GsaDataExportNotApplicableDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" + "$ref": "#/components/schemas/GsaDataExportDatum" }, { "required": [ - "duplicateGuids", - "duplicateNames" + "datumType" ], "type": "object", "properties": { - "duplicateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "duplicateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "datumType": { + "$ref": "#/components/schemas/GsaAttributeType" } } } ], "additionalProperties": false, - "description": "Duplicate permissions were specified, either by name or GUID.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicatePermissions'", - "x-discriminator-value": "duplicatePermissions", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", + "x-discriminator-value": "notApplicable", + "x-discriminator-name": "notApplicable" }, - "GsaDuplicateSymbolUnitErrorDetail": { + "GsaDataExportNumericDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { - "required": [ - "symbol" - ], "type": "object", "properties": { - "symbol": { - "type": "string" + "datumValue": { + "type": "integer", + "format": "int64" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateSymbol'", - "x-discriminator-value": "duplicateSymbol", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", + "x-discriminator-value": "integer", + "x-discriminator-name": "datumType" }, - "GsaDuplicateTableErrorDetail": { + "GsaDataExportNumericRollupDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" + "$ref": "#/components/schemas/GsaDataExportRollupDatum" }, { - "required": [ - "tableGuid" - ], "type": "object", "properties": { - "tableGuid": { + "value": { + "type": "number", + "format": "double" + }, + "unit": { "type": "string", - "format": "uuid" + "nullable": true } } } ], "additionalProperties": false, - "description": "A table GUID has been specified more than once in the request.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTable'", - "x-discriminator-value": "duplicateTable", - "x-discriminator-name": "reason" + "description": "A statistical rollup of a set of numeric values\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'statisticalRollup'", + "x-discriminator-value": "statisticalRollup", + "x-discriminator-name": "type" }, - "GsaDuplicateTablesReorderTablesErrorDetail": { + "GsaDataExportParameterValue": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReorderTablesErrorDetail" + "properties": { + "parameter": { + "$ref": "#/components/schemas/GsaParameterInfo" }, - { - "required": [ - "duplicateGuids" - ], - "type": "object", - "properties": { - "duplicateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } + "valueName": { + "type": "string", + "nullable": true + }, + "value": { + "type": "number", + "format": "double" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaReorderTablesErrorDetail](#model-GsaReorderTablesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTables'", - "x-discriminator-value": "duplicateTables", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaDuplicateTabularColumnGuidsErrorDetail": { + "GsaDataExportPictureDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "type": "object", "properties": { - "duplicatedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "datumValue": { + "$ref": "#/components/schemas/GsaDataExportBinaryData" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnGuids'", - "x-discriminator-value": "duplicateTabularColumnGuids", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", + "x-discriminator-value": "picture", + "x-discriminator-name": "datumType" }, - "GsaDuplicateTabularColumnNamesErrorDetail": { + "GsaDataExportPoint": { + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "double" + }, + "parameterValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaDataExportPointDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "type": "object", "properties": { - "duplicatedNames": { + "datumValue": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GsaDataExportPoint" }, "nullable": true + }, + "isEstimated": { + "type": "boolean" + }, + "unit": { + "type": "string", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnNames'", - "x-discriminator-value": "duplicateTabularColumnNames", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", + "x-discriminator-value": "point", + "x-discriminator-name": "datumType" }, - "GsaDuplicateVersionGuidAddDatabaseValidationIssue": { + "GsaDataExportRange": { + "type": "object", + "properties": { + "highValue": { + "type": "number", + "format": "double", + "nullable": true + }, + "lowValue": { + "type": "number", + "format": "double", + "nullable": true + }, + "highValueIsInclusive": { + "type": "boolean" + }, + "lowValueIsInclusive": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "GsaDataExportRangeDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { - "required": [ - "clashingDatabase", - "clashingVersionGuid" - ], "type": "object", "properties": { - "clashingDatabase": { - "type": "string", - "description": "The database key of the database with the same version GUID" + "datumValue": { + "$ref": "#/components/schemas/GsaDataExportRange" }, - "clashingVersionGuid": { + "isEstimated": { + "type": "boolean" + }, + "unit": { "type": "string", - "format": "uuid" + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateVersionGuid'", - "x-discriminator-value": "duplicateVersionGuid", - "x-discriminator-name": "IssueType" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", + "x-discriminator-value": "range", + "x-discriminator-name": "datumType" }, - "GsaEmptyAxisNameAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object" - } + "GsaDataExportRequest": { + "required": [ + "attributes", + "recordProperties" ], - "additionalProperties": false, - "description": "Axis name cannot be empty or whitespace.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptyAxisName'", - "x-discriminator-value": "emptyAxisName", - "x-discriminator-name": "reason" - }, - "GsaEmptySymbolUnitErrorDetail": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitErrorDetail" + "properties": { + "attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAttributeToExport" + } }, - { - "type": "object" + "recordProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaRecordProperty" + } + }, + "recordHistoryGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "nullable": true + }, + "recordVersionGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "description": "Data can be exported for either record histories or record versions in each request, not both.", + "nullable": true } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptySymbol'", - "x-discriminator-value": "emptySymbol", - "x-discriminator-name": "reason" + "description": "Request object for exporting the attribute data from a list of records. Either the identity or GUID of the attributes to export must be provided" }, - "GsaEmptyTableTypeErrorDetail": { + "GsaDataExportResponse": { + "required": [ + "failures", + "results" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableTypeErrorDetail" + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaRecordWithData" + } }, - { - "type": "object" + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaExportFailure" + }, + "description": "List the records that were requested, but that we failed to export any data for." } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableTypeErrorDetail](#model-GsaTableTypeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptyTableType'", - "x-discriminator-value": "emptyTableType", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaEnabledLicensesInfo": { + "GsaDataExportRollupDatum": { "required": [ - "miServerEnabled", - "MLEnabled", - "PLMSyncEnabled", - "restrictedSubstancesBAEnabled", - "sustainabilityEnabledEnabled", - "workflowAdvancedEnabled" + "pathAttributeGuids", + "pathAttributeIdentities", + "type" ], "type": "object", "properties": { - "miServerEnabled": { - "type": "boolean", - "description": "Gets a flag indicating whether MI Server is enabled. This corresponds to an MI Server license having been checked out." + "databaseKey": { + "type": "string", + "description": "The database key of the rolled up data", + "nullable": true }, - "workflowAdvancedEnabled": { - "type": "boolean", - "description": "Gets a flag indicating whether advanced workflow features are enabled. This corresponds to a Workflow Advanced license having been checked out." + "attributeIdentity": { + "type": "integer", + "description": "The attribute identity of the rolled up data.\r\nIf the data came from a local column, this is the column identity.\r\nIf the data came from linked records, this is the identity of the tabular attribute", + "format": "int64", + "nullable": true }, - "restrictedSubstancesBAEnabled": { - "type": "boolean", - "description": "Gets a flag indicating whether features associated with the Restricted Substances Analytics\r\nproduct are enabled. This corresponds to a Restricted Substances Analytics license (granta_mi_rsba) having been checked\r\nout." + "attributeGuid": { + "type": "string", + "description": "The attribute GUID of the rolled up data.\r\nIf the data came from a local column, this is the column GUID.\r\nIf the data came from linked records, this is the GUID of the tabular attribute", + "format": "uuid", + "nullable": true }, - "sustainabilityEnabledEnabled": { - "type": "boolean", - "description": "Gets a flag indicating whether features associated with the Sustainability Analytics\r\nproduct are enabled. This corresponds to a Sustainability Analytics license (granta_mi_sus) having been checked\r\nout." + "rollUpType": { + "$ref": "#/components/schemas/GsaTabularColumnRollUpType" }, - "PLMSyncEnabled": { - "type": "boolean", - "description": "Gets a flag indicating whether features associated with the PLM Sync (notably MI Enterprise Connect) are enabled.\r\nThis corresponds to a PLM sync license having been checked out." + "pathAttributeGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "description": "The path from the exported link datum that contains this rollup, to the rolled up attribute.\r\nCan be used to distinguish rollups over the same attribute via different link attributes.\r\nOnly populated if the attributes were requested by GUID - if they were requested by identity, see pathAttributeIdentities." }, - "MLEnabled": { - "type": "boolean", - "description": "Gets a flag indicating whether features associated with the ML (Machine Learning) are enabled.\r\nThis corresponds to a ML license having been checked out." + "pathAttributeIdentities": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The path from the exported link datum that contains this rollup, to the rolled up attribute.\r\nCan be used to distinguish rollups over the same attribute via different link attributes.\r\nOnly populated if the attributes were requested by identity - if they were requested by GUID, see pathAttributeGuids." }, - "expiryDate": { + "type": { "type": "string", - "description": "Gets expiry date of Server license.", - "format": "date-time", "nullable": true } }, "additionalProperties": false, - "description": "Stores information about the state of the MI Server license." + "description": "\r\n\r\nThis is one of: \r\n * GsaDataExportNumericRollupDatum\r\n * GsaDataExportValueRollupDatum\r\n * GsaDataExportValuesRollupDatum\r\n * GsaDataExportCountRollupDatum", + "discriminator": { + "propertyName": "type", + "mapping": { + "statisticalRollup": "#/components/schemas/GsaDataExportNumericRollupDatum", + "valueRollup": "#/components/schemas/GsaDataExportValueRollupDatum", + "valuesRollup": "#/components/schemas/GsaDataExportValuesRollupDatum", + "countRollup": "#/components/schemas/GsaDataExportCountRollupDatum" + } + } }, - "GsaEntityAlreadyExistsErrorDetail": { + "GsaDataExportSeries": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + "properties": { + "parameterValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" + }, + "nullable": true }, - { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } + "points": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportSeriesPoint" + }, + "nullable": true + }, + "graphDecoration": { + "$ref": "#/components/schemas/GsaDataExportGraphDecoration" + } + }, + "additionalProperties": false + }, + "GsaDataExportSeriesPoint": { + "required": [ + "isEstimated" + ], + "type": "object", + "properties": { + "xValue": { + "type": "number", + "format": "double" + }, + "xName": { + "type": "string", + "nullable": true + }, + "yLowValue": { + "type": "number", + "format": "double" + }, + "yHighValue": { + "type": "number", + "format": "double" + }, + "isEstimated": { + "type": "boolean" } - ], - "additionalProperties": false, - "description": "Entity with GUID already exists.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityAlreadyExists'", - "x-discriminator-value": "entityAlreadyExists", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaEntityIdentifierAlreadySpecifiedErrorDetail": { + "GsaDataExportShortTextDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + "$ref": "#/components/schemas/GsaDataExportApplicableDatum" }, { "type": "object", "properties": { - "guid": { + "datumValue": { "type": "string", - "format": "uuid" + "nullable": true } } } ], "additionalProperties": false, - "description": "GUID has been specified more than once in the request.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityIdentifierAlreadySpecified'", - "x-discriminator-value": "entityIdentifierAlreadySpecified", - "x-discriminator-name": "reason" - }, - "GsaEntityType": { - "enum": [ - "attribute", - "database", - "discreteValue", - "discreteType", - "metaAttribute", - "parameter", - "parameterValue", - "table", - "file", - "folder", - "recordHistory", - "recordLinkGroup", - "unit", - "constant", - "permission", - "permissionCategory", - "accessControlCategory", - "qualitySystem", - "qualityDiscreteValue" - ], - "type": "string" + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", + "x-discriminator-value": "shortText", + "x-discriminator-name": "datumType" }, - "GsaEquationUnitErrorDetail": { + "GsaDataExportTabularDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitErrorDetail" + "$ref": "#/components/schemas/GsaDataExportLinkDatum" }, { "type": "object", "properties": { - "errors": { + "attributeName": { + "type": "string", + "nullable": true + }, + "tabularRows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportTabularRow" + }, + "nullable": true + }, + "summaryRow": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" + "$ref": "#/components/schemas/GsaDataExportRollupDatum" }, "nullable": true } @@ -104956,328 +70689,181 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'equation'", - "x-discriminator-value": "equation", - "x-discriminator-name": "reason" - }, - "GsaErrorCode": { - "enum": [ - "unknown", - "accessDenied", - "addDatabase", - "attributeCreation", - "dataValidation", - "deleteRecordVersionControl", - "deletion", - "discreteValueCreation", - "discreteValueUpdate", - "discreteValueReplacement", - "discreteTypeCreation", - "discreteTypeUpdate", - "displayNamesImport", - "fileCreation", - "fileMove", - "fileUpdate", - "folderCreation", - "folderDeletion", - "folderMove", - "folderUpdate", - "getModifiableRecordVersionControl", - "imageTypeValidation", - "inputValidation", - "internalServerError", - "jsonSerialization", - "noSuchEntity", - "noSuchItem", - "notImplemented", - "notSpecified", - "notSupported", - "parameterCreation", - "parameterUpdate", - "parameterValueCreation", - "parameterValueUpdate", - "recordHistoryCopy", - "recordHistoryCreate", - "recordHistoryMove", - "recordLinkGroupCreation", - "recordLinkGroupUpdate", - "recordListPublish", - "recordListResetAwaitingApproval", - "recordListSetAwaitingApproval", - "recordListSetPermissions", - "recordListUnpublish", - "releaseRecordVersionControl", - "releaseTableVersionControl", - "subtypeDeserialization", - "serverNotAvailable", - "upgradeDatabase", - "withdrawRecordVersionControl", - "recordNotModifiable", - "conflicting", - "currencyCreation", - "currencyUpdate", - "currencyImport", - "currencyImportDuplicates", - "unitCreation", - "unitUpdate", - "constantCreation", - "constantUpdate", - "standardNameCreation", - "standardNameUpdate", - "standardNameDeletion", - "permissionCreation", - "permissionUpdate", - "permissionDeletion", - "permissionCategoryCreation", - "permissionCategoryUpdate", - "permissionCategoryDeletion", - "permissionCategoryReplace", - "permissionCategoriesAccessControlUpdate", - "accessControlCategoryCreation", - "accessControlCategoryUpdate", - "getUnitEquivalents", - "setUnitEquivalents", - "tableCreation", - "tableUpdate", - "reorderTables", - "longRunningOperationInvalidStatus", - "qualitySystemCreation", - "permissionBasedAccessControlUpdateOperation", - "attributeUpdate", - "permissionBasedAccessControlAggregation", - "schemaValidation", - "similarityNoData" - ], - "type": "string" + "description": "\r\n\r\nThis extends: GsaDataExportLinkDatum\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'tabular'", + "x-discriminator-value": "tabular", + "x-discriminator-name": "linkDatumType" }, - "GsaErrorDetailOfRecordHistoryErrorReason": { - "required": [ - "message", - "reason" - ], + "GsaDataExportTabularRow": { "type": "object", "properties": { - "message": { - "type": "string" + "rowGuid": { + "type": "string", + "format": "uuid" }, - "reason": { - "$ref": "#/components/schemas/GsaRecordHistoryErrorReason" - } - }, - "additionalProperties": false - }, - "GsaErrorDetailOfUpgradeDatabaseFailureReason": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" + "linkingValue": { + "type": "string", + "nullable": true }, - "reason": { - "$ref": "#/components/schemas/GsaUpgradeDatabaseFailureReason" - } - }, - "additionalProperties": false - }, - "GsaErrorResponse": { - "type": "object", - "properties": { - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "rowNumber": { + "type": "integer", + "format": "int32" }, - "message": { - "type": "string", + "localData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportDatum" + }, + "nullable": true + }, + "linkedRecords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaRecordHistoryReference" + }, + "description": "Records linked to this tabular row (only populated if the target table/attribute was provided in the request)", + "nullable": true + }, + "linkedData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaRecordWithData" + }, + "description": "Data for the linked records, if the request included linked data to export", + "nullable": true + }, + "rolledUpData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataExportRollupDatum" + }, "nullable": true } }, "additionalProperties": false }, - "GsaExceptionInformation": { - "required": [ - "exceptionTypeFullName", - "localisedMessage", - "message", - "stringifiedException" - ], + "GsaDataExportUnknownDatum": { "type": "object", - "properties": { - "exceptionTypeFullName": { - "type": "string", - "description": "Full type name of the original exception." - }, - "message": { - "type": "string", - "description": "Message of the original exception." - }, - "localisedMessage": { - "type": "string", - "description": "Localised message of the original exception if available. Regular message of the original exception otherwise." - }, - "stringifiedException": { - "type": "string", - "description": "The result of calling .ToString() on the original exception." + "allOf": [ + { + "$ref": "#/components/schemas/GsaDataExportDatum" }, - "innerExceptionInfo": { - "$ref": "#/components/schemas/GsaExceptionInformation" + { + "required": [ + "datumType" + ], + "type": "object", + "properties": { + "datumType": { + "$ref": "#/components/schemas/GsaAttributeType" + } + } } - }, + ], "additionalProperties": false, - "description": "\r\n\r\ninnerExceptionInfo: Exception information for the inner exception if available, null otherwise." + "description": "\r\n\r\nThis extends: GsaDataExportDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'unknown'", + "x-discriminator-value": "unknown", + "x-discriminator-name": "notApplicable" }, - "GsaExcludeValuesSpecifier": { + "GsaDataExportValueRollupDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaValueSpecifier" + "$ref": "#/components/schemas/GsaDataExportRollupDatum" }, { "type": "object", "properties": { - "excludedIdentities": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "excludedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "value": { + "type": "object", "nullable": true } } } ], "additionalProperties": false, - "description": "Filters based on a list of identities or guids to exclude.\r\nAll other guids or identities will be included.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'exclude'", - "x-discriminator-value": "exclude", - "x-discriminator-name": "filterOn" + "description": "A rollup where the value is a single object (such as a discrete value)\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'valueRollup'", + "x-discriminator-value": "valueRollup", + "x-discriminator-name": "type" }, - "GsaExistingTabularColumnGuidErrorDetail": { + "GsaDataExportValuesRollupDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaDataExportRollupDatum" }, { "type": "object", "properties": { - "existingGuid": { + "values": { + "type": "array", + "items": { + "type": "object" + }, + "nullable": true + }, + "unit": { "type": "string", - "format": "uuid" + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'existingTabularColumnGuid'", - "x-discriminator-value": "existingTabularColumnGuid", - "x-discriminator-name": "reason" + "description": "A rollup to a list of values\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'valuesRollup'", + "x-discriminator-value": "valuesRollup", + "x-discriminator-name": "type" }, - "GsaExportFailure": { + "GsaDataModificationErrorDetail": { "required": [ - "failureDetails", - "failureReason", - "type" + "message", + "reason" ], "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/GsaExportFailureType" - }, - "failureDetails": { + "message": { "type": "string" }, - "failureReason": { - "type": "string" + "reason": { + "$ref": "#/components/schemas/GsaDataModificationErrorReason" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaRecordExportFailure](#model-GsaRecordExportFailure)\r\n * [GsaLinkExportFailure](#model-GsaLinkExportFailure)\r\n * [GsaAttributeExportFailure](#model-GsaAttributeExportFailure)\r\n * [GsaDatumExportFailure](#model-GsaDatumExportFailure)\r\n * [GsaRollupExportFailure](#model-GsaRollupExportFailure)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUsageDataModificationErrorDetail", "discriminator": { - "propertyName": "type", + "propertyName": "reason", "mapping": { - "record": "#/components/schemas/GsaRecordExportFailure", - "link": "#/components/schemas/GsaLinkExportFailure", - "attribute": "#/components/schemas/GsaAttributeExportFailure", - "datum": "#/components/schemas/GsaDatumExportFailure", - "rollup": "#/components/schemas/GsaRollupExportFailure" + "usage": "#/components/schemas/GsaUsageDataModificationErrorDetail" } } }, - "GsaExportFailureType": { + "GsaDataModificationErrorReason": { "enum": [ - "record", - "link", - "attribute", - "datum", - "rollup" + "usage" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • record: Record
    • \r\n
  • link: Link
    • \r\n
  • attribute: Attribute
    • \r\n
  • datum: Datum
    • \r\n
  • rollup: The rollup specified is not supported by the attribute data being exported
    • \r\n
\r\n" - }, - "GsaExporterRefetchInfo": { - "type": "object", - "properties": { - "succeeded": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - }, - "additionalProperties": false + "type": "string" }, - "GsaExpression": { + "GsaDataRule": { "required": [ - "attributeDependencies", - "constantDependencies", + "description", "guid", "name", - "parameterDependencies", - "table", - "value" + "regularExpression", + "usedByAttributes" ], "type": "object", "properties": { - "value": { + "description": { "type": "string" }, - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" + "regularExpression": { + "type": "string" }, - "attributeDependencies": { + "usedByAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimAttribute" } }, - "constantDependencies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - }, - "parameterDependencies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, "name": { "type": "string" }, @@ -105288,166 +70874,242 @@ }, "additionalProperties": false }, - "GsaExpressionAccessControlEntity": { + "GsaDataRulesInfo": { + "type": "object", + "properties": { + "dataRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDataRule" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaDataUsageDataModificationErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlEntity" + "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" }, { "required": [ - "expressionGuid", - "tableGuid" + "entityInUse" ], "type": "object", "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "expressionGuid": { - "type": "string", - "format": "uuid" + "entityInUse": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlEntity](#model-GsaAccessControlEntity)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'expression'", - "x-discriminator-value": "expression", - "x-discriminator-name": "entityType" + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'data'", + "x-discriminator-value": "data", + "x-discriminator-name": "referencedByType" }, - "GsaExpressionDeletionException": { + "GsaDatabase": { + "required": [ + "isLocked", + "isReadOnly", + "key", + "status" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDeletionException" + "properties": { + "author": { + "type": "string", + "nullable": true }, - { - "type": "object" + "company": { + "type": "string", + "nullable": true + }, + "notes": { + "type": "string", + "nullable": true + }, + "currencyCode": { + "type": "string", + "nullable": true + }, + "isAccessControlled": { + "type": "boolean", + "nullable": true + }, + "key": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/GsaDatabaseStatus" + }, + "isReadOnly": { + "type": "boolean" + }, + "isLocked": { + "type": "boolean" + }, + "name": { + "type": "string", + "nullable": true + }, + "guid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "versionGuid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "indexInSync": { + "type": "boolean", + "nullable": true + }, + "indexUpToDate": { + "type": "boolean", + "nullable": true + }, + "indexOutOfDateDuration": { + "type": "string", + "format": "date-span", + "nullable": true + }, + "schemaVersion": { + "type": "string", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'expression'", - "x-discriminator-value": "expression", - "x-discriminator-name": "entityType" + }, + "additionalProperties": false }, - "GsaExpressionMathsFunctionalErrorDetail": { + "GsaDatabaseKeyProperty": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "$ref": "#/components/schemas/GsaProperty" }, { "type": "object", "properties": { - "expressionGuid": { + "databaseKey": { "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaMfaExpressionErrorDetail" - }, "nullable": true } } } ], "additionalProperties": false, - "description": "Expression is invalid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expression'", - "x-discriminator-value": "expression", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'databaseKey'", + "x-discriminator-value": "databaseKey", + "x-discriminator-name": "propertyName" }, - "GsaExpressionUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimExpression" - }, - "nullable": true - } - } - } + "GsaDatabaseStatus": { + "enum": [ + "Unknown", + "Ok", + "Unloaded", + "Loading", + "Unloading", + "FailedToLoad", + "FailedToUnload", + "Disabled", + "SchemaUpgradeRequired", + "SchemaDowngradeRequired" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'expression'", - "x-discriminator-value": "expression", - "x-discriminator-name": "referencedByType" + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • Unknown: The current state is unknown.
    • \r\n
  • Ok: The database is working correctly.
    • \r\n
  • Unloaded: The database is not loaded.
    • \r\n
  • Loading: The database is currently being loaded.
    • \r\n
  • Unloading: The database is currently being unloaded.
    • \r\n
  • FailedToLoad: The database failed to be loaded.
    • \r\n
  • FailedToUnload: The database failed to be unloaded.
    • \r\n
  • Disabled: The database is currently disabled.
    • \r\n
  • SchemaUpgradeRequired: The database is at a lower version of the database schema than the current software
    • \r\n
  • SchemaDowngradeRequired: The database is at a higher version of the database schema than the current software
    • \r\n
\r\n" }, - "GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail": { + "GsaDatabaseStatusInformation": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "properties": { + "databaseKey": { + "type": "string", + "description": "Gets the database key for this database.", + "nullable": true }, - { - "type": "object", - "properties": { - "missingParameterGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } + "databaseIsReadOnly": { + "type": "boolean", + "description": "Gets a value indicating whether the database is read only." + }, + "isLocked": { + "type": "boolean", + "description": "Gets a value indicating whether the database is locked for non-admin users." + }, + "state": { + "$ref": "#/components/schemas/GsaDatabaseStatus" + }, + "schemaVersion": { + "type": "string", + "description": "Gets the schema version of the database.", + "nullable": true + }, + "searchIndexInSync": { + "type": "boolean", + "description": "Whether the search indexes for this database are in sync with the database changes" } - ], + }, "additionalProperties": false, - "description": "Parameter lists lacks some parameters required by the chosen expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expressionsHaveUnknownParameters'", - "x-discriminator-value": "expressionsHaveUnknownParameters", - "x-discriminator-name": "reason" + "description": "\r\n\r\nstate: Gets the state of this database." }, - "GsaExpressionsInfo": { + "GsaDatabasesInfo": { "type": "object", "properties": { - "expressions": { + "databases": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimExpression" + "$ref": "#/components/schemas/GsaSlimDatabase" }, "nullable": true } }, "additionalProperties": false }, - "GsaFileAlreadyExistsFileMoveErrorDetail": { + "GsaDateTimeAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" + "$ref": "#/components/schemas/GsaAggregationDatum" }, { "type": "object", "properties": { - "name": { + "minimum": { "type": "string", + "format": "date-time", "nullable": true }, - "parentFolderGuid": { + "maximum": { "type": "string", - "format": "uuid" + "format": "date-time", + "nullable": true } } } ], "additionalProperties": false, - "description": "A file with same name already exists as a child folder of the new parent.\r\n\r\nThis extends: [GsaFileMoveErrorDetail](#model-GsaFileMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'fileAlreadyExists'", - "x-discriminator-value": "fileAlreadyExists", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", + "x-discriminator-name": "datumType" + }, + "GsaDateTimeAggregationDatumCriterion": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + }, + { + "type": "object" + } + ], + "additionalProperties": false, + "description": "Criterion for aggregating data within a datetime attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", + "x-discriminator-name": "type" }, - "GsaFileAttribute": { + "GsaDateTimeAttribute": { "type": "object", "allOf": [ { @@ -105458,38 +71120,11 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", - "x-discriminator-value": "file", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, - "GsaFileCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaFileDatum": { + "GsaDateTimeDatum": { "type": "object", "allOf": [ { @@ -105497,65 +71132,52 @@ }, { "required": [ - "contentIsInSearchIndex", - "contentType", - "description", - "fileName", - "relativeExportUrl", - "target" + "dateTime" ], "type": "object", "properties": { - "fileName": { - "type": "string" - }, - "description": { - "type": "string" - }, - "contentType": { - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/GsaHyperlinkTarget" - }, - "contentIsInSearchIndex": { - "type": "boolean" - }, - "relativeExportUrl": { - "type": "string" + "dateTime": { + "type": "string", + "format": "date-time" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", - "x-discriminator-value": "file", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", "x-discriminator-name": "datumType" }, - "GsaFileDatumCriterion": { + "GsaDateTimeDatumCriterion": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/GsaDatumCriterion" }, { - "required": [ - "value" - ], "type": "object", "properties": { - "value": { - "type": "string" + "gte": { + "type": "string", + "description": "Greater than or equal to", + "format": "date-time", + "nullable": true + }, + "lte": { + "type": "string", + "description": "Less than or equal to", + "format": "date-time", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", - "x-discriminator-value": "file", + "description": "dateTime: Criterion for matching records where the datetime data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, - "GsaFileDatumExistsCriterion": { + "GsaDateTimeDatumExistsCriterion": { "type": "object", "allOf": [ { @@ -105566,2456 +71188,2154 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", - "x-discriminator-value": "file", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, - "GsaFileErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFileErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaConfigInvalidJsonFileErrorDetail](#model-GsaConfigInvalidJsonFileErrorDetail)\r\n * [GsaDescriptionLengthFileErrorDetail](#model-GsaDescriptionLengthFileErrorDetail)\r\n * [GsaFileNameFileErrorDetail](#model-GsaFileNameFileErrorDetail)\r\n * [GsaNamedEntityFileErrorDetail](#model-GsaNamedEntityFileErrorDetail)\r\n * [GsaNoDataFileErrorDetail](#model-GsaNoDataFileErrorDetail)\r\n * [GsaNoFileFileErrorDetail](#model-GsaNoFileFileErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "configInvalidJson": "#/components/schemas/GsaConfigInvalidJsonFileErrorDetail", - "descriptionLength": "#/components/schemas/GsaDescriptionLengthFileErrorDetail", - "fileName": "#/components/schemas/GsaFileNameFileErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityFileErrorDetail", - "noData": "#/components/schemas/GsaNoDataFileErrorDetail", - "noFile": "#/components/schemas/GsaNoFileFileErrorDetail" - } - } - }, - "GsaFileErrorReason": { - "enum": [ - "configInvalidJson", - "descriptionLength", - "fileName", - "namedEntity", - "noData", - "noFile" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • configInvalidJson: Configuration's value must be valid JSON.
    • \r\n
  • descriptionLength: The description exceeds the maximum number of allowed characters.
    • \r\n
  • fileName: The name is not a valid file name.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noData: The File is invalid as it has no data.
    • \r\n
  • noFile: No File found in the Form data.
    • \r\n
\r\n" - }, - "GsaFileHeader": { - "required": [ - "dataLength", - "description", - "extension", - "folderGuid", - "guid", - "name", - "path" - ], + "GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion": { "type": "object", - "properties": { - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "description": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "dataLength": { - "type": "integer", - "format": "int64" - }, - "path": { - "type": "string" - }, - "name": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaFileHeaderInfo": { - "required": [ - "fileHeaders" - ], - "type": "object", - "properties": { - "fileHeaders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileHeader" + { + "required": [ + "interval" + ], + "type": "object", + "properties": { + "interval": { + "$ref": "#/components/schemas/GsaCalendarInterval" + }, + "offset": { + "type": "string", + "description": "Optional offset of the lowest bucket boundary, in SI time units. Must be an integer followed by one of the following units: ms (milliseconds), s (seconds), m (minutes), h (hours), d (days). Defaults to 0. Must be less than the interval. Negative offsets (e.g. \"-6h\") are supported", + "nullable": true + } } } - }, - "additionalProperties": false - }, - "GsaFileMoveErrorDetail": { - "required": [ - "message", - "reason" ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFileMoveErrorReason" - } - }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaFileAlreadyExistsFileMoveErrorDetail](#model-GsaFileAlreadyExistsFileMoveErrorDetail)\r\n * [GsaNoSuchNewParentFileMoveErrorDetail](#model-GsaNoSuchNewParentFileMoveErrorDetail)\r\n * [GsaSameParentFileMoveErrorDetail](#model-GsaSameParentFileMoveErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "fileAlreadyExists": "#/components/schemas/GsaFileAlreadyExistsFileMoveErrorDetail", - "noSuchNewParent": "#/components/schemas/GsaNoSuchNewParentFileMoveErrorDetail", - "sameParent": "#/components/schemas/GsaSameParentFileMoveErrorDetail" - } - } - }, - "GsaFileMoveErrorReason": { - "enum": [ - "fileAlreadyExists", - "noSuchNewParent", - "sameParent" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • fileAlreadyExists: A file with same name already exists as a child folder of the new parent.
    • \r\n
  • noSuchNewParent: A folder with the given GUID does not exist in database.
    • \r\n
  • sameParent: Unable to move file as it is already under this folder.
    • \r\n
\r\n" - }, - "GsaFileMoveException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "fileGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false + "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed calendar interval.\r\n\r\ninterval: Fixed size of the resulting histogram buckets, in a calendar interval\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedCalendarWidthHistogram'", + "x-discriminator-value": "dateTimeFixedCalendarWidthHistogram", + "x-discriminator-name": "type" }, - "GsaFileNameFileErrorDetail": { + "GsaDateTimeFixedWidthHistogramAggregationDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFileErrorDetail" + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, { + "required": [ + "interval" + ], "type": "object", "properties": { - "name": { + "interval": { "type": "string", + "description": "Fixed size of the resulting histogram buckets, in SI time units. Must be an integer followed by one of the following units: ms (milliseconds), s (seconds), m (minutes), h (hours), d (days)" + }, + "offset": { + "type": "string", + "description": "Optional offset of the lowest bucket boundary, in SI time units. Must be an integer followed by one of the following units: ms (milliseconds), s (seconds), m (minutes), h (hours), d (days). Defaults to 0. Must be less than the interval. Negative offsets (e.g. \"-6h\") are supported", "nullable": true } } } ], "additionalProperties": false, - "description": "The name is not a valid file name.\r\nYou cannot use directory separators or special characters in file or folder names.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'fileName'", - "x-discriminator-value": "fileName", - "x-discriminator-name": "reason" + "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedWidthHistogram'", + "x-discriminator-value": "dateTimeFixedWidthHistogram", + "x-discriminator-name": "type" + }, + "GsaDateTimeHistogram": { + "type": "object", + "properties": { + "buckets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDateTimeHistogramBucket" + }, + "nullable": true + } + }, + "additionalProperties": false }, - "GsaFileNameFolderErrorDetail": { + "GsaDateTimeHistogramAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFolderErrorDetail" + "$ref": "#/components/schemas/GsaAggregationDatum" }, { "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true + "histogram": { + "$ref": "#/components/schemas/GsaDateTimeHistogram" } } } ], "additionalProperties": false, - "description": "The name is not a valid file name.\r\nYou cannot use directory separators or special characters in file or folder names.\r\n\r\nThis extends: [GsaFolderErrorDetail](#model-GsaFolderErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'fileName'", - "x-discriminator-value": "fileName", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTimeHistogram'", + "x-discriminator-value": "dateTimeHistogram", + "x-discriminator-name": "datumType" }, - "GsaFilePrefixDatumCriterion": { + "GsaDateTimeHistogramAggregationDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, { - "required": [ - "prefix" - ], "type": "object", "properties": { - "prefix": { - "type": "string" + "maximumNumberOfBuckets": { + "type": "integer", + "description": "The maximum number of buckets to return.", + "format": "int32" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'filePrefix'", - "x-discriminator-value": "filePrefix", + "description": "Criterion for aggregating data within an datetime attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeHistogram'", + "x-discriminator-value": "dateTimeHistogram", "x-discriminator-name": "type" }, - "GsaFileUpdateException": { + "GsaDateTimeHistogramBucket": { "type": "object", "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "fileGuid": { + "lower": { "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" + "format": "date-time" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaFilesInfo": { - "type": "object", - "properties": { - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimFile" - }, - "nullable": true + "count": { + "type": "integer", + "format": "int32" } }, "additionalProperties": false }, - "GsaFindSimilarRequest": { + "GsaDatum": { "required": [ - "similaritySettings" + "notApplicable" ], "type": "object", "properties": { - "similaritySettings": { - "$ref": "#/components/schemas/GsaSimilaritySettings" - }, - "criterion": { - "$ref": "#/components/schemas/GsaFindSimilarSearchCriterion" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nsimilaritySettings: The settings to use for the similarity calculation\r\n\r\ncriterion: Optional filtering for records in the similarity calculation. If not provided, all records will be included." - }, - "GsaFindSimilarResponse": { - "type": "object", - "properties": { - "findSimilarId": { + "notApplicable": { "type": "string", - "description": "The Identifier of the find similar calculation", - "format": "uuid" - }, - "error": { - "$ref": "#/components/schemas/GsaErrorResponse" + "nullable": true } }, "additionalProperties": false, - "description": "\r\n\r\nerror: Will be set if the calculation failed." - }, - "GsaFindSimilarResult": { - "type": "object", - "properties": { - "recordIdentifier": { - "$ref": "#/components/schemas/GsaRecordVersionReference" - }, - "score": { - "type": "number", - "format": "double", - "nullable": true + "description": "\r\n\r\nThis is one of: \r\n * GsaApplicableDatum\r\n * GsaNotApplicableDatum", + "discriminator": { + "propertyName": "notApplicable", + "mapping": { + "applicable": "#/components/schemas/GsaApplicableDatum", + "notApplicable": "#/components/schemas/GsaNotApplicableDatum" } - }, - "additionalProperties": false + } }, - "GsaFindSimilarSearchCriterion": { + "GsaDatumCriterion": { + "required": [ + "type" + ], "type": "object", "properties": { - "subsetCriterion": { - "$ref": "#/components/schemas/GsaRecordSubsetCriterion" - }, - "recordTypeCriterion": { - "$ref": "#/components/schemas/GsaRecordTypeCriterion" + "type": { + "$ref": "#/components/schemas/GsaDatumCriterionType" } }, - "additionalProperties": false - }, - "GsaFindStandardNames": { - "type": "object", - "properties": { - "names": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "additionalProperties": false, + "description": "Inner criterion of an attribute search criterion. The specific criterion used should match the type of the attribute specified on the outer criterion (Note that there are multiple types that can be used with a discrete attribute, depending on the type of search.)\r\n\r\nThis is one of: \r\n * GsaDateTimeDatumCriterion\r\n * GsaDiscreteFunctionalRangeDatumCriterion\r\n * GsaDiscreteFunctionalValuesDatumCriterion\r\n * GsaDiscreteIdentityDatumCriterion\r\n * GsaDiscreteIdentityValuesDatumCriterion\r\n * GsaDiscreteGuidDatumCriterion\r\n * GsaDiscreteGuidValuesDatumCriterion\r\n * GsaDiscreteRangeDatumCriterion\r\n * GsaDiscreteTextDatumCriterion\r\n * GsaDiscreteTextPrefixDatumCriterion\r\n * GsaDiscreteTextValuesDatumCriterion\r\n * GsaFileDatumCriterion\r\n * GsaFilePrefixDatumCriterion\r\n * GsaFloatFunctionalDatumCriterion\r\n * GsaFloatFunctionalGraphDatumCriterion\r\n * GsaHyperlinkDatumCriterion\r\n * GsaHyperlinkPrefixDatumCriterion\r\n * GsaIntegerDatumCriterion\r\n * GsaLinkDatumCriterion\r\n * GsaLogicalDatumCriterion\r\n * GsaLongTextDatumCriterion\r\n * GsaLongTextPrefixDatumCriterion\r\n * GsaMathsFunctionalDatumCriterion\r\n * GsaPictureDatumCriterion\r\n * GsaPointDatumCriterion\r\n * GsaRangeDatumCriterion\r\n * GsaShortTextDatumCriterion\r\n * GsaShortTextPrefixDatumCriterion\r\n * GsaLinkingValueExistsDatumCriterion", + "discriminator": { + "propertyName": "type", + "mapping": { + "dateTime": "#/components/schemas/GsaDateTimeDatumCriterion", + "discreteFunctionalRange": "#/components/schemas/GsaDiscreteFunctionalRangeDatumCriterion", + "discreteFunctionalValues": "#/components/schemas/GsaDiscreteFunctionalValuesDatumCriterion", + "discreteIdentity": "#/components/schemas/GsaDiscreteIdentityDatumCriterion", + "discreteIdentityValues": "#/components/schemas/GsaDiscreteIdentityValuesDatumCriterion", + "discreteGuid": "#/components/schemas/GsaDiscreteGuidDatumCriterion", + "discreteGuidValues": "#/components/schemas/GsaDiscreteGuidValuesDatumCriterion", + "discreteRange": "#/components/schemas/GsaDiscreteRangeDatumCriterion", + "discreteText": "#/components/schemas/GsaDiscreteTextDatumCriterion", + "discreteTextPrefix": "#/components/schemas/GsaDiscreteTextPrefixDatumCriterion", + "discreteTextValues": "#/components/schemas/GsaDiscreteTextValuesDatumCriterion", + "file": "#/components/schemas/GsaFileDatumCriterion", + "filePrefix": "#/components/schemas/GsaFilePrefixDatumCriterion", + "floatFunctionalData": "#/components/schemas/GsaFloatFunctionalDatumCriterion", + "floatFunctionalGraph": "#/components/schemas/GsaFloatFunctionalGraphDatumCriterion", + "hyperlink": "#/components/schemas/GsaHyperlinkDatumCriterion", + "hyperlinkPrefix": "#/components/schemas/GsaHyperlinkPrefixDatumCriterion", + "integer": "#/components/schemas/GsaIntegerDatumCriterion", + "link": "#/components/schemas/GsaLinkDatumCriterion", + "logical": "#/components/schemas/GsaLogicalDatumCriterion", + "longText": "#/components/schemas/GsaLongTextDatumCriterion", + "longTextPrefix": "#/components/schemas/GsaLongTextPrefixDatumCriterion", + "mathsFunctional": "#/components/schemas/GsaMathsFunctionalDatumCriterion", + "picture": "#/components/schemas/GsaPictureDatumCriterion", + "point": "#/components/schemas/GsaPointDatumCriterion", + "range": "#/components/schemas/GsaRangeDatumCriterion", + "shortText": "#/components/schemas/GsaShortTextDatumCriterion", + "shortTextPrefix": "#/components/schemas/GsaShortTextPrefixDatumCriterion", + "dynamicLinkingValue": "#/components/schemas/GsaLinkingValueExistsDatumCriterion" } - }, - "additionalProperties": false + } }, - "GsaFloatFunctionalAggregation": { + "GsaDatumCriterionType": { + "enum": [ + "dateTime", + "discreteFunctionalRange", + "discreteFunctionalValues", + "discreteIdentity", + "discreteIdentityValues", + "discreteGuid", + "discreteGuidValues", + "discreteRange", + "discreteText", + "discreteTextPrefix", + "discreteTextValues", + "file", + "filePrefix", + "floatFunctionalData", + "floatFunctionalGraph", + "hyperlink", + "hyperlinkPrefix", + "integer", + "link", + "logical", + "longText", + "longTextPrefix", + "mathsFunctional", + "picture", + "point", + "range", + "shortText", + "shortTextPrefix", + "dynamicLinkingValue" + ], + "type": "string" + }, + "GsaDatumDiscreteRollup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatum" + "$ref": "#/components/schemas/GsaDatumRollup" }, { + "required": [ + "value" + ], "type": "object", "properties": { - "seriesGraphs": { - "$ref": "#/components/schemas/GsaFloatFunctionalSeriesGraphAggregation" - }, - "gridGraphs": { - "$ref": "#/components/schemas/GsaFloatFunctionalGridGraphAggregation" + "value": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctionalGraph'", - "x-discriminator-value": "floatFunctionalGraph", - "x-discriminator-name": "datumType" + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaFloatFunctionalAggregationDatumCriterion": { + "GsaDatumDoubleRollup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaDatumRollup" }, { + "required": [ + "value" + ], "type": "object", "properties": { - "numberOfParameterValues": { - "type": "integer", - "description": "The maximum number of values to return in this aggregation.", - "format": "int32" + "value": { + "type": "number", + "format": "double" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" } } } ], "additionalProperties": false, - "description": "Criterion for aggregating the graph information within a float functional attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", - "x-discriminator-value": "floatFunctionalGraph", + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", + "x-discriminator-value": "double", "x-discriminator-name": "type" }, - "GsaFloatFunctionalAttribute": { + "GsaDatumExistsCriterion": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/GsaAttributeType" + } + }, + "additionalProperties": false, + "description": "Inner criterion of an attribute search criterion for when the only bit of information about the datum that we want to convey is its type\r\nFor link datum types, linking information must also be provided.\r\n\r\nThis is one of: \r\n * GsaIntegerDatumExistsCriterion\r\n * GsaPointDatumExistsCriterion\r\n * GsaRangeDatumExistsCriterion\r\n * GsaLogicalDatumExistsCriterion\r\n * GsaShortTextDatumExistsCriterion\r\n * GsaLongTextDatumExistsCriterion\r\n * GsaDateTimeDatumExistsCriterion\r\n * GsaDiscreteDatumExistsCriterion\r\n * GsaHyperlinkDatumExistsCriterion\r\n * GsaFileDatumExistsCriterion\r\n * GsaPictureDatumExistsCriterion\r\n * GsaLinkExistsDatumCriterion\r\n * GsaFloatFunctionalDatumExistsCriterion\r\n * GsaDiscreteFunctionalDatumExistsCriterion\r\n * GsaMathsFunctionalDatumExistsCriterion\r\n * GsaTabularDatumExistsCriterion", + "discriminator": { + "propertyName": "type", + "mapping": { + "integer": "#/components/schemas/GsaIntegerDatumExistsCriterion", + "point": "#/components/schemas/GsaPointDatumExistsCriterion", + "range": "#/components/schemas/GsaRangeDatumExistsCriterion", + "logical": "#/components/schemas/GsaLogicalDatumExistsCriterion", + "shortText": "#/components/schemas/GsaShortTextDatumExistsCriterion", + "longText": "#/components/schemas/GsaLongTextDatumExistsCriterion", + "dateTime": "#/components/schemas/GsaDateTimeDatumExistsCriterion", + "discrete": "#/components/schemas/GsaDiscreteDatumExistsCriterion", + "hyperlink": "#/components/schemas/GsaHyperlinkDatumExistsCriterion", + "file": "#/components/schemas/GsaFileDatumExistsCriterion", + "picture": "#/components/schemas/GsaPictureDatumExistsCriterion", + "link": "#/components/schemas/GsaLinkExistsDatumCriterion", + "floatFunctional": "#/components/schemas/GsaFloatFunctionalDatumExistsCriterion", + "discreteFunctional": "#/components/schemas/GsaDiscreteFunctionalDatumExistsCriterion", + "mathsFunctional": "#/components/schemas/GsaMathsFunctionalDatumExistsCriterion", + "tabular": "#/components/schemas/GsaTabularDatumExistsCriterion" + } + } + }, + "GsaDatumExportFailure": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaExportFailure" }, { "required": [ - "attributeParameters", - "isRange" + "failedDatum" ], "type": "object", "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" - }, - "attributeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter" - } - }, - "isRange": { - "type": "boolean" + "failedDatum": { + "$ref": "#/components/schemas/GsaDatumReference" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", - "x-discriminator-value": "floatFunctional", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'datum'", + "x-discriminator-value": "datum", "x-discriminator-name": "type" }, - "GsaFloatFunctionalAttributeDiscreteParameter": { + "GsaDatumIntegerRollup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter" + "$ref": "#/components/schemas/GsaDatumRollup" }, { + "required": [ + "value" + ], "type": "object", "properties": { - "defaultValue": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "value": { + "type": "integer", + "format": "int32" } } } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaFloatFunctionalAttributeParameter](#model-GsaFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "x-discriminator-value": "integer", "x-discriminator-name": "type" }, - "GsaFloatFunctionalAttributeNumericParameter": { + "GsaDatumListRollup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter" + "$ref": "#/components/schemas/GsaDatumRollup" }, { + "required": [ + "listRollupDatums" + ], "type": "object", "properties": { - "defaultValue": { - "type": "number", - "description": "If there is no default value, fallback to the parameter default.", - "format": "double", - "nullable": true - }, - "interpolationMethod": { - "$ref": "#/components/schemas/GsaAttributeInterpolationMethod" - }, - "scaleType": { - "$ref": "#/components/schemas/GsaAttributeScaleType" + "listRollupDatums": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListRollupDatum" + } } } } ], "additionalProperties": false, - "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: [GsaFloatFunctionalAttributeParameter](#model-GsaFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'list'", + "x-discriminator-value": "list", "x-discriminator-name": "type" }, - "GsaFloatFunctionalAttributeParameter": { + "GsaDatumReference": { + "required": [ + "attributeIdentity", + "databaseKey", + "recordHistoryGuid" + ], + "type": "object", + "properties": { + "databaseKey": { + "type": "string" + }, + "recordHistoryGuid": { + "type": "string", + "format": "uuid" + }, + "attributeIdentity": { + "type": "integer", + "format": "int32" + }, + "attributeGuid": { + "type": "string", + "format": "uuid", + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaDatumRollup": { "required": [ - "parameter", "type" ], "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "parameter": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "$ref": "#/components/schemas/GsaDatumRollupType" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaFloatFunctionalAttributeDiscreteParameter](#model-GsaFloatFunctionalAttributeDiscreteParameter)\r\n * [GsaFloatFunctionalAttributeNumericParameter](#model-GsaFloatFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDatumListRollup\r\n * GsaDatumIntegerRollup\r\n * GsaDatumDoubleRollup\r\n * GsaDatumDiscreteRollup", "discriminator": { "propertyName": "type", "mapping": { - "discrete": "#/components/schemas/GsaFloatFunctionalAttributeDiscreteParameter", - "numeric": "#/components/schemas/GsaFloatFunctionalAttributeNumericParameter" + "list": "#/components/schemas/GsaDatumListRollup", + "integer": "#/components/schemas/GsaDatumIntegerRollup", + "double": "#/components/schemas/GsaDatumDoubleRollup", + "discrete": "#/components/schemas/GsaDatumDiscreteRollup" } } }, - "GsaFloatFunctionalDatum": { + "GsaDatumRollupType": { + "enum": [ + "list", + "integer", + "double", + "discrete" + ], + "type": "string", + "description": "The datum rollups supported by the API.

Possible values:

\r\n
    \r\n
  • list: List datum rollup
    • \r\n
  • integer: Integer datum rollup
    • \r\n
  • double: Double datum rollup
    • \r\n
  • discrete: Discrete datum rollup
    • \r\n
\r\n" + }, + "GsaDatumType": { + "enum": [ + "integer", + "logical", + "shortText", + "longText", + "hyperlink", + "dateTime", + "discrete", + "range", + "point", + "picture", + "file", + "floatFunctional", + "discreteFunctional", + "tabular" + ], + "type": "string", + "description": "The types of datum that are supported by the API.

Possible values:

\r\n
    \r\n
  • integer: Integer
    • \r\n
  • logical: Logical
    • \r\n
  • shortText: Short Text
    • \r\n
  • longText: Integer
    • \r\n
  • hyperlink: Integer
    • \r\n
  • dateTime: Date and Time
    • \r\n
  • discrete: Discrete
    • \r\n
  • range: Range
    • \r\n
  • point: Point
    • \r\n
  • picture: Picture
    • \r\n
  • file: File
    • \r\n
  • floatFunctional: Float Functional
    • \r\n
  • discreteFunctional: Discrete Functional
    • \r\n
  • tabular: Tabular
    • \r\n
\r\n" + }, + "GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaApplicableDatum" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, { - "required": [ - "estimated", - "graphType", - "isRange", - "logScaleOnYAxis", - "parameterSettings", - "showAsTable" - ], - "type": "object", - "properties": { - "graphType": { - "$ref": "#/components/schemas/GsaGraphType" - }, - "logScaleOnYAxis": { - "type": "boolean" - }, - "estimated": { - "type": "boolean" - }, - "showAsTable": { - "type": "boolean" - }, - "isRange": { - "type": "boolean" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" - }, - "parameterSettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFunctionalParameterSetting" - } - } - }, - "discriminator": { - "propertyName": "graphType", - "mapping": { - "series": "#/components/schemas/GsaFloatFunctionalSeriesDatum", - "grid": "#/components/schemas/GsaFloatFunctionalGridDatum" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * [GsaFloatFunctionalSeriesDatum](#model-GsaFloatFunctionalSeriesDatum)\r\n * [GsaFloatFunctionalGridDatum](#model-GsaFloatFunctionalGridDatum)", - "x-discriminator-value": "floatFunctional", - "x-discriminator-name": "datumType" + "description": "Default expression must be from attribute's expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultExpressionNotFound'", + "x-discriminator-value": "defaultExpressionNotFound", + "x-discriminator-name": "reason" }, - "GsaFloatFunctionalDatumCriterion": { + "GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + }, + { + "type": "object" + } + ], + "additionalProperties": false, + "description": "Default free parameter must be from attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultFreeParameterNotFound'", + "x-discriminator-value": "defaultFreeParameterNotFound", + "x-discriminator-name": "reason" + }, + "GsaDefaultParameterValueUsageDataModificationErrorDetail": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" }, { "type": "object", "properties": { - "gte": { - "type": "number", - "description": "Greater than or equal to", - "format": "double", - "nullable": true - }, - "lte": { - "type": "number", - "description": "Less than or equal to", - "format": "double", - "nullable": true - }, - "constraints": { + "referencedBy": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaParameterConstraint" + "$ref": "#/components/schemas/GsaSlimNamedEntity" }, - "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.", "nullable": true } } } ], "additionalProperties": false, - "description": "floatFunctionalData: Criterion for matching records with float functional data\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalData'", - "x-discriminator-value": "floatFunctionalData", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'defaultParameterValue'", + "x-discriminator-value": "defaultParameterValue", + "x-discriminator-name": "referencedByType" }, - "GsaFloatFunctionalDatumExistsCriterion": { + "GsaDeleteRecordListItem": { + "required": [ + "databaseGuid", + "recordHistoryGuid" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "properties": { + "databaseGuid": { + "type": "string", + "format": "uuid" }, - { - "type": "object" + "recordHistoryGuid": { + "type": "string", + "format": "uuid" + }, + "recordVersion": { + "type": "integer", + "description": "Optional version. If not provided, only matching items with no version will be deleted. If provided, only items matching the version exactly will be deleted.", + "format": "int32", + "nullable": true } + }, + "additionalProperties": false + }, + "GsaDeleteRecordListItems": { + "required": [ + "items" ], - "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", - "x-discriminator-value": "floatFunctional", - "x-discriminator-name": "type" + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDeleteRecordListItem" + } + } + }, + "additionalProperties": false }, - "GsaFloatFunctionalGraphDatumCriterion": { + "GsaDiscreteAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaAttribute" }, { + "required": [ + "discreteType", + "isMultiValued" + ], "type": "object", "properties": { - "xAxisParameterIdentity": { - "type": "integer", - "description": "Optional x axis parameter filter. Only series graphs have an x axis.", - "format": "int32", - "nullable": true - }, - "xAxisParameterGuid": { - "type": "string", - "description": "Optional x axis parameter filter. Only series graphs have an x axis.", - "format": "uuid", - "nullable": true - }, - "numberOfSeriesLte": { - "type": "integer", - "description": "Optional filter for the number of series.", - "format": "int32", - "nullable": true - }, - "numberOfSeriesGte": { - "type": "integer", - "description": "Optional filter for the number of series.", - "format": "int32", - "nullable": true - }, - "showAsTable": { - "type": "boolean", - "description": "Optional filter for data on the \"Show as table\" property", - "nullable": true - }, - "defaultXAxisParameterIdentity": { - "type": "integer", - "description": "Optional default x axis parameter filter. Only grid graphs have a default x axis.", - "format": "int32", - "nullable": true - }, - "defaultXAxisParameterGuid": { - "type": "string", - "description": "Optional x axis parameter filter. Only grid graphs have a default x axis..", - "format": "uuid", - "nullable": true - }, - "numberOfPointsLte": { - "type": "integer", - "description": "Optional filter for the number of points in a grid graph.", - "format": "int32", - "nullable": true - }, - "numberOfPointsGte": { - "type": "integer", - "description": "Optional filter for the number of points in a grid graph.", - "format": "int32", - "nullable": true + "discreteType": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" }, - "isSeriesGraph": { - "type": "boolean", - "description": "Optional filter for data on the type of graph", - "nullable": true + "isMultiValued": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "floatFunctionalGraph: Criterion for matching records with float functional data\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", - "x-discriminator-value": "floatFunctionalGraph", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, - "GsaFloatFunctionalGridDatum": { + "GsaDiscreteDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFloatFunctionalDatum" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { "required": [ - "graph" + "discreteValues" ], "type": "object", "properties": { - "graph": { - "$ref": "#/components/schemas/GsaFloatGridGraph" + "discreteValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + } } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaFloatFunctionalDatum](#model-GsaFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", - "x-discriminator-value": "grid", - "x-discriminator-name": "graphType" - }, - "GsaFloatFunctionalGridGraphAggregation": { - "type": "object", - "properties": { - "defaultXAxisParameterIdentityValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaValueWithCountOfInt32" - }, - "nullable": true - }, - "defaultXAxisParameterGuidValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaValueWithCountOfGuid" - }, - "nullable": true - }, - "showAsTableValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaValueWithCountOfBoolean" - }, - "nullable": true - }, - "minimumNumberOfPoints": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "maximumNumberOfPoints": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "count": { - "type": "integer", - "description": "The number of record where the data is a series graph", - "format": "int32" - } - }, - "additionalProperties": false + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "datumType" }, - "GsaFloatFunctionalSeriesDatum": { + "GsaDiscreteDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFloatFunctionalDatum" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { - "required": [ - "graph" - ], - "type": "object", - "properties": { - "graph": { - "$ref": "#/components/schemas/GsaFloatSeriesGraph" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaFloatFunctionalDatum](#model-GsaFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", - "x-discriminator-value": "series", - "x-discriminator-name": "graphType" - }, - "GsaFloatFunctionalSeriesGraphAggregation": { - "type": "object", - "properties": { - "xAxisParameterIdentityValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaValueWithCountOfInt32" - }, - "nullable": true - }, - "xAxisParameterGuidValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaValueWithCountOfGuid" - }, - "nullable": true - }, - "showAsTableValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaValueWithCountOfBoolean" - }, - "nullable": true - }, - "minimumNumberOfSeries": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "maximumNumberOfSeries": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "count": { - "type": "integer", - "description": "The number of record where the data is a series graph", - "format": "int32" - } - }, - "additionalProperties": false + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaFloatGridGraph": { + "GsaDiscreteFunctionalAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaGridGraph" + "$ref": "#/components/schemas/GsaAttribute" }, { "required": [ - "points" + "attributeParameters", + "discreteType" ], "type": "object", "properties": { - "points": { + "discreteType": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "attributeParameters": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaFloatGridPoint" + "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter" } } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGridGraph](#model-GsaGridGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", - "x-discriminator-value": "float", - "x-discriminator-name": "functionalType" - }, - "GsaFloatGridPoint": { - "required": [ - "constraints", - "estimated", - "highValue", - "lowValue" - ], - "type": "object", - "properties": { - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterWithDataValue" - } - }, - "lowValue": { - "type": "number", - "format": "double" - }, - "highValue": { - "type": "number", - "format": "double" - }, - "estimated": { - "type": "boolean" - } - }, - "additionalProperties": false + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "x-discriminator-value": "discreteFunctional", + "x-discriminator-name": "type" }, - "GsaFloatSeries": { - "required": [ - "constraints", - "graphDecoration", - "points" - ], + "GsaDiscreteFunctionalAttributeDiscreteParameter": { "type": "object", - "properties": { - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterWithDataValue" - } + "allOf": [ + { + "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter" }, - "points": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFloatSeriesPoint" + { + "type": "object", + "properties": { + "defaultValue": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } } - }, - "graphDecoration": { - "$ref": "#/components/schemas/GsaGraphDecorationType" } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaFloatSeriesGraph": { + "GsaDiscreteFunctionalAttributeNumericParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaSeriesGraph" + "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter" }, { - "required": [ - "series" - ], "type": "object", "properties": { - "series": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFloatSeries" - } + "defaultValue": { + "type": "number", + "description": "If there is no default value, fallback to the parameter default.", + "format": "double", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSeriesGraph](#model-GsaSeriesGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", - "x-discriminator-value": "float", - "x-discriminator-name": "functionalType" + "description": "\r\n\r\nThis extends: GsaDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" }, - "GsaFloatSeriesPoint": { + "GsaDiscreteFunctionalAttributeParameter": { "required": [ - "estimated", - "xValue", - "yHighValue", - "yLowValue" + "parameter", + "type" ], "type": "object", "properties": { - "xValue": { - "type": "number", - "format": "double" - }, - "yLowValue": { - "type": "number", - "format": "double" - }, - "yHighValue": { - "type": "number", - "format": "double" + "type": { + "$ref": "#/components/schemas/GsaParameterType" }, - "estimated": { - "type": "boolean" + "parameter": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" } }, - "additionalProperties": false - }, - "GsaFolder": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "parentGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "hasFiles": { - "type": "boolean" - }, - "hasChildFolders": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaDiscreteFunctionalAttributeNumericParameter", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaDiscreteFunctionalAttributeDiscreteParameter", + "numeric": "#/components/schemas/GsaDiscreteFunctionalAttributeNumericParameter" } - }, - "additionalProperties": false + } }, - "GsaFolderAlreadyExistsFolderMoveErrorDetail": { + "GsaDiscreteFunctionalDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { + "required": [ + "graphType", + "parameterSettings" + ], "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true + "graphType": { + "$ref": "#/components/schemas/GsaGraphType" }, - "newParentFolderGuid": { - "type": "string", - "format": "uuid" + "parameterSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaFunctionalParameterSetting" + } + } + }, + "discriminator": { + "propertyName": "graphType", + "mapping": { + "series": "#/components/schemas/GsaDiscreteFunctionalSeriesDatum", + "grid": "#/components/schemas/GsaDiscreteFunctionalGridDatum" } } } ], "additionalProperties": false, - "description": "A folder with same name already exists as a child folder of the new parent.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'folderAlreadyExists'", - "x-discriminator-value": "folderAlreadyExists", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * GsaDiscreteFunctionalSeriesDatum\r\n * GsaDiscreteFunctionalGridDatum", + "x-discriminator-value": "discreteFunctional", + "x-discriminator-name": "datumType" }, - "GsaFolderCreationException": { + "GsaDiscreteFunctionalDatumExistsCriterion": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - "nullable": true + { + "type": "object" } - }, - "additionalProperties": false - }, - "GsaFolderDeletionErrorDetail": { - "required": [ - "message", - "reason" ], + "additionalProperties": false, + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "x-discriminator-value": "discreteFunctional", + "x-discriminator-name": "type" + }, + "GsaDiscreteFunctionalGridDatum": { "type": "object", - "properties": { - "message": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/GsaDiscreteFunctionalDatum" }, - "reason": { - "$ref": "#/components/schemas/GsaFolderDeletionErrorReason" + { + "required": [ + "graph" + ], + "type": "object", + "properties": { + "graph": { + "$ref": "#/components/schemas/GsaDiscreteGridGraph" + } + } } - }, - "additionalProperties": false - }, - "GsaFolderDeletionErrorReason": { - "enum": [ - "root" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • root: You cannot delete the root folder.
    • \r\n
\r\n" + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "x-discriminator-value": "grid", + "x-discriminator-name": "graphType" }, - "GsaFolderDeletionException": { + "GsaDiscreteFunctionalRangeDatumCriterion": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumCriterion" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderDeletionErrorDetail" - }, - "nullable": true + { + "type": "object", + "properties": { + "gte": { + "type": "integer", + "description": "Greater than or equal to", + "format": "int32", + "nullable": true + }, + "lte": { + "type": "integer", + "description": "Less than or equal to", + "format": "int32", + "nullable": true + }, + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterConstraint" + }, + "description": "Optional unit string. If not included, the gte and lte values are assumed to be in database units.", + "nullable": true + } + } } - }, - "additionalProperties": false - }, - "GsaFolderErrorDetail": { - "required": [ - "message", - "reason" ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFolderErrorReason" - } - }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaFileNameFolderErrorDetail](#model-GsaFileNameFolderErrorDetail)\r\n * [GsaNamedEntityFolderErrorDetail](#model-GsaNamedEntityFolderErrorDetail)\r\n * [GsaUpdateRootFolderErrorDetail](#model-GsaUpdateRootFolderErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "fileName": "#/components/schemas/GsaFileNameFolderErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityFolderErrorDetail", - "updateRoot": "#/components/schemas/GsaUpdateRootFolderErrorDetail" - } - } - }, - "GsaFolderErrorReason": { - "enum": [ - "fileName", - "namedEntity", - "updateRoot" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • fileName: The name is not a valid file name.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • updateRoot: You cannot edit the root folder.
    • \r\n
\r\n" + "description": "discreteFunctionalRange: Criterion for matching records with discrete functional data where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalRange'", + "x-discriminator-value": "discreteFunctionalRange", + "x-discriminator-name": "type" }, - "GsaFolderMoveErrorDetail": { - "required": [ - "message", - "reason" - ], + "GsaDiscreteFunctionalSeriesDatum": { "type": "object", - "properties": { - "message": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/GsaDiscreteFunctionalDatum" }, - "reason": { - "$ref": "#/components/schemas/GsaFolderMoveErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCircularReferenceFolderMoveErrorDetail](#model-GsaCircularReferenceFolderMoveErrorDetail)\r\n * [GsaFolderAlreadyExistsFolderMoveErrorDetail](#model-GsaFolderAlreadyExistsFolderMoveErrorDetail)\r\n * [GsaNoSuchNewParentFolderMoveErrorDetail](#model-GsaNoSuchNewParentFolderMoveErrorDetail)\r\n * [GsaRootFolderMoveErrorDetail](#model-GsaRootFolderMoveErrorDetail)\r\n * [GsaSameParentFolderMoveErrorDetail](#model-GsaSameParentFolderMoveErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "circularReference": "#/components/schemas/GsaCircularReferenceFolderMoveErrorDetail", - "folderAlreadyExists": "#/components/schemas/GsaFolderAlreadyExistsFolderMoveErrorDetail", - "noSuchNewParent": "#/components/schemas/GsaNoSuchNewParentFolderMoveErrorDetail", - "root": "#/components/schemas/GsaRootFolderMoveErrorDetail", - "sameParent": "#/components/schemas/GsaSameParentFolderMoveErrorDetail" + { + "required": [ + "graph" + ], + "type": "object", + "properties": { + "graph": { + "$ref": "#/components/schemas/GsaDiscreteSeriesGraph" + } + } } - } - }, - "GsaFolderMoveErrorReason": { - "enum": [ - "circularReference", - "folderAlreadyExists", - "noSuchNewParent", - "root", - "sameParent" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • circularReference: Circular reference found - you cannot move a folder to be a child of one of its descendants.
    • \r\n
  • folderAlreadyExists: A folder with same name already exists as a child folder of the new parent.
    • \r\n
  • noSuchNewParent: A folder with the given GUID does not exist in the database.
    • \r\n
  • root: You cannot move the root folder.
    • \r\n
  • sameParent: Unable to move folder as it is already under this folder.
    • \r\n
\r\n" + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "x-discriminator-value": "series", + "x-discriminator-name": "graphType" }, - "GsaFolderMoveException": { + "GsaDiscreteFunctionalValuesDatumCriterion": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumCriterion" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - "nullable": true + { + "type": "object", + "properties": { + "anyIdentities": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Match any of these discrete type identities", + "nullable": true + }, + "anyGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "description": "Match any of these discrete type GUIDs", + "nullable": true + }, + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterConstraint" + }, + "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.", + "nullable": true + } + } } - }, - "additionalProperties": false - }, - "GsaFolderType": { - "enum": [ - "homePage", - "helpPage", - "exporter", - "configuration" ], - "type": "string" + "additionalProperties": false, + "description": "discreteFunctionalValues: Criterion for matching records with discrete functional data where the discrete values are one of the given values. Either identities or GUIDs should be provided.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalValues'", + "x-discriminator-value": "discreteFunctionalValues", + "x-discriminator-name": "type" }, - "GsaFolderUpdateException": { + "GsaDiscreteGraphParameterValue": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaGraphParameterValue" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaFoldersInfo": { - "type": "object", - "properties": { - "folders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolder" - }, - "nullable": true + { + "required": [ + "parameterValueGuid" + ], + "type": "object", + "properties": { + "parameterValueGuid": { + "type": "string", + "format": "uuid" + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaGraphParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "parameterType" }, - "GsaForbidOrphansRecordLinkGroupErrorDetail": { + "GsaDiscreteGraphValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "$ref": "#/components/schemas/GsaGraphValue" }, { - "type": "object" + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + } + } } ], "additionalProperties": false, - "description": "To set forbid orphans, all records in the target table must be linked to a record in the source table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'forbidOrphans'", - "x-discriminator-value": "forbidOrphans", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaGraphValue\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "graphValueType" }, - "GsaFreeTextAggregation": { + "GsaDiscreteGridGraph": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregation" + "$ref": "#/components/schemas/GsaGridGraph" }, { + "required": [ + "points" + ], "type": "object", "properties": { - "guid": { - "type": "string", - "description": "The GUID of the input aggregation criterion.", - "format": "uuid" - }, - "terms": { + "points": { "type": "array", "items": { - "type": "string" - }, - "description": "The topmost terms in the specified attributes, across all relevant records. Due to how\r\nmatches in multiple attributes are reconciled, we cannot easily provide a document count,\r\nnor can we guarantee that the terms are perfectly correctly ordered.", - "nullable": true + "$ref": "#/components/schemas/GsaDiscreteGridPoint" + } } } } ], "additionalProperties": false, - "description": "The results of aggregation over an attribute.\r\n\r\nThis extends: [GsaAggregation](#model-GsaAggregation)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", - "x-discriminator-value": "text", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaGridGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "functionalType" }, - "GsaFreeTextAggregationCriterion": { + "GsaDiscreteGridPoint": { + "required": [ + "constraints", + "estimated", + "value" + ], + "type": "object", + "properties": { + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterWithDataValue" + } + }, + "value": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + }, + "estimated": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "GsaDiscreteGuidDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationCriterion" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { + "required": [ + "value" + ], "type": "object", "properties": { - "criterionGuid": { + "value": { "type": "string", - "description": "A GUID to identify this free-text criterion, so that its results can be determined in the output.\r\nFor each input free-text aggregation criterion, there will be a free-text aggregation in the output\r\nwith a matching GUID.", "format": "uuid" - }, - "numberOfTerms": { - "type": "integer", - "description": "The number of terms that should be returned", - "format": "int32" - }, - "prefix": { - "type": "string", - "nullable": true - }, - "attributes": { - "$ref": "#/components/schemas/GsaValueSpecifier" - }, - "localColumns": { - "$ref": "#/components/schemas/GsaValueSpecifier" } } } ], "additionalProperties": false, - "description": "A criterion for requesting a free text aggregation over a set of attributes and tabular local columns.\r\nUses ValueSpecifiers to specify how to filter on attributes and local columns.\r\nAt least one filter must be specified.\r\n\r\nThis extends: [GsaAggregationCriterion](#model-GsaAggregationCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", - "x-discriminator-value": "text", + "description": "discreteGuid: Criterion for matching records where the GUID of the discrete data matches the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuid'", + "x-discriminator-value": "discreteGuid", "x-discriminator-name": "type" }, - "GsaFreeTextCriterion": { + "GsaDiscreteGuidValuesDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaCriterion" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { "type": "object", "properties": { - "value": { - "type": "string", - "nullable": true - }, - "attributes": { - "$ref": "#/components/schemas/GsaValueSpecifier" - }, - "localColumns": { - "$ref": "#/components/schemas/GsaValueSpecifier" - }, - "attributeIdentitiesToBoost": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBoostByIdentity" - }, - "nullable": true - }, - "attributeGuidsToBoost": { + "all": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaBoostByGuid" + "type": "string", + "format": "uuid" }, + "description": "Match all of these discrete value GUIDs", "nullable": true }, - "columnIdentitiesToBoost": { + "any": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaBoostByIdentity" + "type": "string", + "format": "uuid" }, + "description": "Match any of these discrete type GUIDs", "nullable": true }, - "columnGuidsToBoost": { + "none": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaBoostByGuid" + "type": "string", + "format": "uuid" }, + "description": "Match none of the discrete type GUIDs", "nullable": true } } } ], "additionalProperties": false, - "description": "Base type for free text criteria.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", - "x-discriminator-value": "text", + "description": "discreteGuidValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value GUIDs. One or more field can be null.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuidValues'", + "x-discriminator-value": "discreteGuidValues", + "x-discriminator-name": "type" + }, + "GsaDiscreteIdentityDatumCriterion": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumCriterion" + }, + { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "integer", + "format": "int32" + } + } + } + ], + "additionalProperties": false, + "description": "discreteIdentity: Criterion for matching records where the identity of the discrete data matches the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentity'", + "x-discriminator-value": "discreteIdentity", "x-discriminator-name": "type" }, - "GsaFreeTextPrefixCriterion": { + "GsaDiscreteIdentityValuesDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaCriterion" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { - "required": [ - "prefix" - ], "type": "object", "properties": { - "prefix": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/GsaValueSpecifier" - }, - "localColumns": { - "$ref": "#/components/schemas/GsaValueSpecifier" - }, - "attributeIdentitiesToBoost": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBoostByIdentity" - }, - "nullable": true - }, - "attributeGuidsToBoost": { + "all": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaBoostByGuid" + "type": "integer", + "format": "int32" }, + "description": "Match all of these discrete value identities", "nullable": true }, - "columnIdentitiesToBoost": { + "any": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaBoostByIdentity" + "type": "integer", + "format": "int32" }, + "description": "Match any of these discrete type identities", "nullable": true }, - "columnGuidsToBoost": { + "none": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaBoostByGuid" + "type": "integer", + "format": "int32" }, + "description": "Match none of the discrete type identities", "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'textPrefix'", - "x-discriminator-value": "textPrefix", + "description": "discreteIdentityValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value identities. One or more field can be null.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentityValues'", + "x-discriminator-value": "discreteIdentityValues", "x-discriminator-name": "type" }, - "GsaFullLayoutSection": { + "GsaDiscreteParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaLayoutSection" + "$ref": "#/components/schemas/GsaParameter" }, { "required": [ - "sectionItems" + "values" ], "type": "object", "properties": { - "sectionItems": { + "values": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaLayoutItem" + "$ref": "#/components/schemas/GsaDiscreteParameterValue" } } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutSection](#model-GsaLayoutSection)\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'full'", - "x-discriminator-value": "full", - "x-discriminator-name": "sectionDetailType" + "description": "\r\n\r\nThis extends: GsaParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaFullNameProperty": { + "GsaDiscreteParameterContent": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaProperty" + "$ref": "#/components/schemas/GsaParameterContent" }, { "type": "object", "properties": { - "fullName": { - "type": "string", - "nullable": true + "parameterValue": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "parameterRange": { + "$ref": "#/components/schemas/GsaDiscreteRange" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'fullName'", - "x-discriminator-value": "fullName", - "x-discriminator-name": "propertyName" + "description": "\r\n\r\nThis extends: GsaParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaFuncNoParamsAttributeErrorDetail": { + "GsaDiscreteParameterDataValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaParameterDataValue" }, { - "type": "object" + "required": [ + "parameterValue" + ], + "type": "object", + "properties": { + "parameterValue": { + "$ref": "#/components/schemas/GsaDiscreteParameterValue" + } + } } ], "additionalProperties": false, - "description": "Functional attributes must have at least one parameter.\r\nFunctional attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'funcNoParams'", - "x-discriminator-value": "funcNoParams", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaParameterDataValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "parameterType" }, - "GsaFunctionalDataDefaultUsageDataModificationErrorDetail": { + "GsaDiscreteParameterNameConstraint": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "$ref": "#/components/schemas/GsaParameterConstraint" }, { - "type": "object" + "type": "object", + "properties": { + "any": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "none": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'functionalDataDefault'", - "x-discriminator-value": "functionalDataDefault", - "x-discriminator-name": "referencedByType" - }, - "GsaFunctionalDatumParameterInfo": { - "type": "object", - "properties": { - "scaleTypeDefinedAt": { - "$ref": "#/components/schemas/GsaParameterSettingDefinedAt" - }, - "interpolationMethodDefinedAt": { - "$ref": "#/components/schemas/GsaParameterSettingDefinedAt" - }, - "defaultValueDefinedAt": { - "$ref": "#/components/schemas/GsaParameterSettingDefinedAt" - }, - "name": { - "type": "string", - "nullable": true - }, - "identity": { - "type": "integer", - "format": "int32" - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "unitSymbol": { - "type": "string", - "nullable": true - }, - "scaleType": { - "$ref": "#/components/schemas/GsaParameterInfoScaleType" - }, - "interpolationType": { - "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" - }, - "parameterType": { - "$ref": "#/components/schemas/GsaParameterInfoParameterType" - }, - "defaultValue": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" - } - }, - "additionalProperties": false + "description": "\r\n\r\nThis extends: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteName'", + "x-discriminator-value": "discreteName", + "x-discriminator-name": "type" }, - "GsaFunctionalParameterSetting": { - "required": [ - "defaultValue", - "interpolationType", - "parameter", - "scaleType" - ], + "GsaDiscreteParameterValue": { "type": "object", - "properties": { - "parameter": { - "$ref": "#/components/schemas/GsaSlimParameter" - }, - "defaultValue": { - "$ref": "#/components/schemas/GsaParameterDataValue" - }, - "scaleType": { - "$ref": "#/components/schemas/GsaParameterScaleType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaParameterValue" }, - "interpolationType": { - "$ref": "#/components/schemas/GsaParameterInterpolationType" + { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + } } - }, - "additionalProperties": false - }, - "GsaFunctionalType": { - "enum": [ - "float", - "discrete" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • float: Float functional
    • \r\n
  • discrete: Discrete functional
    • \r\n
\r\n" + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" }, - "GsaGeneralUnitEquationErrorDetail": { + "GsaDiscreteParameterValueConstraint": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" + "$ref": "#/components/schemas/GsaParameterConstraint" }, { - "type": "object" + "type": "object", + "properties": { + "any": { + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "nullable": true + }, + "none": { + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "nullable": true + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'general'", - "x-discriminator-value": "general", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteValue'", + "x-discriminator-value": "discreteValue", + "x-discriminator-name": "type" }, - "GsaGeneratedIntegrationSchemaOfObjectIdentifier": { + "GsaDiscreteRange": { "required": [ - "schema" + "parameterValues" ], "type": "object", "properties": { - "warnings": { + "parameterValues": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaIntegrationSchemaGenerationErrorDetail" - }, - "nullable": true - }, - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } } }, "additionalProperties": false }, - "GsaGetFindSimilarResultsResponse": { + "GsaDiscreteRangeDatumCriterion": { "type": "object", - "properties": { - "findSimilarId": { - "type": "string", - "description": "The Identifier of the find similar calculation", - "format": "uuid" - }, - "calculationComplete": { - "type": "boolean", - "description": "Indicates whether the calculation is complete. Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.Results will only be populated if this is true." - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFindSimilarResult" - }, - "description": "Results of the find similar calculation, only set if Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.CalculationComplete is true and Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.Error is not set.", - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumCriterion" }, - "error": { - "$ref": "#/components/schemas/GsaErrorResponse" + { + "type": "object", + "properties": { + "gte": { + "type": "integer", + "description": "Greater than or equal to", + "format": "int32", + "nullable": true + }, + "lte": { + "type": "integer", + "description": "Less than or equal to", + "format": "int32", + "nullable": true + } + } } - }, + ], "additionalProperties": false, - "description": "\r\n\r\nerror: Will be set if the calculation failed. If this is set, then" - }, - "GsaGetJobsResponse": { - "type": "object", - "properties": { - "totalResultCount": { - "type": "integer", - "format": "int32" - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaJob" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaGetJobsSummaryResponse": { - "type": "object", - "properties": { - "jobs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaJobTypeAndStatus" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaGetModifiableRecordVersionControlException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "recordVersionGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaVersionControlErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false + "description": "discreteRange: Criterion for matching records for where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteRange'", + "x-discriminator-value": "discreteRange", + "x-discriminator-name": "type" }, - "GsaGetUnitConversionsRequest": { + "GsaDiscreteSeries": { "required": [ - "conversions" + "constraints", + "points" ], "type": "object", "properties": { - "conversions": { + "constraints": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUnitConversionSetRequest" + "$ref": "#/components/schemas/GsaParameterWithDataValue" } - } - }, - "additionalProperties": false - }, - "GsaGetUnitEquivalentsException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { + "points": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - "nullable": true + "$ref": "#/components/schemas/GsaDiscreteSeriesPoint" + } } }, "additionalProperties": false }, - "GsaGraph": { - "required": [ - "graphType" - ], + "GsaDiscreteSeriesGraph": { "type": "object", - "properties": { - "graphType": { - "$ref": "#/components/schemas/GsaGraphType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSeriesGraph](#model-GsaSeriesGraph)\r\n * [GsaGridGraph](#model-GsaGridGraph)", - "discriminator": { - "propertyName": "graphType", - "mapping": { - "series": "#/components/schemas/GsaSeriesGraph", - "grid": "#/components/schemas/GsaGridGraph" + "allOf": [ + { + "$ref": "#/components/schemas/GsaSeriesGraph" + }, + { + "required": [ + "series" + ], + "type": "object", + "properties": { + "series": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDiscreteSeries" + } + } + } } - } - }, - "GsaGraphDecorationType": { - "enum": [ - "linesOnly", - "markersOnly", - "linesAndMarkers" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • linesOnly: Graph shows only lines.
    • \r\n
  • markersOnly: Graph shows only markers.
    • \r\n
  • linesAndMarkers: Graph shows both lines and markers.
    • \r\n
\r\n" + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaSeriesGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "functionalType" }, - "GsaGraphEvaluationSettings": { + "GsaDiscreteSeriesPoint": { "required": [ - "parametersWithValues" + "estimated", + "value", + "xValue" ], "type": "object", "properties": { - "parametersWithValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaGraphParameterWithValue" - } + "xValue": { + "type": "number", + "format": "double" + }, + "value": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + }, + "estimated": { + "type": "boolean" } }, "additionalProperties": false }, - "GsaGraphParameterValue": { - "required": [ - "parameterType" - ], + "GsaDiscreteTextAggregation": { "type": "object", - "properties": { - "parameterType": { - "$ref": "#/components/schemas/GsaParameterType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregationDatum" + }, + { + "type": "object", + "properties": { + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaTermWithCount" + }, + "nullable": true + } + } } - }, + ], "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteGraphParameterValue](#model-GsaDiscreteGraphParameterValue)\r\n * [GsaNumericGraphParameterValue](#model-GsaNumericGraphParameterValue)", - "discriminator": { - "propertyName": "parameterType", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteGraphParameterValue", - "numeric": "#/components/schemas/GsaNumericGraphParameterValue" - } - } + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteText'", + "x-discriminator-value": "discreteText", + "x-discriminator-name": "datumType" }, - "GsaGraphParameterWithValue": { - "required": [ - "parameterGuid", - "parameterValue" - ], + "GsaDiscreteTextAggregationDatumCriterion": { "type": "object", - "properties": { - "parameterGuid": { - "type": "string", - "format": "uuid" + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, - "parameterValue": { - "$ref": "#/components/schemas/GsaGraphParameterValue" - } - }, - "additionalProperties": false - }, - "GsaGraphType": { - "enum": [ - "series", - "grid" + { + "type": "object", + "properties": { + "numberOfTerms": { + "type": "integer", + "description": "The maximum number of terms to return in this aggregation.", + "format": "int32" + }, + "prefix": { + "type": "string", + "description": "An optional textual prefix. If provided, only terms that start with this prefix will be\r\nconsidered in the aggregation.", + "nullable": true + } + } + } ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • series: Series graph
    • \r\n
  • grid: Gridded graph
    • \r\n
\r\n" + "additionalProperties": false, + "description": "Criterion for aggregating textual data within a discrete attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", + "x-discriminator-value": "discreteText", + "x-discriminator-name": "type" }, - "GsaGraphValue": { - "required": [ - "graphValueType" - ], + "GsaDiscreteTextDatumCriterion": { "type": "object", - "properties": { - "graphValueType": { - "$ref": "#/components/schemas/GsaGraphValueType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteGraphValue](#model-GsaDiscreteGraphValue)\r\n * [GsaRangeGraphValue](#model-GsaRangeGraphValue)\r\n * [GsaNoValueExistsGraphValue](#model-GsaNoValueExistsGraphValue)", - "discriminator": { - "propertyName": "graphValueType", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteGraphValue", - "range": "#/components/schemas/GsaRangeGraphValue", - "noValueExists": "#/components/schemas/GsaNoValueExistsGraphValue" + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumCriterion" + }, + { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "textMatchBehavior": { + "$ref": "#/components/schemas/GsaTextMatchBehavior" + } + } } - } - }, - "GsaGraphValueType": { - "enum": [ - "discrete", - "range", - "noValueExists" ], - "type": "string" + "additionalProperties": false, + "description": "discreteText: Criterion for matching records where the text of the discrete data contains the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", + "x-discriminator-value": "discreteText", + "x-discriminator-name": "type" }, - "GsaGrid": { - "required": [ - "headers", - "rows" - ], + "GsaDiscreteTextPrefixDatumCriterion": { "type": "object", - "properties": { - "headers": { - "type": "array", - "items": { - "type": "string" - } + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumCriterion" }, - "rows": { - "type": "array", - "items": { - "type": "array", - "items": { + { + "required": [ + "prefix" + ], + "type": "object", + "properties": { + "prefix": { "type": "string" } } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "discreteTextPrefix: Criterion for matching records where the text of the discrete data begins with the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextPrefix'", + "x-discriminator-value": "discreteTextPrefix", + "x-discriminator-name": "type" }, - "GsaGridGraph": { + "GsaDiscreteTextValuesDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaGraph" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { - "required": [ - "allParameters", - "defaultXAxisParameter", - "functionalType" - ], "type": "object", "properties": { - "functionalType": { - "$ref": "#/components/schemas/GsaFunctionalType" + "all": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "defaultXAxisParameter": { - "$ref": "#/components/schemas/GsaSlimParameter" + "any": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "allParameters": { + "none": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimParameter" - } - } - }, - "discriminator": { - "propertyName": "functionalType", - "mapping": { - "float": "#/components/schemas/GsaFloatGridGraph", - "discrete": "#/components/schemas/GsaDiscreteGridGraph" + "type": "string" + }, + "nullable": true + }, + "textMatchBehavior": { + "$ref": "#/components/schemas/GsaTextMatchBehavior" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraph](#model-GsaGraph)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'\r\n\r\nThis is one of: \r\n * [GsaFloatGridGraph](#model-GsaFloatGridGraph)\r\n * [GsaDiscreteGridGraph](#model-GsaDiscreteGridGraph)", - "x-discriminator-value": "grid", - "x-discriminator-name": "graphType" + "description": "discreteTextValues: Criterion for matching records where the text in the discrete data matches all, any and/or none of the specified text strings. One of more field can be null.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextValues'", + "x-discriminator-value": "discreteTextValues", + "x-discriminator-name": "type" }, - "GsaGuidOnlyAttribute": { + "GsaDiscreteType": { "required": [ + "discreteValues", "guid", - "name", - "type" + "isOrdered", + "name" ], "type": "object", "properties": { + "discreteValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + } + }, + "isOrdered": { + "type": "boolean" + }, "name": { "type": "string" }, "guid": { "type": "string", "format": "uuid" - }, - "type": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "unitSymbol": { + } + }, + "additionalProperties": false + }, + "GsaDiscreteTypeDeletionException": { + "type": "object", + "properties": { + "message": { "type": "string", - "description": "If isUnitted is true, then this must have a non empty value", - "nullable": true - }, - "isUnitted": { - "type": "boolean", "nullable": true }, - "discreteTypeGuid": { - "type": "string", - "description": "A discrete attribute must define the guid of its discrete type (i.e. list of possible values)", - "format": "uuid", - "nullable": true + "code": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, - "parameters": { + "errors": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationParameterInfo" + "$ref": "#/components/schemas/GsaDataModificationErrorDetail" }, - "description": "A float functional attribute must define a list of parameters.", - "nullable": true - }, - "targetDatabase": { - "$ref": "#/components/schemas/GsaObjectIdentifier" - }, - "targetTable": { - "$ref": "#/components/schemas/GsaObjectIdentifier" - }, - "graphType": { - "type": "string", - "description": "A float functional attribute must be either a Series or a Grid type graph.", - "nullable": true - }, - "xAxisParameter": { - "type": "string", - "description": "A float functional attribute must define an x-axis. This will be one of the parameters listed in parameters", "nullable": true } }, - "additionalProperties": false, - "description": "An attribute as defined in an integration schema.\r\n\r\ntargetDatabase: A link attribute must define the database of the linked records.\r\n\r\ntargetTable: A link attribute must define the table of the linked records." + "additionalProperties": false }, - "GsaGuidOnlyDiscreteType": { + "GsaDiscreteTypeUsage": { "required": [ - "guid" + "attributes", + "tabularColumns" ], "type": "object", "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string", - "nullable": true + "attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimAttribute" + } }, - "values": { + "tabularColumns": { "type": "array", "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/GsaTabularAttributeWithColumns" + } } }, - "additionalProperties": false, - "description": "An integration schema discrete type defines the list of values that a discrete attribute can take." + "additionalProperties": false }, - "GsaGuidOnlyIntegrationParameterInfo": { - "required": [ - "guid" - ], + "GsaDiscreteTypesInfo": { "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "unitSymbol": { - "type": "string", + "discreteTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimDiscreteType" + }, "nullable": true - }, - "scaleType": { - "$ref": "#/components/schemas/GsaParameterInfoScaleType" - }, - "interpolationType": { - "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" - }, - "parameterType": { - "$ref": "#/components/schemas/GsaParameterInfoParameterType" - }, - "defaultValue": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" } }, "additionalProperties": false }, - "GsaGuidOnlyIntegrationSchemaOfObjectIdentifier": { + "GsaDiscreteValue": { "type": "object", "properties": { - "key": { + "value": { "type": "string", "nullable": true }, - "version": { + "order": { "type": "integer", "format": "int32", "nullable": true - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaGuidOnlyAttribute" - }, - "nullable": true - }, - "layouts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaGuidOnlyLayout" - }, - "nullable": true - }, - "unitSystem": { - "type": "string", - "nullable": true - }, - "discreteTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaGuidOnlyDiscreteType" - }, - "nullable": true - }, - "sources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaGuidOnlySourceOfObjectIdentifier" - }, - "nullable": true - }, - "accessControlCategoryValues": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "nullable": true - }, - "securityGroups": { - "$ref": "#/components/schemas/GsaSecurityGroups" - }, - "similaritySettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSimilaritySettings" - }, - "nullable": true } }, - "additionalProperties": false, - "description": "Similar to IntegrationSchema, but without identities.\r\nUsed when we don't want consumers to specify/know about identities." + "additionalProperties": false }, - "GsaGuidOnlyLayout": { + "GsaDiscreteValueAggregateErrorReason": { + "enum": [ + "discreteValueAdditionErrors", + "discreteValueDeletionErrors", + "discreteValueUpdateErrors", + "discreteValueReplacingErrors" + ], + "type": "string" + }, + "GsaDiscreteValueAggregateException": { + "required": [ + "reason" + ], "type": "object", "properties": { - "name": { + "message": { "type": "string", "nullable": true }, - "attributeGuids": { + "reason": { + "$ref": "#/components/schemas/GsaDiscreteValueAggregateErrorReason" + }, + "code": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" + }, + "errors": { "type": "array", "items": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaErrorDetail" }, "nullable": true } }, - "additionalProperties": false, - "description": "An integration schema layout is named list of attribute identities." + "additionalProperties": false }, - "GsaGuidOnlyMappingOfObjectIdentifier": { + "GsaDiscreteValuesCreateDiscreteValue": { + "required": [ + "name" + ], "type": "object", "properties": { - "source": { - "$ref": "#/components/schemas/GsaObjectIdentifier" + "name": { + "type": "string" }, - "targetGuid": { + "guid": { "type": "string", - "description": "The guid of the integration schema attribute", "format": "uuid" - }, - "parameterMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaGuidOnlyMappingOfObjectIdentifier" - }, - "description": "Any mapped parameters (float functional attributes only). The target parameters must be defined on the target integration attribute.\r\nNot every parameters from the source database needs to be mapped for each attribute.", - "nullable": true - }, - "linkSourceType": { - "$ref": "#/components/schemas/GsaLinkSourceType" } }, "additionalProperties": false, - "description": "A mapping between a source database item and an integration schema attribute." + "description": "Create dto for Discrete Values\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types" }, - "GsaGuidOnlySourceOfObjectIdentifier": { + "GsaDiscreteValuesDiscreteValue": { "required": [ - "mappings", - "table" + "guid", + "name" ], "type": "object", "properties": { - "database": { - "$ref": "#/components/schemas/GsaObjectIdentifier" + "name": { + "type": "string" }, - "databaseKey": { + "guid": { "type": "string", - "nullable": true - }, - "table": { - "$ref": "#/components/schemas/GsaObjectIdentifier" - }, - "mappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaGuidOnlyMappingOfObjectIdentifier" - }, - "description": "Mappings for items from this table to the integration schema attributes." + "format": "uuid" } }, - "additionalProperties": false, - "description": "A source table from which integrated data will be taken." + "additionalProperties": false }, - "GsaHelpPathsValidationResponse": { - "required": [ - "attributes", - "parameters" - ], + "GsaDiscreteValuesDiscreteValuesInfo": { "type": "object", "properties": { - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimAttributeWithHelpPath" - } - }, - "parameters": { + "discreteValues": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimParameterWithHelpPath" - } + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + }, + "nullable": true } }, "additionalProperties": false }, - "GsaHistogram": { + "GsaDiscreteValuesReplaceDiscreteValuesInfo": { "type": "object", "properties": { - "buckets": { + "discreteValues": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaHistogramBucket" + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" }, "nullable": true } }, "additionalProperties": false }, - "GsaHistogramBucket": { + "GsaDiscreteValuesUpdateDiscreteValue": { "type": "object", "properties": { - "lower": { - "type": "number", - "format": "double" + "name": { + "type": "string" }, - "upper": { - "type": "number", - "format": "double", - "nullable": true + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaDiskStatus": { + "enum": [ + "Ok", + "LowWatermarkReached", + "HighWatermarkReached", + "FloodStageReached" + ], + "type": "string", + "description": "The status of the amount of space remaining on the disk.

Possible values:

\r\n
    \r\n
  • Ok: There is enough space.
    • \r\n
  • LowWatermarkReached: Once the disk reaches this point, Elasticsearch will not allocate any more shards to this node.
    • \r\n
  • HighWatermarkReached: At this point, Elasticsearch will attempt to relocate shards away from this node.
    • \r\n
  • FloodStageReached: At this point, Elastic search will enforce a read only block on the index.
    • \r\n
\r\n" + }, + "GsaDoubleSortingValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaSortingValue" }, - "count": { - "type": "integer", - "format": "int32" + { + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "double" + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaSortingValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", + "x-discriminator-value": "double", + "x-discriminator-name": "type" + }, + "GsaDuplicateDatabaseAddDatabaseValidationIssue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" + }, + { + "required": [ + "databaseKey", + "databaseName" + ], + "type": "object", + "properties": { + "databaseKey": { + "type": "string" + }, + "databaseName": { + "type": "string" + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateDatabase'", + "x-discriminator-value": "duplicateDatabase", + "x-discriminator-name": "IssueType" + }, + "GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + }, + { + "type": "object", + "properties": { + "duplicatedGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "nullable": true + } + } + } + ], + "additionalProperties": false, + "description": "No duplicate expression GUIDs allowed.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateExpressionGuids'", + "x-discriminator-value": "duplicateExpressionGuids", + "x-discriminator-name": "reason" + }, + "GsaDuplicateGuidAddDatabaseValidationIssue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" + }, + { + "required": [ + "clashingDatabases" + ], + "type": "object", + "properties": { + "clashingDatabases": { + "type": "array", + "items": { + "type": "string" + } + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateGuid'", + "x-discriminator-value": "duplicateGuid", + "x-discriminator-name": "IssueType" }, - "GsaHyperlinkAttribute": { + "GsaDuplicateKeyAddDatabaseValidationIssue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", - "x-discriminator-value": "hyperlink", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateKey'", + "x-discriminator-value": "duplicateKey", + "x-discriminator-name": "IssueType" }, - "GsaHyperlinkDatum": { + "GsaDuplicateParameterGuidsAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaApplicableDatum" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { - "required": [ - "address", - "description", - "target" - ], "type": "object", "properties": { - "address": { - "type": "string" - }, - "description": { - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/GsaHyperlinkTarget" + "duplicatedGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", - "x-discriminator-value": "hyperlink", - "x-discriminator-name": "datumType" + "description": "No duplicate parameter GUIDs allowed.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateParameterGuids'", + "x-discriminator-value": "duplicateParameterGuids", + "x-discriminator-name": "reason" }, - "GsaHyperlinkDatumCriterion": { + "GsaDuplicateTabularColumnGuidsErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { - "required": [ - "value" - ], "type": "object", "properties": { - "value": { - "type": "string" + "duplicatedGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "hyperlink: Criterion for matching records where the hyperlink description contains the given value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", - "x-discriminator-value": "hyperlink", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnGuids'", + "x-discriminator-value": "duplicateTabularColumnGuids", + "x-discriminator-name": "reason" }, - "GsaHyperlinkDatumExistsCriterion": { + "GsaDuplicateTabularColumnNamesErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { - "type": "object" + "type": "object", + "properties": { + "duplicatedNames": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", - "x-discriminator-value": "hyperlink", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnNames'", + "x-discriminator-value": "duplicateTabularColumnNames", + "x-discriminator-name": "reason" }, - "GsaHyperlinkPrefixDatumCriterion": { + "GsaDuplicateVersionGuidAddDatabaseValidationIssue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" }, { "required": [ - "prefix" + "clashingDatabase", + "clashingVersionGuid" ], "type": "object", "properties": { - "prefix": { - "type": "string" + "clashingDatabase": { + "type": "string", + "description": "The database key of the database with the same version GUID" + }, + "clashingVersionGuid": { + "type": "string", + "format": "uuid" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlinkPrefix'", - "x-discriminator-value": "hyperlinkPrefix", - "x-discriminator-name": "type" - }, - "GsaHyperlinkTarget": { - "enum": [ - "newWindow", - "top", - "parent", - "tree", - "content", - "currentFrame" - ], - "type": "string", - "description": "A target for a `HyperlinkDatum`

Possible values:

\r\n
    \r\n
  • newWindow: Target a new window (equivalent to \"_blank\").
    • \r\n
  • top: Target the topmost frame of the current frameset (equivalent to \"_top\").
    • \r\n
  • parent: Target the parent frame of the current frame (equivalent to \"_parent\").
    • \r\n
  • tree: Target the left-hand side frame.
    • \r\n
  • content: Target the right-hand side frame.
    • \r\n
  • currentFrame: Target the current frame (equivalent to \"_self\").
    • \r\n
\r\n" + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateVersionGuid'", + "x-discriminator-value": "duplicateVersionGuid", + "x-discriminator-name": "IssueType" }, - "GsaInUseParameterValueErrorDetail": { + "GsaDynamicLinkGroupUsageDataModificationErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" + "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" }, { "type": "object", "properties": { - "parameterValueGuid": { - "type": "string", - "format": "uuid" - }, - "usedByType": { - "$ref": "#/components/schemas/GsaParameterValueUsedByType" + "referencedBy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "The parameter value is being used by an attribute.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'inUse'", - "x-discriminator-value": "inUse", - "x-discriminator-name": "reason" - }, - "GsaInclusiveness": { - "enum": [ - "inclusive", - "exclusive" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • inclusive: Inclusive
    • \r\n
  • exclusive: Exclusive
    • \r\n
\r\n" + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'dynamicLinkGroup'", + "x-discriminator-value": "dynamicLinkGroup", + "x-discriminator-name": "referencedByType" }, - "GsaIncompatibleUnitsErrorDetail": { + "GsaDynamicRecordLinkGroup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, { + "required": [ + "attributePairs", + "forbidOrphans", + "referentialIntegrityModel" + ], "type": "object", "properties": { - "unitGuid": { - "type": "string", - "format": "uuid" + "forbidOrphans": { + "type": "boolean" }, - "equivalentUnitGuid": { - "type": "string", - "format": "uuid" + "referentialIntegrityModel": { + "$ref": "#/components/schemas/GsaReferentialIntegrityModel" + }, + "attributePairs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAttributeLinkPair" + } } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'incompatibleUnits'", - "x-discriminator-value": "incompatibleUnits", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamic'", + "x-discriminator-value": "dynamic", + "x-discriminator-name": "type" }, - "GsaIndexRecordFailure": { + "GsaEmptyAxisNameAttributeErrorDetail": { "type": "object", - "properties": { - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "recordName": { - "type": "string", - "nullable": true - }, - "error": { - "type": "string", - "description": "This is the error message from the indexing exception. It may have been returned directly from Elasticsearch.", - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, - "recordWasOversized": { - "type": "boolean", - "description": "Records that contain a large amount of data are intentionally not sent to the index. This size limit is configurable through\r\nMIServer.exe.config" + { + "type": "object" } - }, - "additionalProperties": false, - "description": "Detail of a record that has failed to successfully index. A record that was not indexed will not be returned\r\nas a result in any searches." - }, - "GsaIndirectLinks": { - "enum": [ - "fromLinkDefinition", - "include", - "exclude" ], - "type": "string" + "additionalProperties": false, + "description": "Axis name cannot be empty or whitespace.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptyAxisName'", + "x-discriminator-value": "emptyAxisName", + "x-discriminator-name": "reason" }, - "GsaInputConnectionDetails": { + "GsaEnabledLicensesInfo": { "required": [ - "dataSource", - "initialCatalog" + "isFlexLicensingEnabled", + "miServerEnabled", + "MLEnabled", + "PLMSyncEnabled", + "restrictedSubstancesBAEnabled", + "sustainabilityEnabledEnabled", + "workflowAdvancedEnabled" ], "type": "object", "properties": { - "dataSource": { - "type": "string", - "description": "The SQL server data source" + "isFlexLicensingEnabled": { + "type": "boolean", + "description": "Gets a flag indicating whether FlexLM licensing is enabled. If true, MI is in Ansys\r\nlicensing mode. If false, MI is in classic licensing mode." }, - "initialCatalog": { - "type": "string", - "description": "The name of the database in SQL server" + "miServerEnabled": { + "type": "boolean", + "description": "Gets a flag indicating whether MI Server is enabled. In Ansys licensing mode, this corresponds\r\nto an MI Server license having been checked out. In classic licensing mode, it is set to true." }, - "useConfigurationDatabaseCredentials": { + "workflowAdvancedEnabled": { "type": "boolean", - "description": "Set to true if the SQL connection should use the credentials from the Configuration database." + "description": "Gets a flag indicating whether advanced workflow features are enabled. In Ansys\r\nlicensing mode, this corresponds to a Workflow Advanced license having been checked out. In classic licensing mode, it\r\nis set to true." }, - "useIntegratedSecurity": { + "restrictedSubstancesBAEnabled": { "type": "boolean", - "description": "Set to true if the SQL connection to the database should use Windows authentication" + "description": "Gets a flag indicating whether features associated with the Restricted Substances Analytics\r\nproduct are enabled. In Ansys licensing mode, this corresponds to a Restricted Substances Analytics license (granta_mi_rsba) having been checked\r\nout. In classic licensing mode, it is set to false." }, - "sqlCredentials": { - "$ref": "#/components/schemas/GsaSqlCredentials" + "sustainabilityEnabledEnabled": { + "type": "boolean", + "description": "Gets a flag indicating whether features associated with the Sustainability Analytics\r\nproduct are enabled. In Ansys licensing mode, this corresponds to a Sustainability Analytics license (granta_mi_sus) having been checked\r\nout. In classic licensing mode, it is set to false." }, - "additionalSqlParameters": { + "PLMSyncEnabled": { + "type": "boolean", + "description": "Gets a flag indicating whether features associated with the PLM Sync (notably MI Enterprise Connect) are enabled.\r\nIn Ansys licensing mode, this corresponds to a PLM sync license having been checked out. In classic licensing mode, it is set to true." + }, + "MLEnabled": { + "type": "boolean", + "description": "Gets a flag indicating whether features associated with the ML (Machine Learning) are enabled.\r\nIn Ansys licensing mode, this corresponds to a ML license having been checked out. In classic licensing mode, it is set to false." + }, + "expiryDate": { "type": "string", - "description": "(Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format.", + "description": "Gets expiry date of Server license.", + "format": "date-time", "nullable": true } }, "additionalProperties": false, - "description": "\r\n\r\nsqlCredentials: The credentials to use if the database should use SQL authentication." + "description": "Stores information about the state of the MI Server license." }, - "GsaInputValidationErrorDetail": { + "GsaEntityAlreadyExistsErrorDetail": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + }, + { + "type": "object", + "properties": { + "guid": { + "type": "string", + "format": "uuid" + } + } + } + ], + "additionalProperties": false, + "description": "Entity with GUID already exists.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityAlreadyExists'", + "x-discriminator-value": "entityAlreadyExists", + "x-discriminator-name": "reason" + }, + "GsaEntityIdentifierAlreadySpecifiedErrorDetail": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + }, + { + "type": "object", + "properties": { + "guid": { + "type": "string", + "format": "uuid" + } + } + } + ], + "additionalProperties": false, + "description": "GUID has been specified more than once in the request.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityIdentifierAlreadySpecified'", + "x-discriminator-value": "entityIdentifierAlreadySpecified", + "x-discriminator-name": "reason" + }, + "GsaErrorDetail": { "required": [ "message", "reason" @@ -108026,1116 +73346,1061 @@ "type": "string" }, "reason": { - "$ref": "#/components/schemas/GsaInputValidationErrorReason" + "type": "string" } }, "additionalProperties": false }, - "GsaInputValidationErrorReason": { - "enum": [ - "UnitConversionDoesNotExistError", - "InputIsNullOrEmpty" - ], - "type": "string" - }, - "GsaIntegerAggregation": { + "GsaExcludeValuesSpecifier": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatum" + "$ref": "#/components/schemas/GsaValueSpecifier" }, { "type": "object", "properties": { - "minimum": { - "type": "integer", - "format": "int32", + "excludedIdentities": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, "nullable": true }, - "maximum": { - "type": "integer", - "format": "int32", + "excludedGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "datumType" + "description": "Filters based on a list of identities or guids to exclude.\r\nAll other guids or identities will be included.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'exclude'", + "x-discriminator-value": "exclude", + "x-discriminator-name": "filterOn" }, - "GsaIntegerAggregationDatumCriterion": { + "GsaExistingTabularColumnGuidErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { - "type": "object" + "type": "object", + "properties": { + "existingGuid": { + "type": "string", + "format": "uuid" + } + } } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'existingTabularColumnGuid'", + "x-discriminator-value": "existingTabularColumnGuid", + "x-discriminator-name": "reason" }, - "GsaIntegerAttribute": { + "GsaExportFailure": { + "required": [ + "failureDetails", + "failureReason", + "type" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttribute" + "properties": { + "type": { + "$ref": "#/components/schemas/GsaExportFailureType" }, - { - "required": [ - "isUnique" - ], - "type": "object", - "properties": { - "isUnique": { - "type": "boolean", - "description": "Whether or not the attribute is constrained to contain a unique value" - } - } + "failureDetails": { + "type": "string" + }, + "failureReason": { + "type": "string" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis is one of: \r\n * GsaRecordExportFailure\r\n * GsaLinkExportFailure\r\n * GsaAttributeExportFailure\r\n * GsaDatumExportFailure\r\n * GsaRollupExportFailure", + "discriminator": { + "propertyName": "type", + "mapping": { + "record": "#/components/schemas/GsaRecordExportFailure", + "link": "#/components/schemas/GsaLinkExportFailure", + "attribute": "#/components/schemas/GsaAttributeExportFailure", + "datum": "#/components/schemas/GsaDatumExportFailure", + "rollup": "#/components/schemas/GsaRollupExportFailure" + } + } + }, + "GsaExportFailureType": { + "enum": [ + "record", + "link", + "attribute", + "datum", + "rollup" + ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • record: Record
    • \r\n
  • link: Link
    • \r\n
  • attribute: Attribute
    • \r\n
  • datum: Datum
    • \r\n
  • rollup: The rollup specified is not supported by the attribute data being exported
    • \r\n
\r\n" + }, + "GsaExporterRefetchInfo": { + "type": "object", + "properties": { + "succeeded": { + "type": "boolean" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "GsaExpression": { + "required": [ + "attributeDependencies", + "constantDependencies", + "guid", + "name", + "parameterDependencies", + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" + }, + "attributeDependencies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimAttribute" + } + }, + "constantDependencies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + }, + "parameterDependencies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false }, - "GsaIntegerChartData": { + "GsaExpressionMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaChartData" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, { "type": "object", "properties": { - "value": { - "type": "integer", - "format": "int32" + "expressionGuid": { + "type": "string", + "format": "uuid" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaMfaExpressionErrorDetail" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "type" + "description": "Expression is invalid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expression'", + "x-discriminator-value": "expression", + "x-discriminator-name": "reason" }, - "GsaIntegerDatum": { + "GsaExpressionUsageDataModificationErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaApplicableDatum" + "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" }, { - "required": [ - "value" - ], "type": "object", "properties": { - "value": { - "type": "integer", - "format": "int32" + "referencedBy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "datumType" + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'expression'", + "x-discriminator-value": "expression", + "x-discriminator-name": "referencedByType" }, - "GsaIntegerDatumCriterion": { + "GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, { "type": "object", "properties": { - "gte": { - "type": "integer", - "description": "Greater than or equal to", - "format": "int32", - "nullable": true - }, - "lte": { - "type": "integer", - "description": "Less than or equal to", - "format": "int32", + "missingParameterGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, "nullable": true } } } - ], - "additionalProperties": false, - "description": "integer: Criterion for matching records where the integer data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "type" + ], + "additionalProperties": false, + "description": "Parameter lists lacks some parameters required by the chosen expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expressionsHaveUnknownParameters'", + "x-discriminator-value": "expressionsHaveUnknownParameters", + "x-discriminator-name": "reason" + }, + "GsaExpressionsInfo": { + "type": "object", + "properties": { + "expressions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimExpression" + }, + "nullable": true + } + }, + "additionalProperties": false }, - "GsaIntegerDatumExistsCriterion": { + "GsaFileAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "$ref": "#/components/schemas/GsaAttribute" }, { "type": "object" } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "x-discriminator-value": "file", "x-discriminator-name": "type" }, - "GsaIntegerFixedWidthHistogramAggregationDatumCriterion": { + "GsaFileDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { + "required": [ + "contentIsInSearchIndex", + "contentType", + "description", + "fileName", + "relativeExportUrl", + "target" + ], "type": "object", "properties": { - "interval": { - "type": "number", - "description": "Fixed size of the resulting histogram buckets", - "format": "double" + "fileName": { + "type": "string" }, - "offset": { - "type": "number", - "description": "Offset of the lowest bucket boundary. Defaults to 0. Must be less than the interval.", - "format": "double" + "description": { + "type": "string" + }, + "contentType": { + "type": "string" + }, + "target": { + "$ref": "#/components/schemas/GsaHyperlinkTarget" + }, + "contentIsInSearchIndex": { + "type": "boolean" + }, + "relativeExportUrl": { + "type": "string" } } } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerFixedWidthHistogram'", - "x-discriminator-value": "integerFixedWidthHistogram", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", + "x-discriminator-value": "file", + "x-discriminator-name": "datumType" }, - "GsaIntegerHistogramAggregation": { + "GsaFileDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatum" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { + "required": [ + "value" + ], "type": "object", "properties": { - "histogram": { - "$ref": "#/components/schemas/GsaHistogram" + "value": { + "type": "string" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integerHistogram'", - "x-discriminator-value": "integerHistogram", - "x-discriminator-name": "datumType" + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "x-discriminator-value": "file", + "x-discriminator-name": "type" }, - "GsaIntegerHistogramAggregationDatumCriterion": { + "GsaFileDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { - "type": "object", - "properties": { - "maximumNumberOfBuckets": { - "type": "integer", - "format": "int32" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerHistogram'", - "x-discriminator-value": "integerHistogram", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "x-discriminator-value": "file", "x-discriminator-name": "type" }, - "GsaIntegrationAttribute": { + "GsaFileHeader": { "required": [ + "dataLength", + "description", + "extension", + "folderGuid", + "guid", "name", - "type" + "path" ], "type": "object", "properties": { - "name": { - "type": "string" - }, - "identity": { - "type": "integer", - "format": "int32" - }, - "guid": { + "folderGuid": { "type": "string", "format": "uuid" }, - "type": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "unitSymbol": { - "type": "string", - "description": "If isUnitted is true, then this must have a non empty value", - "nullable": true + "description": { + "type": "string" }, - "isUnitted": { - "type": "boolean", - "nullable": true + "extension": { + "type": "string" }, - "discreteTypeIdentity": { + "dataLength": { "type": "integer", - "format": "int32", - "nullable": true - }, - "discreteTypeGuid": { - "type": "string", - "description": "A discrete attribute must define the guid of its discrete type (i.e. list of possible values)", - "format": "uuid", - "nullable": true - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationParameterInfo" - }, - "description": "A float functional attribute must define a list of parameters.", - "nullable": true - }, - "targetDatabase": { - "$ref": "#/components/schemas/GsaObjectIdentifier" + "format": "int64" }, - "targetTable": { - "$ref": "#/components/schemas/GsaObjectIdentifier" + "path": { + "type": "string" }, - "graphType": { - "type": "string", - "description": "A float functional attribute must be either a Series or a Grid type graph.", - "nullable": true + "name": { + "type": "string" }, - "xAxisParameter": { + "guid": { "type": "string", - "description": "A float functional attribute must define an x-axis. This will be one of the parameters listed in parameters", - "nullable": true + "format": "uuid" } }, - "additionalProperties": false, - "description": "An attribute as defined in an integration schema.\r\n\r\ntargetDatabase: A link attribute must define the database of the linked records.\r\n\r\ntargetTable: A link attribute must define the table of the linked records." + "additionalProperties": false }, - "GsaIntegrationDataExportRequest": { - "required": [ - "attributeIdentities" + "GsaFilePrefixDatumCriterion": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatumCriterion" + }, + { + "required": [ + "prefix" + ], + "type": "object", + "properties": { + "prefix": { + "type": "string" + } + } + } ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'filePrefix'", + "x-discriminator-value": "filePrefix", + "x-discriminator-name": "type" + }, + "GsaFilesInfo": { "type": "object", "properties": { - "recordReferences": { + "files": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaRecordReference" + "$ref": "#/components/schemas/GsaSlimFile" }, - "description": "A list of record references to export. These are references to the underlying records in the source database.\r\nData can be exported for either record histories or record versions in each request, not both.", "nullable": true - }, - "attributeIdentities": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "A list of attribute to export. These are the attribute identities from the integration schema." } }, "additionalProperties": false }, - "GsaIntegrationDiscreteType": { + "GsaFindSearchRequest": { "type": "object", "properties": { - "identity": { - "type": "integer", - "format": "int32" - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { + "nameContains": { "type": "string", "nullable": true - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true } }, - "additionalProperties": false, - "description": "An integration schema discrete type defines the list of values that a discrete attribute can take." + "additionalProperties": false }, - "GsaIntegrationLayout": { + "GsaFindStandardNames": { "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true - }, - "attributeIdentities": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "attributeGuids": { + "names": { "type": "array", "items": { - "type": "string", - "format": "uuid" + "type": "string" }, "nullable": true } }, - "additionalProperties": false, - "description": "An integration schema layout is named list of attribute identities." + "additionalProperties": false }, - "GsaIntegrationParameterInfo": { + "GsaFloatFunctionalAggregation": { "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "identity": { - "type": "integer", - "format": "int32" - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "unitSymbol": { - "type": "string", - "nullable": true - }, - "scaleType": { - "$ref": "#/components/schemas/GsaParameterInfoScaleType" - }, - "interpolationType": { - "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" - }, - "parameterType": { - "$ref": "#/components/schemas/GsaParameterInfoParameterType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregationDatum" }, - "defaultValue": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" + { + "type": "object", + "properties": { + "seriesGraphs": { + "$ref": "#/components/schemas/GsaFloatFunctionalSeriesGraphAggregation" + }, + "gridGraphs": { + "$ref": "#/components/schemas/GsaFloatFunctionalGridGraphAggregation" + } + } } - }, - "additionalProperties": false - }, - "GsaIntegrationSchemaGenerationErrorDetail": { - "required": [ - "message", - "reason" ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctionalGraph'", + "x-discriminator-value": "floatFunctionalGraph", + "x-discriminator-name": "datumType" + }, + "GsaFloatFunctionalAggregationDatumCriterion": { "type": "object", - "properties": { - "message": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, - "reason": { - "$ref": "#/components/schemas/GsaSchemaGenerationWarningReason" + { + "type": "object", + "properties": { + "numberOfParameterValues": { + "type": "integer", + "description": "The maximum number of values to return in this aggregation.", + "format": "int32" + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "Criterion for aggregating the graph information within a float functional attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", + "x-discriminator-value": "floatFunctionalGraph", + "x-discriminator-name": "type" }, - "GsaIntegrationSchemaOfObjectIdentifier": { + "GsaFloatFunctionalAttribute": { "type": "object", - "properties": { - "key": { - "type": "string", - "nullable": true - }, - "version": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationAttribute" - }, - "nullable": true - }, - "layouts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationLayout" - }, - "nullable": true - }, - "unitSystem": { - "type": "string", - "nullable": true - }, - "discreteTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationDiscreteType" - }, - "nullable": true - }, - "sources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" - }, - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/GsaAttribute" }, - "accessControlCategoryValues": { + { + "required": [ + "attributeParameters", + "isRange" + ], "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" + "properties": { + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" }, - "nullable": true - }, - "nullable": true - }, - "securityGroups": { - "$ref": "#/components/schemas/GsaSecurityGroups" - }, - "similaritySettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSimilaritySettings" - }, - "nullable": true + "attributeParameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter" + } + }, + "isRange": { + "type": "boolean" + } + } } - }, + ], "additionalProperties": false, - "description": "A type representing an integration schema. An integration schema is a schema that describes\r\na shape that data must conform to, similar to an MI schema, but unlike an MI schema, an\r\nintegration schema does not have any corresponding data stored in it. Instead, an integration\r\nschema defines mappings or transformations from existing stored data, which may be a different\r\nshape from the integration schema." + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "x-discriminator-value": "floatFunctional", + "x-discriminator-name": "type" }, - "GsaIntegrationSchemaStatus": { + "GsaFloatFunctionalAttributeDiscreteParameter": { "type": "object", - "properties": { - "loadedDatabases": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Loaded databases have been successfully indexed into the integration schema.", - "nullable": true - }, - "loadingDatabases": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Databases which are in the process of loading.", - "nullable": true - }, - "notLoadedDatabases": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Databases that are referenced in the schema but that are not yet loaded. This could be because they are still queued for\r\nload in the MI system, or because they have not yet been added.", - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter" }, - "erroredDatabases": { + { "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Databases that encountered an error while loading. These databases will not be available for searches.", - "nullable": true + "properties": { + "defaultValue": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "x-discriminator-value": "discrete", + "x-discriminator-name": "type" + }, + "GsaFloatFunctionalAttributeNumericParameter": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter" }, - "loadedDatabaseIndexStatuses": { + { "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - }, - "description": "Index information about all loaded databases, including the out of sync status.", - "nullable": true - }, - "searchIndexUpToDate": { - "type": "boolean", - "description": "Whether all changes up to and including the most recent database revision have been sent to the search index. This will return true\r\neven if some of those revisions could not be indexed" - }, - "searchIndexOutOfDateDuration": { - "type": "string", - "description": "How long has the index been out of date.\r\nSpecifically the duration between the first non-indexed revision and the current time.", - "format": "date-span", - "nullable": true - }, - "searchIndexInSync": { - "type": "boolean", - "description": "Returns false if the search index is out of sync with the database (i.e. because changes were made that could not be indexed)" - }, - "searchIndexLocation": { - "type": "string", - "description": "The location of the index.", - "nullable": true - }, - "searchIndexIsReadOnly": { - "type": "boolean", - "description": "True if the index is read only.", - "nullable": true - }, - "searchIndexUnavailable": { - "type": "boolean", - "description": "True if the index could not be contacted.", - "nullable": true + "properties": { + "defaultValue": { + "type": "number", + "description": "If there is no default value, fallback to the parameter default.", + "format": "double", + "nullable": true + }, + "interpolationMethod": { + "$ref": "#/components/schemas/GsaAttributeInterpolationMethod" + }, + "scaleType": { + "$ref": "#/components/schemas/GsaAttributeScaleType" + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: GsaFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" + }, + "GsaFloatFunctionalAttributeParameter": { + "required": [ + "parameter", + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/GsaParameterType" }, - "recordsThatFailedToIndex": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIndexRecordFailure" - }, - "description": "Details of any records that failed to index.", - "nullable": true + "parameter": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaFloatFunctionalAttributeDiscreteParameter\r\n * GsaFloatFunctionalAttributeNumericParameter", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaFloatFunctionalAttributeDiscreteParameter", + "numeric": "#/components/schemas/GsaFloatFunctionalAttributeNumericParameter" + } + } }, - "GsaInvalidEquivalenceTargetErrorDetail": { + "GsaFloatFunctionalDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { + "required": [ + "estimated", + "graphType", + "isRange", + "logScaleOnYAxis", + "parameterSettings", + "showAsTable" + ], "type": "object", "properties": { - "unitGuid": { - "type": "string", - "format": "uuid" + "graphType": { + "$ref": "#/components/schemas/GsaGraphType" }, - "unitSystemGuid": { - "type": "string", - "format": "uuid" + "logScaleOnYAxis": { + "type": "boolean" }, - "equivalentUnitGuid": { - "type": "string", - "format": "uuid" + "estimated": { + "type": "boolean" }, - "equivalentOfEquivalentUnitGuid": { - "type": "string", - "format": "uuid" + "showAsTable": { + "type": "boolean" + }, + "isRange": { + "type": "boolean" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" + }, + "parameterSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaFunctionalParameterSetting" + } + } + }, + "discriminator": { + "propertyName": "graphType", + "mapping": { + "series": "#/components/schemas/GsaFloatFunctionalSeriesDatum", + "grid": "#/components/schemas/GsaFloatFunctionalGridDatum" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidEquivalenceTarget'", - "x-discriminator-value": "invalidEquivalenceTarget", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * GsaFloatFunctionalSeriesDatum\r\n * GsaFloatFunctionalGridDatum", + "x-discriminator-value": "floatFunctional", + "x-discriminator-name": "datumType" }, - "GsaInvalidExchangeRateCurrencyErrorDetail": { + "GsaFloatFunctionalDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { - "type": "object" + "type": "object", + "properties": { + "gte": { + "type": "number", + "description": "Greater than or equal to", + "format": "double", + "nullable": true + }, + "lte": { + "type": "number", + "description": "Less than or equal to", + "format": "double", + "nullable": true + }, + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterConstraint" + }, + "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.", + "nullable": true + } + } } ], "additionalProperties": false, - "description": "Currency conversion factor must be greater than zero.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidExchangeRate'", - "x-discriminator-value": "invalidExchangeRate", - "x-discriminator-name": "reason" + "description": "floatFunctionalData: Criterion for matching records with float functional data\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalData'", + "x-discriminator-value": "floatFunctionalData", + "x-discriminator-name": "type" }, - "GsaInvalidKeyAddDatabaseValidationIssue": { + "GsaFloatFunctionalDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { - "required": [ - "databaseKey" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'invalidKey'", - "x-discriminator-value": "invalidKey", - "x-discriminator-name": "IssueType" + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "x-discriminator-value": "floatFunctional", + "x-discriminator-name": "type" }, - "GsaInvalidParentStateErrorDetail": { + "GsaFloatFunctionalGraphDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaVersionControlErrorDetail" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { - "type": "object" + "type": "object", + "properties": { + "xAxisParameterIdentity": { + "type": "integer", + "description": "Optional x axis parameter filter. Only series graphs have an x axis.", + "format": "int32", + "nullable": true + }, + "xAxisParameterGuid": { + "type": "string", + "description": "Optional x axis parameter filter. Only series graphs have an x axis.", + "format": "uuid", + "nullable": true + }, + "numberOfSeriesLte": { + "type": "integer", + "description": "Optional filter for the number of series.", + "format": "int32", + "nullable": true + }, + "numberOfSeriesGte": { + "type": "integer", + "description": "Optional filter for the number of series.", + "format": "int32", + "nullable": true + }, + "showAsTable": { + "type": "boolean", + "description": "Optional filter for data on the \"Show as table\" property", + "nullable": true + }, + "defaultXAxisParameterIdentity": { + "type": "integer", + "description": "Optional default x axis parameter filter. Only grid graphs have a default x axis.", + "format": "int32", + "nullable": true + }, + "defaultXAxisParameterGuid": { + "type": "string", + "description": "Optional x axis parameter filter. Only grid graphs have a default x axis..", + "format": "uuid", + "nullable": true + }, + "numberOfPointsLte": { + "type": "integer", + "description": "Optional filter for the number of points in a grid graph.", + "format": "int32", + "nullable": true + }, + "numberOfPointsGte": { + "type": "integer", + "description": "Optional filter for the number of points in a grid graph.", + "format": "int32", + "nullable": true + }, + "isSeriesGraph": { + "type": "boolean", + "description": "Optional filter for data on the type of graph", + "nullable": true + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidParentState'", - "x-discriminator-value": "invalidParentState", - "x-discriminator-name": "reason" + "description": "floatFunctionalGraph: Criterion for matching records with float functional data\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", + "x-discriminator-value": "floatFunctionalGraph", + "x-discriminator-name": "type" }, - "GsaInvalidVersionStateErrorDetail": { + "GsaFloatFunctionalGridDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaVersionControlErrorDetail" + "$ref": "#/components/schemas/GsaFloatFunctionalDatum" }, { + "required": [ + "graph" + ], "type": "object", "properties": { - "versionState": { - "$ref": "#/components/schemas/GsaVersionState" + "graph": { + "$ref": "#/components/schemas/GsaFloatGridGraph" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidVersionState'", - "x-discriminator-value": "invalidVersionState", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "x-discriminator-value": "grid", + "x-discriminator-name": "graphType" }, - "GsaJob": { + "GsaFloatFunctionalGridGraphAggregation": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "type": { - "type": "string", - "nullable": true - }, - "submitterName": { - "type": "string", - "nullable": true - }, - "submitterRoles": { + "defaultXAxisParameterIdentityValues": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GsaValueWithCountOfInt32" }, "nullable": true }, - "submissionDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "scheduledExecutionDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "executionDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "completionDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "status": { - "$ref": "#/components/schemas/GsaJobStatus" - }, - "inputFileIds": { + "defaultXAxisParameterGuidValues": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GsaValueWithCountOfGuid" }, "nullable": true }, - "outputFileNames": { + "showAsTableValues": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GsaValueWithCountOfBoolean" }, "nullable": true }, - "position": { + "minimumNumberOfPoints": { "type": "integer", "format": "int32", "nullable": true }, - "jobSpecificOutputs": { - "type": "object", - "additionalProperties": { - "type": "object", - "nullable": true - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaJobStatus": { - "enum": [ - "Pending", - "Running", - "Succeeded", - "Failed", - "Cancelled" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • Pending: Pending
    • \r\n
  • Running: Running
    • \r\n
  • Succeeded: Succeeded
    • \r\n
  • Failed: Failed
    • \r\n
  • Cancelled: Cancelled
    • \r\n
\r\n" - }, - "GsaJobTypeAndStatus": { - "type": "object", - "properties": { - "jobType": { - "type": "string", + "maximumNumberOfPoints": { + "type": "integer", + "format": "int32", "nullable": true }, - "status": { - "type": "string", - "nullable": true + "count": { + "type": "integer", + "description": "The number of record where the data is a series graph", + "format": "int32" } }, "additionalProperties": false }, - "GsaLastModifiedByUserProperty": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaProperty" - }, - { - "type": "object", - "properties": { - "lastModifiedByUser": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedByUser'", - "x-discriminator-value": "lastModifiedByUser", - "x-discriminator-name": "propertyName" - }, - "GsaLastModifiedDateProperty": { + "GsaFloatFunctionalSeriesDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaProperty" + "$ref": "#/components/schemas/GsaFloatFunctionalDatum" }, { + "required": [ + "graph" + ], "type": "object", "properties": { - "lastModifiedDate": { - "type": "string", - "format": "date-time" + "graph": { + "$ref": "#/components/schemas/GsaFloatSeriesGraph" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedDate'", - "x-discriminator-value": "lastModifiedDate", - "x-discriminator-name": "propertyName" + "description": "\r\n\r\nThis extends: GsaFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "x-discriminator-value": "series", + "x-discriminator-name": "graphType" }, - "GsaLayout": { - "required": [ - "applicableApplications", - "displayNames", - "guid", - "name", - "sections" - ], + "GsaFloatFunctionalSeriesGraphAggregation": { "type": "object", "properties": { - "sections": { + "xAxisParameterIdentityValues": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaLayoutSection" - } + "$ref": "#/components/schemas/GsaValueWithCountOfInt32" + }, + "nullable": true }, - "applicableApplications": { + "xAxisParameterGuidValues": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GsaValueWithCountOfGuid" }, - "description": "If there are no ApplicableApplications, the layout is applicable in all applications." + "nullable": true }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true + "showAsTableValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaValueWithCountOfBoolean" }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + "nullable": true }, - "name": { - "type": "string" + "minimumNumberOfSeries": { + "type": "integer", + "format": "int32", + "nullable": true }, - "guid": { - "type": "string", - "format": "uuid" + "maximumNumberOfSeries": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "count": { + "type": "integer", + "description": "The number of record where the data is a series graph", + "format": "int32" } }, "additionalProperties": false }, - "GsaLayoutAttributeItem": { + "GsaFloatGridGraph": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaLayoutItem" + "$ref": "#/components/schemas/GsaGridGraph" }, { "required": [ - "attributeType", - "readOnly", - "required" + "points" ], "type": "object", "properties": { - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "required": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "metaAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLayoutAttributeItem" - }, - "nullable": true - }, - "tabularColumns": { + "points": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaLayoutTabularColumn" - }, - "nullable": true + "$ref": "#/components/schemas/GsaFloatGridPoint" + } } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutItem](#model-GsaLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "itemType" + "description": "\r\n\r\nThis extends: GsaGridGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", + "x-discriminator-value": "float", + "x-discriminator-name": "functionalType" }, - "GsaLayoutItem": { + "GsaFloatGridPoint": { "required": [ - "displayNames", - "guid", - "itemType", - "name", - "underlyingEntityGuid" + "constraints", + "estimated", + "highValue", + "lowValue" ], "type": "object", "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaLayoutItemType" - }, - "underlyingEntityGuid": { - "type": "string", - "format": "uuid" + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterWithDataValue" + } }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + "lowValue": { + "type": "number", + "format": "double" }, - "name": { - "type": "string" + "highValue": { + "type": "number", + "format": "double" }, - "guid": { - "type": "string", - "format": "uuid" + "estimated": { + "type": "boolean" } }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaLayoutAttributeItem](#model-GsaLayoutAttributeItem)\r\n * [GsaLayoutLinkItem](#model-GsaLayoutLinkItem)", - "discriminator": { - "propertyName": "itemType", - "mapping": { - "attribute": "#/components/schemas/GsaLayoutAttributeItem", - "link": "#/components/schemas/GsaLayoutLinkItem" - } - } - }, - "GsaLayoutItemLinkType": { - "enum": [ - "recordLink", - "smartLink", - "crossDatabaseLink", - "associationChain" - ], - "type": "string", - "description": "The types of layout items that represent links to another table." + "additionalProperties": false }, - "GsaLayoutItemType": { - "enum": [ - "attribute", - "link" + "GsaFloatSeries": { + "required": [ + "constraints", + "graphDecoration", + "points" ], - "type": "string", - "description": "The types of layout item that are supported by the API." + "type": "object", + "properties": { + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterWithDataValue" + } + }, + "points": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaFloatSeriesPoint" + } + }, + "graphDecoration": { + "$ref": "#/components/schemas/GsaGraphDecorationType" + } + }, + "additionalProperties": false }, - "GsaLayoutLinkItem": { + "GsaFloatSeriesGraph": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaLayoutItem" + "$ref": "#/components/schemas/GsaSeriesGraph" }, { "required": [ - "forwards", - "linkType", - "targetTable" + "series" ], "type": "object", "properties": { - "linkType": { - "$ref": "#/components/schemas/GsaLayoutItemLinkType" - }, - "targetDatabase": { - "type": "string", - "description": "May be null for a cross database link group that can target multiple databases", - "format": "uuid", - "nullable": true - }, - "targetDatabaseVersion": { - "type": "string", - "description": "May be null for a cross database link group that can target multiple databases", - "format": "uuid", - "nullable": true - }, - "targetTable": { - "type": "string", - "format": "uuid" - }, - "forwards": { - "type": "boolean", - "description": "true if the link points from the table the layout is in; or false if it points towards the table the layout is in (an inbound link)." - }, - "nextLink": { - "$ref": "#/components/schemas/GsaLayoutLinkItem" + "series": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaFloatSeries" + } } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutItem](#model-GsaLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "itemType" + "description": "\r\n\r\nThis extends: GsaSeriesGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", + "x-discriminator-value": "float", + "x-discriminator-name": "functionalType" }, - "GsaLayoutSection": { + "GsaFloatSeriesPoint": { "required": [ - "displayNames", - "guid", - "name", - "sectionDetailType" + "estimated", + "xValue", + "yHighValue", + "yLowValue" ], "type": "object", "properties": { - "sectionDetailType": { - "$ref": "#/components/schemas/GsaLayoutSectionDetailType" + "xValue": { + "type": "number", + "format": "double" }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + "yLowValue": { + "type": "number", + "format": "double" }, - "name": { - "type": "string" + "yHighValue": { + "type": "number", + "format": "double" }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSlimLayoutSection](#model-GsaSlimLayoutSection)\r\n * [GsaFullLayoutSection](#model-GsaFullLayoutSection)", - "discriminator": { - "propertyName": "sectionDetailType", - "mapping": { - "slim": "#/components/schemas/GsaSlimLayoutSection", - "full": "#/components/schemas/GsaFullLayoutSection" - } - } - }, - "GsaLayoutSectionDetailType": { - "enum": [ - "slim", - "full" - ], - "type": "string", - "description": "The types of detail returned for a layout section." - }, - "GsaLayoutSectionsInfo": { - "type": "object", - "properties": { - "layoutSections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLayoutSection" - }, - "nullable": true + "estimated": { + "type": "boolean" } }, "additionalProperties": false }, - "GsaLayoutTabularColumn": { + "GsaFolder": { "required": [ - "columnType", "guid", - "name", - "tabularColumnGuid" + "name" ], "type": "object", "properties": { - "columnType": { - "$ref": "#/components/schemas/GsaTabularColumnDtoType" - }, - "tabularColumnGuid": { + "parentGuid": { "type": "string", - "format": "uuid" + "format": "uuid", + "nullable": true }, "name": { "type": "string" @@ -109147,2139 +74412,2080 @@ }, "additionalProperties": false }, - "GsaLayoutsInfo": { + "GsaFoldersInfo": { "type": "object", "properties": { - "layouts": { + "folders": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimLayout" + "$ref": "#/components/schemas/GsaFolder" }, "nullable": true } }, "additionalProperties": false }, - "GsaLink": { - "required": [ - "displayNames", - "guid", - "linkInfo", - "name", - "reverseName", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - }, - "reverseName": { - "type": "string" - }, - "reverseDisplayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - }, - "linkInfo": { - "$ref": "#/components/schemas/GsaLinkInfo" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaRecordLink](#model-GsaRecordLink)\r\n * [GsaSmartLink](#model-GsaSmartLink)\r\n * [GsaCrossDatabaseLink](#model-GsaCrossDatabaseLink)\r\n * [GsaTabularAttributeLink](#model-GsaTabularAttributeLink)", - "discriminator": { - "propertyName": "type", - "mapping": { - "recordLink": "#/components/schemas/GsaRecordLink", - "smartLink": "#/components/schemas/GsaSmartLink", - "crossDatabaseLink": "#/components/schemas/GsaCrossDatabaseLink", - "tabularAttribute": "#/components/schemas/GsaTabularAttributeLink" - } - } - }, - "GsaLinkAggregation": { + "GsaFreeTextAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatum" + "$ref": "#/components/schemas/GsaAggregation" }, { "type": "object", "properties": { - "localAggregations": { + "guid": { + "type": "string", + "description": "The GUID of the input aggregation criterion.", + "format": "uuid" + }, + "terms": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaLocalColumnAggregation" + "type": "string" }, + "description": "The topmost terms in the specified attributes, across all relevant records. Due to how\r\nmatches in multiple attributes are reconciled, we cannot easily provide a document count,\r\nnor can we guarantee that the terms are perfectly correctly ordered.", "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "datumType" + "description": "The results of aggregation over an attribute.\r\n\r\nThis extends: GsaAggregation\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "x-discriminator-value": "text", + "x-discriminator-name": "type" }, - "GsaLinkAggregationDatumCriterion": { + "GsaFreeTextAggregationCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" + "$ref": "#/components/schemas/GsaAggregationCriterion" }, { "type": "object", "properties": { - "localAggregationCriteria": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion" - }, + "criterionGuid": { + "type": "string", + "description": "A GUID to identify this free-text criterion, so that its results can be determined in the output.\r\nFor each input free-text aggregation criterion, there will be a free-text aggregation in the output\r\nwith a matching GUID.", + "format": "uuid" + }, + "numberOfTerms": { + "type": "integer", + "description": "The number of terms that should be returned", + "format": "int32" + }, + "prefix": { + "type": "string", "nullable": true + }, + "attributes": { + "$ref": "#/components/schemas/GsaValueSpecifier" + }, + "localColumns": { + "$ref": "#/components/schemas/GsaValueSpecifier" } } } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a tabular attribute. The local columns specified will be individually aggregated\r\nacross all rows (including rows without linked records, which may be hidden in clients).\r\n \r\nThe returned aggregation will contain a list of the individual column aggregations that have been performed. Within these\r\ncolumn aggregations, the 'record count' instead denotes the number of relevant tabular rows across all records in the\r\naggregation scope, rather than the number of records. This row count will include rows that may be hidden from the user's\r\nview in certain clients.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", - "x-discriminator-value": "link", + "description": "A criterion for requesting a free text aggregation over a set of attributes and tabular local columns.\r\nUses ValueSpecifiers to specify how to filter on attributes and local columns.\r\nAt least one filter must be specified.\r\n\r\nThis extends: GsaAggregationCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "x-discriminator-value": "text", "x-discriminator-name": "type" }, - "GsaLinkAttributeToExport": { + "GsaFreeTextCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeToExport" + "$ref": "#/components/schemas/GsaCriterion" }, { "type": "object", "properties": { - "localData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSimpleAttributeToExport" - }, - "description": "The local columns to export. Reuse the attribute object here - but the 'attribute id' is now the column id.", - "nullable": true - }, - "targetTableGuid": { - "type": "string", - "description": "Table containing the linked records", - "format": "uuid", - "nullable": true - }, - "targetDatabaseGuid": { - "type": "string", - "description": "Database containing the linked records. For reverse cross database links, this is the database where the link is defined.\r\nThis is not required for cross-database link groups that don't have a target database.", - "format": "uuid", - "nullable": true - }, - "targetAttributeGuid": { + "value": { "type": "string", - "description": "For tabular searching: this is the identifier of the short-text linking attribute.\r\nOtherwise null.", - "format": "uuid", "nullable": true }, - "linkAttributeType": { - "$ref": "#/components/schemas/GsaLinkAttributeType" + "attributes": { + "$ref": "#/components/schemas/GsaValueSpecifier" }, - "exportInReversedDirection": { - "type": "boolean" + "localColumns": { + "$ref": "#/components/schemas/GsaValueSpecifier" }, - "recordProperties": { + "attributeIdentitiesToBoost": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaRecordProperty" + "$ref": "#/components/schemas/GsaBoostByIdentity" }, - "description": "The properties to export on any linked records.", "nullable": true }, - "attributes": { + "attributeGuidsToBoost": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaAttributeToExport" + "$ref": "#/components/schemas/GsaBoostByGuid" }, - "description": "The attributes to export on any linked records.", "nullable": true }, - "linkedRecordsExportBehavior": { - "$ref": "#/components/schemas/GsaLinkedRecordExportBehavior" + "columnIdentitiesToBoost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBoostByIdentity" + }, + "nullable": true }, - "indirectLinksBehavior": { - "$ref": "#/components/schemas/GsaIndirectLinks" + "columnGuidsToBoost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBoostByGuid" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "Export request information for a 'link' attribute.\r\n\r\nThis extends: [GsaAttributeToExport](#model-GsaAttributeToExport)\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "attributeType" - }, - "GsaLinkAttributeType": { - "enum": [ - "recordLink", - "crossDatabaseLink", - "smartLink", - "tabularAttribute" - ], - "type": "string" + "description": "Base type for free text criteria.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "x-discriminator-value": "text", + "x-discriminator-name": "type" }, - "GsaLinkDatumCriterion": { + "GsaFreeTextPrefixCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaCriterion" }, { "required": [ - "linkDatumType" + "prefix" ], "type": "object", "properties": { - "targetTableIdentity": { - "type": "integer", - "description": "Table containing the linked records.\r\nThe target table can be omitted; it is likely to improve performance if it is included.\r\nFor tabular search, if either the target attribute or the target table is provided, they should both be provided.", - "format": "int32", - "nullable": true - }, - "targetTableGuid": { - "type": "string", - "description": "Table containing the linked records.\r\nThe target table can be omitted; it is likely to improve performance if it is included.\r\nFor tabular search, if either the target attribute or the target table is provided, they should both be provided.", - "format": "uuid", - "nullable": true - }, - "targetDatabaseKey": { - "type": "string", - "description": "Database containing the linked records. For reverse cross database links, this is the database where the link is defined", - "nullable": true - }, - "localCriterion": { - "$ref": "#/components/schemas/GsaCriterion" - }, - "linkDatumType": { - "$ref": "#/components/schemas/GsaLinkAttributeType" + "prefix": { + "type": "string" }, - "indirectLinks": { - "$ref": "#/components/schemas/GsaIndirectLinks" + "attributes": { + "$ref": "#/components/schemas/GsaValueSpecifier" }, - "searchInReversedDirection": { - "type": "boolean" + "localColumns": { + "$ref": "#/components/schemas/GsaValueSpecifier" }, - "targetAttributeIdentity": { - "type": "integer", - "description": "For tabular searching: this is the identity of the short-text linking attribute.\r\nThe target attribute and table can both be omitted; it is likely to improve performance if they are included.\r\nIf either the target attribute or the target table is provided, they should both be provided.\r\nOtherwise null.", - "format": "int32", + "attributeIdentitiesToBoost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBoostByIdentity" + }, "nullable": true }, - "targetAttributeGuid": { - "type": "string", - "description": "For tabular searching: this is the GUID of the short-text linking attribute.\r\n/// The target attribute and table can both be omitted; it is likely to improve performance if they are included.\r\nIf either the target attribute or the target table is provided, they should both be provided.\r\nOtherwise null.", - "format": "uuid", + "attributeGuidsToBoost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBoostByGuid" + }, "nullable": true }, - "innerCriterion": { - "$ref": "#/components/schemas/GsaCriterion" + "columnIdentitiesToBoost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBoostByIdentity" + }, + "nullable": true }, - "localRowsBehavior": { - "$ref": "#/components/schemas/GsaLocalRowsBehavior" + "columnGuidsToBoost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaBoostByGuid" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "link: Criterion for matching records that are linked to records that match the inner criterion. The target database and table specify the location of the linked records.\r\nThe inner criterion must be a criterion that applies to the records in the linked table. The link group followed will be the link group specified on the outer AttributeCriterion.\r\nA target database is required unless searching local tabular data - In that case, the inner criterion must be absent, and the local criterion will be used.\r\n\r\nlocalCriterion: Criterion to filter local properties of the link. For a tabular attribute search, this will be a criterion against the local columns and so it will use column ids/guids instead of attribute ones. For other types of link, this is currently unused.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\ninnerCriterion: Criterion to run to filter the linked records. When running linked search for tabular attribute we are searching against actual records and attributes, so attribute ids/guids should be used instead of column ids/guids.\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns, or a tabular data exists search.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", - "x-discriminator-value": "link", + "description": "\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'textPrefix'", + "x-discriminator-value": "textPrefix", "x-discriminator-name": "type" }, - "GsaLinkExistsDatumCriterion": { + "GsaFullLayoutSection": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "$ref": "#/components/schemas/GsaLayoutSection" }, { "required": [ - "targetDatabaseKey" + "sectionItems" ], "type": "object", "properties": { - "targetTableIdentity": { - "type": "integer", - "description": "Table containing the linked records", - "format": "int32", - "nullable": true - }, - "targetTableGuid": { - "type": "string", - "description": "Table containing the linked records", - "format": "uuid", - "nullable": true - }, - "targetDatabaseKey": { - "type": "string", - "description": "Database containing the linked records. For reverse cross database links, this is the database where the link is defined" - }, - "linkDatumType": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - }, - "indirectLinks": { - "$ref": "#/components/schemas/GsaIndirectLinks" - }, - "searchInReversedDirection": { - "type": "boolean" - }, - "localRowsBehavior": { - "$ref": "#/components/schemas/GsaLocalRowsBehavior" - }, - "targetAttributeIdentity": { - "type": "integer", - "description": "For tabular searching: this is the identity of the short-text linking attribute.\r\nOtherwise null.", - "format": "int32", - "nullable": true - }, - "targetAttributeGuid": { - "type": "string", - "description": "For tabular searching: this is the GUID of the short-text linking attribute.\r\nOtherwise null.", - "format": "uuid", - "nullable": true + "sectionItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaLayoutItem" + } } } } ], "additionalProperties": false, - "description": "link: Criterion for matching records that are linked to records by the given link group. The target database and table specify the location of the linked records.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaLayoutSection\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'full'", + "x-discriminator-value": "full", + "x-discriminator-name": "sectionDetailType" }, - "GsaLinkExportFailure": { + "GsaFullNameProperty": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaExportFailure" + "$ref": "#/components/schemas/GsaProperty" }, { - "required": [ - "failedLink" - ], "type": "object", "properties": { - "failedLink": { - "$ref": "#/components/schemas/GsaLinkReference" + "fullName": { + "type": "string", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'fullName'", + "x-discriminator-value": "fullName", + "x-discriminator-name": "propertyName" }, - "GsaLinkInfo": { - "required": [ - "linkSource", - "linkTarget" - ], + "GsaFuncNoParamsAttributeErrorDetail": { "type": "object", - "properties": { - "linkSource": { - "$ref": "#/components/schemas/GsaLinkTarget" + "allOf": [ + { + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, - "linkTarget": { - "$ref": "#/components/schemas/GsaLinkTarget" + { + "type": "object" } - }, - "additionalProperties": false - }, - "GsaLinkReference": { - "required": [ - "linkType" ], + "additionalProperties": false, + "description": "Functional attributes must have at least one parameter.\r\nFunctional attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'funcNoParams'", + "x-discriminator-value": "funcNoParams", + "x-discriminator-name": "reason" + }, + "GsaFunctionalDatumParameterInfo": { "type": "object", "properties": { - "targetDatabaseGuid": { + "scaleTypeDefinedAt": { + "$ref": "#/components/schemas/GsaParameterSettingDefinedAt" + }, + "interpolationMethodDefinedAt": { + "$ref": "#/components/schemas/GsaParameterSettingDefinedAt" + }, + "defaultValueDefinedAt": { + "$ref": "#/components/schemas/GsaParameterSettingDefinedAt" + }, + "name": { "type": "string", - "format": "uuid", "nullable": true }, - "linkIdentity": { + "identity": { "type": "integer", - "format": "int32", - "nullable": true + "format": "int32" }, - "linkGuid": { + "guid": { "type": "string", "format": "uuid", "nullable": true }, - "linkType": { - "$ref": "#/components/schemas/GsaLinkAttributeType" + "unitSymbol": { + "type": "string", + "nullable": true + }, + "scaleType": { + "$ref": "#/components/schemas/GsaParameterInfoScaleType" + }, + "interpolationType": { + "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" + }, + "parameterType": { + "$ref": "#/components/schemas/GsaParameterInfoParameterType" + }, + "defaultValue": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" + } + }, + "additionalProperties": false + }, + "GsaFunctionalParameterSetting": { + "required": [ + "defaultValue", + "interpolationType", + "parameter", + "scaleType" + ], + "type": "object", + "properties": { + "parameter": { + "$ref": "#/components/schemas/GsaSlimParameter" + }, + "defaultValue": { + "$ref": "#/components/schemas/GsaParameterDataValue" + }, + "scaleType": { + "$ref": "#/components/schemas/GsaParameterScaleType" + }, + "interpolationType": { + "$ref": "#/components/schemas/GsaParameterInterpolationType" } }, "additionalProperties": false }, - "GsaLinkSourceType": { + "GsaFunctionalType": { "enum": [ - "recordLink", - "crossDatabaseLink", - "reverseCrossDatabaseLink" + "float", + "discrete" ], "type": "string", - "description": "Source links for an integration schema can either be static (within an single database), or cross database. Cross database links\r\nmust indicate which database they are defined in - a reverse cross database link is defined in the \"target\" database of the mapped\r\nintegration schema attribute.

Possible values:

\r\n
    \r\n
  • recordLink: A static record link that links records within a single database.
    • \r\n
  • crossDatabaseLink: Links records across multiple databases.
    • \r\n
  • reverseCrossDatabaseLink: Links records across multiple databases, and is defined in the \"target\" database of the mapped integration schema attribute. Links records in that database to the source database defined in the mapping.
    • \r\n
\r\n" + "description": "

Possible values:

\r\n
    \r\n
  • float: Float functional
    • \r\n
  • discrete: Discrete functional
    • \r\n
\r\n" }, - "GsaLinkTarget": { + "GsaGeneratedIntegrationSchemaOfObjectIdentifier": { "required": [ - "tableGuid" + "schema" ], "type": "object", "properties": { - "databaseGuid": { - "type": "string", - "description": "Gets the guid of the database that this link group is referencing.\r\nIf `null` it means match any database with a matching table (only the case for cross database links)", - "format": "uuid", - "nullable": true - }, - "databaseVersionGuid": { - "type": "string", - "description": "Database version GUID. Null for forwards cross database link targets.", - "format": "uuid", + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationSchemaGenerationErrorDetail" + }, "nullable": true }, - "tableGuid": { - "type": "string", - "format": "uuid" + "schema": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } }, - "additionalProperties": false, - "description": "The target of a link group. Use /schema:resolve-link-targets to find all the currently loaded tables that match this target" + "additionalProperties": false }, - "GsaLinkedAttributeTabularColumn": { + "GsaGetJobsResponse": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTabularColumn" + "properties": { + "totalResultCount": { + "type": "integer", + "format": "int32" }, - { - "required": [ - "linkedAttribute" - ], - "type": "object", - "properties": { - "linkedAttribute": { - "$ref": "#/components/schemas/GsaSlimAttribute" - } - } + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaJob" + }, + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", - "x-discriminator-value": "linkedAttribute", - "x-discriminator-name": "columnType" + }, + "additionalProperties": false }, - "GsaLinkedColumnTabularColumn": { + "GsaGetJobsSummaryResponse": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTabularColumn" - }, - { - "required": [ - "linkedAttribute", - "linkedColumn" - ], - "type": "object", - "properties": { - "linkedAttribute": { - "$ref": "#/components/schemas/GsaSlimAttribute" - }, - "linkedColumn": { - "$ref": "#/components/schemas/GsaTabularColumn" - }, - "linkedTarget": { - "$ref": "#/components/schemas/GsaTabularAttributeTarget" - } - } + "properties": { + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaJobTypeAndStatus" + }, + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nlinkedAttribute: The tabular attribute that the linked column belongs to. The target of this tabular attribute is linkedTarget.\r\n\r\nlinkedColumn: The tabular column in the tabular linkedAttribute. Data from this column will be included.\r\n\r\nlinkedTarget: The target of the tabular linkedAttribute.\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", - "x-discriminator-value": "linkedColumn", - "x-discriminator-name": "columnType" + }, + "additionalProperties": false }, - "GsaLinkedRecordExportBehavior": { + "GsaGetModifiableRecordVersionControlException": { "type": "object", "properties": { - "tabularRowBehavior": { - "$ref": "#/components/schemas/GsaTabularRowExportBehavior" + "message": { + "type": "string", + "nullable": true }, - "summaryRollUpType": { - "$ref": "#/components/schemas/GsaTabularColumnRollUpType" + "code": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, - "rollUpTypes": { + "errors": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaTabularColumnRollUpType" + "$ref": "#/components/schemas/GsaVersionControlErrorDetail" }, - "description": "Optional: if this attribute is being used as part of a tabular export, this can be used to specify how linked records should be rolled up", "nullable": true - }, - "linkedRecordsCriterion": { - "$ref": "#/components/schemas/GsaCriterion" } }, - "additionalProperties": false, - "description": "Optional property to allow filtering of the linked records returned in an export. If used on a tabular export, can be used to filter both the linked records and the tabular rows.\r\nIf a summary roll up is included, the summary row for the tabular datum will include a rollup of the linked records." + "additionalProperties": false }, - "GsaLinkedRecordTabularColumn": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTabularColumn" - }, - { - "type": "object" - } + "GsaGetUnitConversionsRequest": { + "required": [ + "sourceUnits" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", - "x-discriminator-value": "linkedRecord", - "x-discriminator-name": "columnType" - }, - "GsaLinkingValueExistsDatumCriterion": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumCriterion" - }, - { - "type": "object", - "properties": { - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "innerHitsIdentifier": { - "type": "string", - "format": "uuid" - } + "properties": { + "sourceUnits": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaUnitConversionSetRequest" } } + }, + "additionalProperties": false + }, + "GsaGraph": { + "required": [ + "graphType" ], + "type": "object", + "properties": { + "graphType": { + "$ref": "#/components/schemas/GsaGraphType" + } + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smartLinkingValue'", - "x-discriminator-value": "smartLinkingValue", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis is one of: \r\n * GsaSeriesGraph\r\n * GsaGridGraph", + "discriminator": { + "propertyName": "graphType", + "mapping": { + "series": "#/components/schemas/GsaSeriesGraph", + "grid": "#/components/schemas/GsaGridGraph" + } + } }, - "GsaLinkingValueMatchBehavior": { + "GsaGraphDecorationType": { "enum": [ - "AllRows", - "VisibleRows", - "ExactMatchMatchingRows", - "FreeTextMatchingRows" + "linesOnly", + "markersOnly", + "linesAndMarkers" ], "type": "string", - "description": "Enum for use in the Granta.Server.Api.Search.TabularLinkingValueCriterion to control which tabular rows are returned

Possible values:

\r\n
    \r\n
  • AllRows: Return any row where the local data matches
    • \r\n
  • VisibleRows: Return rows with matching linking values, or no linking value
    • \r\n
  • ExactMatchMatchingRows: Return rows with matching linking values
    • \r\n
  • FreeTextMatchingRows: Return rows with linking values that match when using the usual free text search analyzers
    • \r\n
\r\n" + "description": "

Possible values:

\r\n
    \r\n
  • linesOnly: Graph shows only lines.
    • \r\n
  • markersOnly: Graph shows only markers.
    • \r\n
  • linesAndMarkers: Graph shows both lines and markers.
    • \r\n
\r\n" }, - "GsaLinksInfo": { + "GsaGraphEvaluationSettings": { "required": [ - "links" + "parametersWithValues" ], "type": "object", "properties": { - "links": { + "parametersWithValues": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaLink" + "$ref": "#/components/schemas/GsaGraphParameterWithValue" } } }, "additionalProperties": false }, - "GsaListAction": { - "enum": [ - "ListCreated", - "ListDeleted", - "ItemAdded", - "ItemRemoved", - "ListNameChanged", - "ListDescriptionChanged", - "ListNotesChanged", - "ListSetToAwaitingApprovalForPublishing", - "ListAwaitingApprovalForPublishingRemoved", - "ListSetToAwaitingApprovalForWithdrawal", - "ListAwaitingApprovalForWithdrawalRemoved", - "ListPublished", - "ListUnpublished", - "ListRevisionCreated", - "UserSubscribed", - "UserUnsubscribed", - "ListCuratorAdded", - "ListCuratorRemoved", - "ListAdminAdded", - "ListAdminRemoved", - "ListPublisherAdded", - "ListPublisherRemoved", - "ListMadeInternal", - "ListMadeNotInternal", - "ListRevisionDiscarded" + "GsaGraphParameterValue": { + "required": [ + "parameterType" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • ListCreated: A list has been created.
    • \r\n
  • ListDeleted: A list has been deleted.
    • \r\n
  • ItemAdded: An item has been added to a list.
    • \r\n
  • ItemRemoved: An item has been removed from a list.
    • \r\n
  • ListNameChanged: The name of a list has been changed.
    • \r\n
  • ListDescriptionChanged: The description of a list has been changed.
    • \r\n
  • ListNotesChanged: The notes for a list have been changed.
    • \r\n
  • ListSetToAwaitingApprovalForPublishing: The status of an unpublished list was set to 'awaiting approval' for publishing.
    • \r\n
  • ListAwaitingApprovalForPublishingRemoved: The 'awaiting approval for publishing' status of an unpublished list was removed.
    • \r\n
  • ListSetToAwaitingApprovalForWithdrawal: The status of a published list was set to 'awaiting approval' for withdrawal.
    • \r\n
  • ListAwaitingApprovalForWithdrawalRemoved: The 'awaiting approval for withdrawal' status of a published list was removed.
    • \r\n
  • ListPublished: The status of the list was set to 'published'.
    • \r\n
  • ListUnpublished: The status of the list was set to 'unpublished'.
    • \r\n
  • ListRevisionCreated: A revision of a list was created.
    • \r\n
  • UserSubscribed: A user subscribed to a list.
    • \r\n
  • UserUnsubscribed: A user subscribed to a list.
    • \r\n
  • ListCuratorAdded: Permissions changed - a user was set as curator for a list.
    • \r\n
  • ListCuratorRemoved: Permissions changed - a user was removed as a curator for a list.
    • \r\n
  • ListAdminAdded: Permissions changed - a user was set as admin for a list.
    • \r\n
  • ListAdminRemoved: Permissions changed - a user was removed as an admin for a list.
    • \r\n
  • ListPublisherAdded: Permissions changed - a user was set a publisher for a list.
    • \r\n
  • ListPublisherRemoved: Permissions changed - a user was removed as a publisher for a list.
    • \r\n
  • ListMadeInternal: A list was changed to be flagged as 'internal use'.
    • \r\n
  • ListMadeNotInternal: A list was changed to be flagged as 'not internal use'.
    • \r\n
  • ListRevisionDiscarded: A list revision was 'published' and discarded. Publishing a revision results in any changes to the revision list being applied to its parent before marking the revision as discarded.
    • \r\n
\r\n" + "type": "object", + "properties": { + "parameterType": { + "$ref": "#/components/schemas/GsaParameterType" + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteGraphParameterValue\r\n * GsaNumericGraphParameterValue", + "discriminator": { + "propertyName": "parameterType", + "mapping": { + "discrete": "#/components/schemas/GsaDiscreteGraphParameterValue", + "numeric": "#/components/schemas/GsaNumericGraphParameterValue" + } + } }, - "GsaListAuditLogItem": { + "GsaGraphParameterWithValue": { + "required": [ + "parameterGuid", + "parameterValue" + ], "type": "object", "properties": { - "listIdentifier": { + "parameterGuid": { "type": "string", - "description": "The identifier of the list that the action was performed on", "format": "uuid" }, - "initiatingUser": { - "$ref": "#/components/schemas/GsaListsUserOrGroup" - }, - "userOrGroupAffected": { - "$ref": "#/components/schemas/GsaListsUserOrGroup" - }, - "listItemAffected": { - "$ref": "#/components/schemas/GsaListItem" - }, - "action": { - "$ref": "#/components/schemas/GsaListAction" - }, - "timestamp": { - "type": "string", - "description": "The date/time that the action occurred.", - "format": "date-time" + "parameterValue": { + "$ref": "#/components/schemas/GsaGraphParameterValue" } }, - "additionalProperties": false, - "description": "\r\n\r\ninitiatingUser: The user that carried out the action\r\n\r\nuserOrGroupAffected: The user or group associated with the action. May be null if not relevant to the action\r\n\r\nlistItemAffected: The list item associated with the action. May be null if not relevant to the action\r\n\r\naction: The action that was carried out." + "additionalProperties": false }, - "GsaListAuditLogSearchRequest": { + "GsaGraphType": { + "enum": [ + "series", + "grid" + ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • series: Series graph
    • \r\n
  • grid: Gridded graph
    • \r\n
\r\n" + }, + "GsaGraphValue": { + "required": [ + "graphValueType" + ], "type": "object", "properties": { - "listIdentifiers": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "The lists to include actions for. If null, all items will be returned", - "nullable": true - }, - "listActionsToInclude": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListAction" - }, - "description": "The types of actions to include. If null, all action types will be returned", - "nullable": true - }, - "pagingOptions": { - "$ref": "#/components/schemas/GsaListsPagingOptions" + "graphValueType": { + "$ref": "#/components/schemas/GsaGraphValueType" } }, "additionalProperties": false, - "description": "\r\n\r\npagingOptions: Paging options. If null, all items will be returned." + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteGraphValue\r\n * GsaRangeGraphValue\r\n * GsaNoValueExistsGraphValue", + "discriminator": { + "propertyName": "graphValueType", + "mapping": { + "discrete": "#/components/schemas/GsaDiscreteGraphValue", + "range": "#/components/schemas/GsaRangeGraphValue", + "noValueExists": "#/components/schemas/GsaNoValueExistsGraphValue" + } + } }, - "GsaListBooleanCriterion": { + "GsaGraphValueType": { + "enum": [ + "discrete", + "range", + "noValueExists" + ], + "type": "string" + }, + "GsaGridGraph": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaListCriterion" + "$ref": "#/components/schemas/GsaGraph" }, { + "required": [ + "allParameters", + "defaultXAxisParameter", + "functionalType" + ], "type": "object", "properties": { - "matchAny": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListCriterion" - }, - "nullable": true + "functionalType": { + "$ref": "#/components/schemas/GsaFunctionalType" }, - "matchAll": { + "defaultXAxisParameter": { + "$ref": "#/components/schemas/GsaSlimParameter" + }, + "allParameters": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaListCriterion" - }, - "nullable": true + "$ref": "#/components/schemas/GsaSlimParameter" + } + } + }, + "discriminator": { + "propertyName": "functionalType", + "mapping": { + "float": "#/components/schemas/GsaFloatGridGraph", + "discrete": "#/components/schemas/GsaDiscreteGridGraph" } } } ], "additionalProperties": false, - "description": "listBoolean: Criterion that wraps other criteria in order to specify how the results should be joined together. Used in searches for record lists.\r\n\r\nThis extends: [GsaListCriterion](#model-GsaListCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'listBoolean'", - "x-discriminator-value": "listBoolean", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaGraph\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'\r\n\r\nThis is one of: \r\n * GsaFloatGridGraph\r\n * GsaDiscreteGridGraph", + "x-discriminator-value": "grid", + "x-discriminator-name": "graphType" }, - "GsaListCriterion": { + "GsaGuidOnlyAttribute": { "required": [ + "guid", + "name", "type" ], "type": "object", "properties": { - "type": { + "name": { "type": "string" - } - }, - "additionalProperties": false, - "description": "The criterion to be used in a search for record lists.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\" or \"all\" of the criteria.\r\nThese criteria can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * [GsaListBooleanCriterion](#model-GsaListBooleanCriterion)\r\n * [GsaRecordListSearchCriterion](#model-GsaRecordListSearchCriterion)", - "discriminator": { - "propertyName": "type", - "mapping": { - "listBoolean": "#/components/schemas/GsaListBooleanCriterion", - "recordList": "#/components/schemas/GsaRecordListSearchCriterion" - } - } - }, - "GsaListItem": { - "required": [ - "databaseGuid", - "recordHistoryGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "databaseGuid": { - "type": "string", - "format": "uuid" }, - "recordHistoryGuid": { + "guid": { "type": "string", "format": "uuid" }, - "recordGuid": { + "type": { + "$ref": "#/components/schemas/GsaAttributeType" + }, + "unitSymbol": { "type": "string", - "description": "This may be null if the list item does not exist in a currently loaded database", - "format": "uuid", + "description": "If isUnitted is true, then this must have a non empty value", "nullable": true }, - "recordVersion": { - "type": "integer", - "format": "int32", + "isUnitted": { + "type": "boolean", "nullable": true }, - "tableGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaListItemRecordReference": { - "required": [ - "databaseGuid", - "recordHistoryGuid" - ], - "type": "object", - "properties": { - "databaseGuid": { - "type": "string", - "description": "The database GUID of the record", - "format": "uuid" - }, - "recordHistoryGuid": { + "discreteTypeGuid": { "type": "string", - "description": "The record history GUID of the record", - "format": "uuid" + "description": "A discrete attribute must define the guid of its discrete type (i.e. list of possible values)", + "format": "uuid", + "nullable": true }, - "recordVersion": { - "type": "integer", - "description": "Optional record version. If not specified, search will return lists that were added with unspecified version", - "format": "int32", + "parameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationParameterInfo" + }, + "description": "A float functional attribute must define a list of parameters.", "nullable": true - } - }, - "additionalProperties": false, - "description": "Object that uniquely identifies a record" - }, - "GsaListRollupDatum": { - "required": [ - "datum", - "sourceRow" - ], - "type": "object", - "properties": { - "sourceRow": { - "$ref": "#/components/schemas/GsaSlimEntity" }, - "datum": { - "$ref": "#/components/schemas/GsaDatum" - } - }, - "additionalProperties": false - }, - "GsaListsPagingOptions": { - "type": "object", - "properties": { - "startIndex": { - "type": "integer", - "description": "The index of the first item in the collection to be returned. If not provided it will start at index 0.", - "format": "int32", + "targetDatabase": { + "$ref": "#/components/schemas/GsaObjectIdentifier" + }, + "targetTable": { + "$ref": "#/components/schemas/GsaObjectIdentifier" + }, + "graphType": { + "type": "string", + "description": "A float functional attribute must be either a Series or a Grid type graph.", "nullable": true }, - "pageSize": { - "type": "integer", - "description": "The number of items to be returned per page. If not provided the number of returned lists will be unlimited.", - "format": "int32", + "xAxisParameter": { + "type": "string", + "description": "A float functional attribute must define an x-axis. This will be one of the parameters listed in parameters", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "An attribute as defined in an integration schema.\r\n\r\ntargetDatabase: A link attribute must define the database of the linked records.\r\n\r\ntargetTable: A link attribute must define the table of the linked records." }, - "GsaListsUserOrGroup": { + "GsaGuidOnlyDiscreteType": { "required": [ - "displayName", - "identifier", - "name" + "guid" ], "type": "object", "properties": { - "identifier": { + "guid": { "type": "string", "format": "uuid" }, - "displayName": { - "type": "string" - }, "name": { - "type": "string" + "type": "string", + "nullable": true + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "An integration schema discrete type defines the list of values that a discrete attribute can take." }, - "GsaLocalColumnAggregation": { + "GsaGuidOnlyIntegrationParameterInfo": { "required": [ - "localColumnAggregationType" + "guid" ], "type": "object", "properties": { - "localColumnIdentity": { - "type": "integer", - "description": "The identity of the local column that was aggregated over.", - "format": "int32", + "name": { + "type": "string", "nullable": true }, - "localColumnGuid": { + "guid": { + "type": "string", + "format": "uuid" + }, + "unitSymbol": { "type": "string", - "description": "The GUID of the local column that was aggregated over.", - "format": "uuid", "nullable": true }, - "localColumnAggregationType": { - "$ref": "#/components/schemas/GsaLocalColumnAggregationType" + "scaleType": { + "$ref": "#/components/schemas/GsaParameterInfoScaleType" }, - "count": { - "type": "integer", - "description": "The number of records that have a populated (applicable) value for this local column.", - "format": "int32" + "interpolationType": { + "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" + }, + "parameterType": { + "$ref": "#/components/schemas/GsaParameterInfoParameterType" + }, + "defaultValue": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" } }, - "additionalProperties": false, - "description": "The results of aggregation over a tabular local column. In all cases this will report the number of rows in\r\nthe aggregation scope that have a value for the local column. In some cases, depending on the datum\r\ntype, we may be able to report more information. For example, aggregating over a numeric datum will\r\nalso provide the minimum and maximum values that local column takes across records in the aggregation\r\nscope.\r\n\r\nThis is one of: \r\n * [GsaLocalColumnValueAggregation](#model-GsaLocalColumnValueAggregation)\r\n * [GsaLocalColumnExistsAggregation](#model-GsaLocalColumnExistsAggregation)", - "discriminator": { - "propertyName": "localColumnAggregationType", - "mapping": { - "value": "#/components/schemas/GsaLocalColumnValueAggregation", - "exists": "#/components/schemas/GsaLocalColumnExistsAggregation" - } - } + "additionalProperties": false }, - "GsaLocalColumnAggregationCriterion": { - "required": [ - "localColumnAggregationCriterionType" - ], + "GsaGuidOnlyIntegrationSchemaOfObjectIdentifier": { "type": "object", "properties": { - "identity": { + "key": { + "type": "string", + "nullable": true + }, + "version": { "type": "integer", "format": "int32", "nullable": true }, - "guid": { + "attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaGuidOnlyAttribute" + }, + "nullable": true + }, + "layouts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaGuidOnlyLayout" + }, + "nullable": true + }, + "unitSystem": { "type": "string", - "format": "uuid", "nullable": true }, - "localColumnAggregationCriterionType": { - "$ref": "#/components/schemas/GsaLocalColumnAggregationType" - } - }, - "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific tabular local column. Exactly one of the identity or GUID must be provided.\r\n\r\nThis is one of: \r\n * [GsaLocalColumnAggregationValueCriterion](#model-GsaLocalColumnAggregationValueCriterion)\r\n * [GsaLocalColumnAggregationExistsCriterion](#model-GsaLocalColumnAggregationExistsCriterion)", - "discriminator": { - "propertyName": "localColumnAggregationCriterionType", - "mapping": { - "value": "#/components/schemas/GsaLocalColumnAggregationValueCriterion", - "exists": "#/components/schemas/GsaLocalColumnAggregationExistsCriterion" - } - } - }, - "GsaLocalColumnAggregationExistsCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion" + "discreteTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaGuidOnlyDiscreteType" + }, + "nullable": true }, - { + "sources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaGuidOnlySourceOfObjectIdentifier" + }, + "nullable": true + }, + "accessControlCategoryValues": { "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaAggregationDatumExistsCriterion" - } - } + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "nullable": true + }, + "securityGroups": { + "$ref": "#/components/schemas/GsaSecurityGroups" } - ], + }, "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific tabular local column.\r\n\r\nThis extends: [GsaLocalColumnAggregationCriterion](#model-GsaLocalColumnAggregationCriterion)\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'exists'", - "x-discriminator-value": "exists", - "x-discriminator-name": "localColumnAggregationCriterionType" - }, - "GsaLocalColumnAggregationType": { - "enum": [ - "value", - "exists" - ], - "type": "string" + "description": "Similar to IntegrationSchema, but without identities.\r\nUsed when we don't want consumers to specify/know about identities." }, - "GsaLocalColumnAggregationValueCriterion": { + "GsaGuidOnlyLayout": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion" + "properties": { + "name": { + "type": "string", + "nullable": true }, - { - "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" - } - } + "attributeGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "nullable": true } - ], + }, "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific tabular local column,\r\nincluding summary information about the values assumed by the local column.\r\n \r\nFor a numeric local column (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the local column.\r\n \r\nFor a simple text local column (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that local column.\r\n\r\nThis extends: [GsaLocalColumnAggregationCriterion](#model-GsaLocalColumnAggregationCriterion)\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'value'", - "x-discriminator-value": "value", - "x-discriminator-name": "localColumnAggregationCriterionType" + "description": "An integration schema layout is named list of attribute identities." }, - "GsaLocalColumnCriterion": { + "GsaGuidOnlyMappingOfObjectIdentifier": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCriterion" + "properties": { + "source": { + "$ref": "#/components/schemas/GsaObjectIdentifier" }, - { - "required": [ - "localColumnCriterionType" - ], - "type": "object", - "properties": { - "identity": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "localColumnCriterionType": { - "$ref": "#/components/schemas/GsaLocalColumnCriterionType" - } + "targetGuid": { + "type": "string", + "description": "The guid of the integration schema attribute", + "format": "uuid" + }, + "parameterMappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaGuidOnlyMappingOfObjectIdentifier" }, - "discriminator": { - "propertyName": "localColumnCriterionType", - "mapping": { - "matches": "#/components/schemas/GsaLocalColumnMatchesCriterion", - "exists": "#/components/schemas/GsaLocalColumnExistsCriterion", - "notApplicable": "#/components/schemas/GsaLocalColumnNotApplicableCriterion" - } - } + "description": "Any mapped parameters (float functional attributes only). The target parameters must be defined on the target integration attribute.\r\nNot every parameters from the source database needs to be mapped for each attribute.", + "nullable": true + }, + "linkSourceType": { + "$ref": "#/components/schemas/GsaLinkSourceType" } - ], + }, "additionalProperties": false, - "description": "Base class for local column criterions. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'localColumn'\r\n\r\nThis is one of: \r\n * [GsaLocalColumnMatchesCriterion](#model-GsaLocalColumnMatchesCriterion)\r\n * [GsaLocalColumnExistsCriterion](#model-GsaLocalColumnExistsCriterion)\r\n * [GsaLocalColumnNotApplicableCriterion](#model-GsaLocalColumnNotApplicableCriterion)", - "x-discriminator-value": "localColumn", - "x-discriminator-name": "type" + "description": "A mapping between a source database item and an integration schema attribute." }, - "GsaLocalColumnCriterionType": { - "enum": [ - "matches", - "exists", - "notApplicable" + "GsaGuidOnlySourceOfObjectIdentifier": { + "required": [ + "mappings", + "table" ], - "type": "string" - }, - "GsaLocalColumnExistsAggregation": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLocalColumnAggregation" + "properties": { + "database": { + "$ref": "#/components/schemas/GsaObjectIdentifier" }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "The results of aggregation over a tabular local column, reporting only the number of rows with a value\r\nfor the local column.\r\n\r\nThis extends: [GsaLocalColumnAggregation](#model-GsaLocalColumnAggregation)\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'exists'", - "x-discriminator-value": "exists", - "x-discriminator-name": "localColumnAggregationType" - }, - "GsaLocalColumnExistsCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLocalColumnCriterion" + "databaseKey": { + "type": "string", + "nullable": true }, - { - "required": [ - "innerCriterion" - ], - "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "Criterion for matching record where there is data on the tabular local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'exists'", - "x-discriminator-value": "exists", - "x-discriminator-name": "localColumnCriterionType" - }, - "GsaLocalColumnMatchesCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLocalColumnCriterion" + "table": { + "$ref": "#/components/schemas/GsaObjectIdentifier" }, - { - "required": [ - "innerCriterion" - ], - "type": "object", - "properties": { - "innerCriterion": { - "$ref": "#/components/schemas/GsaDatumCriterion" - } - } + "mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaGuidOnlyMappingOfObjectIdentifier" + }, + "description": "Mappings for items from this table to the integration schema attributes." } - ], + }, "additionalProperties": false, - "description": "Criterion for a search matching values in a given tabular local column. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'matches'", - "x-discriminator-value": "matches", - "x-discriminator-name": "localColumnCriterionType" + "description": "A source table from which integrated data will be taken." }, - "GsaLocalColumnNotApplicableCriterion": { + "GsaHistogram": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLocalColumnCriterion" - }, - { - "type": "object" + "properties": { + "buckets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaHistogramBucket" + }, + "nullable": true } - ], - "additionalProperties": false, - "description": "Criterion for matching record where there is not applicable data on the local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'notApplicable'", - "x-discriminator-value": "notApplicable", - "x-discriminator-name": "localColumnCriterionType" + }, + "additionalProperties": false }, - "GsaLocalColumnValueAggregation": { + "GsaHistogramBucket": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLocalColumnAggregation" + "properties": { + "lower": { + "type": "number", + "format": "double" }, - { - "type": "object", - "properties": { - "aggregationDatum": { - "$ref": "#/components/schemas/GsaAggregationDatum" - } - } + "upper": { + "type": "number", + "format": "double", + "nullable": true + }, + "count": { + "type": "integer", + "format": "int32" } - ], - "additionalProperties": false, - "description": "The results of aggregation over a tabular local column, reporting the number of rows that have a value for\r\nthe local column, plus additional aggregation information about the local column values. The exact type of\r\nadditional information will depend on the type of local column.\r\n\r\nThis extends: [GsaLocalColumnAggregation](#model-GsaLocalColumnAggregation)\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'value'", - "x-discriminator-value": "value", - "x-discriminator-name": "localColumnAggregationType" + }, + "additionalProperties": false }, - "GsaLocalDateTimeTabularColumn": { + "GsaHyperlinkAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaAttribute" }, { - "required": [ - "defaultThresholdType" - ], - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", - "x-discriminator-value": "localDateTime", - "x-discriminator-name": "columnType" + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "x-discriminator-value": "hyperlink", + "x-discriminator-name": "type" }, - "GsaLocalDiscreteTabularColumn": { + "GsaHyperlinkDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { "required": [ - "defaultThresholdType", - "discreteType" + "address", + "description", + "target" ], "type": "object", "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" + "address": { + "type": "string" }, - "discreteType": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "description": { + "type": "string" + }, + "target": { + "$ref": "#/components/schemas/GsaHyperlinkTarget" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", - "x-discriminator-value": "localDiscrete", - "x-discriminator-name": "columnType" + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", + "x-discriminator-value": "hyperlink", + "x-discriminator-name": "datumType" }, - "GsaLocalFileTabularColumn": { + "GsaHyperlinkDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { "required": [ - "defaultThresholdType" + "value" ], "type": "object", "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" + "value": { + "type": "string" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", - "x-discriminator-value": "localFile", - "x-discriminator-name": "columnType" + "description": "hyperlink: Criterion for matching records where the hyperlink description contains the given value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "x-discriminator-value": "hyperlink", + "x-discriminator-name": "type" }, - "GsaLocalHyperlinkTabularColumn": { + "GsaHyperlinkDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { - "required": [ - "defaultThresholdType" - ], - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", - "x-discriminator-value": "localHyperlink", - "x-discriminator-name": "columnType" + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "x-discriminator-value": "hyperlink", + "x-discriminator-name": "type" }, - "GsaLocalIntegerTabularColumn": { + "GsaHyperlinkPrefixDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { "required": [ - "defaultThresholdType" + "prefix" ], "type": "object", "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" + "prefix": { + "type": "string" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", - "x-discriminator-value": "localInteger", - "x-discriminator-name": "columnType" + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlinkPrefix'", + "x-discriminator-value": "hyperlinkPrefix", + "x-discriminator-name": "type" }, - "GsaLocalLogicalTabularColumn": { + "GsaHyperlinkTarget": { + "enum": [ + "newWindow", + "top", + "parent", + "tree", + "content", + "currentFrame" + ], + "type": "string", + "description": "A target for a `HyperlinkDatum`

Possible values:

\r\n
    \r\n
  • newWindow: Target a new window (equivalent to \"_blank\").
    • \r\n
  • top: Target the topmost frame of the current frameset (equivalent to \"_top\").
    • \r\n
  • parent: Target the parent frame of the current frame (equivalent to \"_parent\").
    • \r\n
  • tree: Target the left-hand side frame.
    • \r\n
  • content: Target the right-hand side frame.
    • \r\n
  • currentFrame: Target the current frame (equivalent to \"_self\").
    • \r\n
\r\n" + }, + "GsaIndexRecordFailure": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTabularColumn" + "properties": { + "recordHistoryGuid": { + "type": "string", + "format": "uuid" }, - { - "required": [ - "defaultThresholdType" - ], - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } + "recordName": { + "type": "string", + "nullable": true + }, + "error": { + "type": "string", + "description": "This is the error message from the indexing exception. It may have been returned directly from Elasticsearch.", + "nullable": true + }, + "recordWasOversized": { + "type": "boolean", + "description": "Records that contain a large amount of data are intentionally not sent to the index. This size limit is configurable through\r\nMIServer.exe.config" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", - "x-discriminator-value": "localLogical", - "x-discriminator-name": "columnType" + "description": "Detail of a record that has failed to successfully index. A record that was not indexed will not be returned\r\nas a result in any searches." }, - "GsaLocalLongTextTabularColumn": { + "GsaIndirectLinks": { + "enum": [ + "fromLinkDefinition", + "include", + "exclude" + ], + "type": "string" + }, + "GsaInputValidationErrorDetail": { + "required": [ + "message", + "reason" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTabularColumn" - }, - { - "required": [ - "defaultThresholdType" - ], - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - } - } + "properties": { + "message": { + "type": "string" + }, + "reason": { + "type": "string" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", - "x-discriminator-value": "localLongText", - "x-discriminator-name": "columnType" + }, + "additionalProperties": false }, - "GsaLocalPictureTabularColumn": { + "GsaIntegerAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaAggregationDatum" }, { - "required": [ - "defaultThresholdType" - ], "type": "object", "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" + "minimum": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "maximum": { + "type": "integer", + "format": "int32", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", - "x-discriminator-value": "localPicture", - "x-discriminator-name": "columnType" + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", + "x-discriminator-value": "integer", + "x-discriminator-name": "datumType" }, - "GsaLocalPointTabularColumn": { + "GsaIntegerAggregationDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, { - "required": [ - "defaultThresholdType" - ], - "type": "object", - "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", - "x-discriminator-value": "localPoint", - "x-discriminator-name": "columnType" + "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "x-discriminator-value": "integer", + "x-discriminator-name": "type" }, - "GsaLocalRangeTabularColumn": { + "GsaIntegerAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaAttribute" }, { "required": [ - "defaultThresholdType" + "isUnique" ], "type": "object", "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" + "isUnique": { + "type": "boolean", + "description": "Whether or not the attribute is constrained to contain a unique value" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", - "x-discriminator-value": "localRange", - "x-discriminator-name": "columnType" - }, - "GsaLocalRowsBehavior": { - "enum": [ - "AllRows", - "VisibleRows", - "ExactMatchMatchingRows", - "NoLinkingValueRows" - ], - "type": "string", - "description": "Enum for use in a tabular search, to optionally further filter the results based on whether the matching rows are linked. The default value of AllRows will return all rows matching the local search.

Possible values:

\r\n
    \r\n
  • AllRows: Return any row where the local data matches
    • \r\n
  • VisibleRows: Return rows with matching linking values, or no linking value
    • \r\n
  • ExactMatchMatchingRows: Return rows with matching linking values
    • \r\n
  • NoLinkingValueRows: Return rows with no linking value
    • \r\n
\r\n" + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "x-discriminator-value": "integer", + "x-discriminator-name": "type" }, - "GsaLocalShortTextTabularColumn": { + "GsaIntegerDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTabularColumn" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { "required": [ - "defaultThresholdType" + "value" ], "type": "object", "properties": { - "defaultThresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" + "value": { + "type": "integer", + "format": "int32" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", - "x-discriminator-value": "localShortText", - "x-discriminator-name": "columnType" - }, - "GsaLogScaleNegativeParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "For a log-scale parameter, all values must be greater than zero.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'logScaleNegative'", - "x-discriminator-value": "logScaleNegative", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", + "x-discriminator-value": "integer", + "x-discriminator-name": "datumType" }, - "GsaLogicalAggregation": { + "GsaIntegerDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAggregationDatum" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { "type": "object", "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaValueWithCountOfBoolean" - }, + "gte": { + "type": "integer", + "description": "Greater than or equal to", + "format": "int32", + "nullable": true + }, + "lte": { + "type": "integer", + "description": "Less than or equal to", + "format": "int32", "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", - "x-discriminator-value": "logical", - "x-discriminator-name": "datumType" - }, - "GsaLogicalAggregationDatumCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAggregationDatumCriterion" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Criterion for aggregating data within a logical attribute. The returned aggregation will contain a count of records with at least one value for the attribute,\r\nand a count of records for the true/false values.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", - "x-discriminator-value": "logical", + "description": "integer: Criterion for matching records where the integer data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "x-discriminator-value": "integer", "x-discriminator-name": "type" }, - "GsaLogicalAttribute": { + "GsaIntegerDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", - "x-discriminator-value": "logical", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "x-discriminator-value": "integer", "x-discriminator-name": "type" }, - "GsaLogicalChartData": { + "GsaIntegerFixedWidthHistogramAggregationDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaChartData" + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, { "type": "object", "properties": { - "value": { - "type": "boolean" + "interval": { + "type": "number", + "description": "Fixed size of the resulting histogram buckets", + "format": "double" + }, + "offset": { + "type": "number", + "description": "Offset of the lowest bucket boundary. Defaults to 0. Must be less than the interval.", + "format": "double" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", - "x-discriminator-value": "logical", + "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerFixedWidthHistogram'", + "x-discriminator-value": "integerFixedWidthHistogram", "x-discriminator-name": "type" }, - "GsaLogicalDatum": { + "GsaIntegerHistogramAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaApplicableDatum" + "$ref": "#/components/schemas/GsaAggregationDatum" }, { - "required": [ - "value" - ], "type": "object", "properties": { - "value": { - "type": "boolean" + "histogram": { + "$ref": "#/components/schemas/GsaHistogram" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", - "x-discriminator-value": "logical", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integerHistogram'", + "x-discriminator-value": "integerHistogram", "x-discriminator-name": "datumType" }, - "GsaLogicalDatumCriterion": { + "GsaIntegerHistogramAggregationDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, { - "required": [ - "value" - ], "type": "object", "properties": { - "value": { - "type": "boolean", - "description": "Logical search value" + "maximumNumberOfBuckets": { + "type": "integer", + "format": "int32" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", - "x-discriminator-value": "logical", - "x-discriminator-name": "type" - }, - "GsaLogicalDatumExistsCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", - "x-discriminator-value": "logical", + "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerHistogram'", + "x-discriminator-value": "integerHistogram", "x-discriminator-name": "type" }, - "GsaLongRunningOperation": { + "GsaIntegrationAttribute": { "required": [ - "identifier", - "status" + "name", + "type" ], "type": "object", "properties": { - "identifier": { + "name": { + "type": "string" + }, + "identity": { + "type": "integer", + "format": "int32" + }, + "guid": { "type": "string", "format": "uuid" }, - "status": { - "$ref": "#/components/schemas/GsaLongRunningStatus" + "type": { + "$ref": "#/components/schemas/GsaAttributeType" }, - "numberOfCompletedTasks": { - "type": "number", - "description": "The total number of tasks that have been completed so far.\r\nMay be null if the tasks are not easily quantifiable.\r\nWill change as the operation progresses.\r\nMay be fractional if a task is partially complete.\r\nAll tasks completed does not necessarily mean the operation has completed, there may be additional work.", - "format": "double", + "unitSymbol": { + "type": "string", + "description": "If isUnitted is true, then this must have a non empty value", "nullable": true }, - "numberOfTasks": { - "type": "integer", - "description": "The total number of tasks to be completed.\r\nMay be null if the tasks are not easily quantifiable, or if the total number of tasks is not known.\r\nMay change as the operation progresses.", - "format": "int32", + "isUnitted": { + "type": "boolean", "nullable": true }, - "httpStatusCode": { + "discreteTypeIdentity": { "type": "integer", - "description": "Will not be set if the operation has not completed.", "format": "int32", "nullable": true }, - "response": { - "type": "object", - "description": "Will not be set if the operation has not completed.\r\nCould be a success response or an error response depending on whether the operation succeeded or failed.\r\nThe response may be null, depending on the operation.", + "discreteTypeGuid": { + "type": "string", + "description": "A discrete attribute must define the guid of its discrete type (i.e. list of possible values)", + "format": "uuid", + "nullable": true + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationParameterInfo" + }, + "description": "A float functional attribute must define a list of parameters.", + "nullable": true + }, + "targetDatabase": { + "$ref": "#/components/schemas/GsaObjectIdentifier" + }, + "targetTable": { + "$ref": "#/components/schemas/GsaObjectIdentifier" + }, + "graphType": { + "type": "string", + "description": "A float functional attribute must be either a Series or a Grid type graph.", + "nullable": true + }, + "xAxisParameter": { + "type": "string", + "description": "A float functional attribute must define an x-axis. This will be one of the parameters listed in parameters", "nullable": true } }, - "additionalProperties": false - }, - "GsaLongRunningOperationInclude": { - "enum": [ - "response" - ], - "type": "string" + "additionalProperties": false, + "description": "An attribute as defined in an integration schema.\r\n\r\ntargetDatabase: A link attribute must define the database of the linked records.\r\n\r\ntargetTable: A link attribute must define the table of the linked records." }, - "GsaLongRunningOperationInvalidStatusException": { + "GsaIntegrationDataExportRequest": { "required": [ - "status" + "attributeIdentities" ], "type": "object", "properties": { - "message": { + "recordReferences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaRecordReference" + }, + "description": "A list of record references to export. These are references to the underlying records in the source database.\r\nData can be exported for either record histories or record versions in each request, not both.", + "nullable": true + }, + "attributeIdentities": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of attribute to export. These are the attribute identities from the integration schema." + } + }, + "additionalProperties": false + }, + "GsaIntegrationDiscreteType": { + "type": "object", + "properties": { + "identity": { + "type": "integer", + "format": "int32" + }, + "guid": { + "type": "string", + "format": "uuid" + }, + "name": { "type": "string", "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "An integration schema discrete type defines the list of values that a discrete attribute can take." + }, + "GsaIntegrationLayout": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true }, - "status": { - "$ref": "#/components/schemas/GsaLongRunningStatus" + "attributeIdentities": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "attributeGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "An integration schema layout is named list of attribute identities." + }, + "GsaIntegrationParameterInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "identity": { + "type": "integer", + "format": "int32" + }, + "guid": { + "type": "string", + "format": "uuid" + }, + "unitSymbol": { + "type": "string", + "nullable": true + }, + "scaleType": { + "$ref": "#/components/schemas/GsaParameterInfoScaleType" + }, + "interpolationType": { + "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" + }, + "parameterType": { + "$ref": "#/components/schemas/GsaParameterInfoParameterType" + }, + "defaultValue": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" } }, "additionalProperties": false }, - "GsaLongRunningStatus": { - "enum": [ - "pending", - "inProgress", - "succeeded", - "failed", - "cancelled", - "awaitingCancellation" + "GsaIntegrationSchemaGenerationErrorDetail": { + "required": [ + "message", + "reason" ], - "type": "string" + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "reason": { + "type": "string" + } + }, + "additionalProperties": false }, - "GsaLongSortingValue": { + "GsaIntegrationSchemaOfObjectIdentifier": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSortingValue" + "properties": { + "key": { + "type": "string", + "nullable": true }, - { + "version": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationAttribute" + }, + "nullable": true + }, + "layouts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationLayout" + }, + "nullable": true + }, + "unitSystem": { + "type": "string", + "nullable": true + }, + "discreteTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationDiscreteType" + }, + "nullable": true + }, + "sources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" + }, + "nullable": true + }, + "accessControlCategoryValues": { "type": "object", - "properties": { - "value": { - "type": "integer", - "format": "int64" - } - } + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "nullable": true + }, + "securityGroups": { + "$ref": "#/components/schemas/GsaSecurityGroups" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSortingValue](#model-GsaSortingValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'long'", - "x-discriminator-value": "long", - "x-discriminator-name": "type" + "description": "A type representing an integration schema. An integration schema is a schema that describes\r\na shape that data must conform to, similar to an MI schema, but unlike an MI schema, an\r\nintegration schema does not have any corresponding data stored in it. Instead, an integration\r\nschema defines mappings or transformations from existing stored data, which may be a different\r\nshape from the integration schema." }, - "GsaLongTextAttribute": { + "GsaIntegrationSchemaStatus": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttribute" + "properties": { + "loadedDatabases": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Loaded databases have been successfully indexed into the integration schema.", + "nullable": true + }, + "loadingDatabases": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Databases which are in the process of loading.", + "nullable": true + }, + "notLoadedDatabases": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Databases that are referenced in the schema but that are not yet loaded. This could be because they are still queued for\r\nload in the MI system, or because they have not yet been added.", + "nullable": true + }, + "erroredDatabases": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "description": "Databases that encountered an error while loading. These databases will not be available for searches.", + "nullable": true + }, + "loadedDatabaseIndexStatuses": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GsaSearchIndexStatus" + }, + "description": "Index information about all loaded databases, including the out of sync status.", + "nullable": true + }, + "searchIndexUpToDate": { + "type": "boolean", + "description": "Whether all changes up to and including the most recent database revision have been sent to the search index. This will return true\r\neven if some of those revisions could not be indexed" + }, + "searchIndexOutOfDateDuration": { + "type": "string", + "description": "How long has the index been out of date.\r\nSpecifically the duration between the first non-indexed revision and the current time.", + "format": "date-span", + "nullable": true }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", - "x-discriminator-value": "longText", - "x-discriminator-name": "type" - }, - "GsaLongTextDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaApplicableDatum" + "searchIndexInSync": { + "type": "boolean", + "description": "Returns false if the search index is out of sync with the database (i.e. because changes were made that could not be indexed)" }, - { - "required": [ - "richTextValue" - ], - "type": "object", - "properties": { - "richTextValue": { - "$ref": "#/components/schemas/GsaRichTextValue" - } - } + "searchIndexLocation": { + "type": "string", + "description": "The location of the index.", + "nullable": true + }, + "searchIndexIsReadOnly": { + "type": "boolean", + "description": "True if the index is read only.", + "nullable": true + }, + "searchIndexUnavailable": { + "type": "boolean", + "description": "True if the index could not be contacted.", + "nullable": true + }, + "recordsThatFailedToIndex": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIndexRecordFailure" + }, + "description": "Details of any records that failed to index.", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", - "x-discriminator-value": "longText", - "x-discriminator-name": "datumType" + }, + "additionalProperties": false }, - "GsaLongTextDatumCriterion": { + "GsaInvalidKeyAddDatabaseValidationIssue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaAddDatabaseValidationIssue" }, { "required": [ - "value" + "databaseKey" ], "type": "object", "properties": { - "value": { - "type": "string", - "description": "Long text search value" + "databaseKey": { + "type": "string" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", - "x-discriminator-value": "longText", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'invalidKey'", + "x-discriminator-value": "invalidKey", + "x-discriminator-name": "IssueType" }, - "GsaLongTextDatumExistsCriterion": { + "GsaInvalidParentStateErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" + "$ref": "#/components/schemas/GsaVersionControlErrorDetail" }, { "type": "object" } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", - "x-discriminator-value": "longText", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidParentState'", + "x-discriminator-value": "invalidParentState", + "x-discriminator-name": "reason" }, - "GsaLongTextPrefixDatumCriterion": { + "GsaInvalidVersionStateErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaVersionControlErrorDetail" }, { - "required": [ - "prefix" - ], "type": "object", "properties": { - "prefix": { - "type": "string" + "versionState": { + "$ref": "#/components/schemas/GsaVersionState" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longTextPrefix'", - "x-discriminator-value": "longTextPrefix", - "x-discriminator-name": "type" - }, - "GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "The Many to Many model cannot forbid orphans.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'manyToManyForbidOrphans'", - "x-discriminator-value": "manyToManyForbidOrphans", + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidVersionState'", + "x-discriminator-value": "invalidVersionState", "x-discriminator-name": "reason" }, - "GsaMappingOfObjectIdentifier": { + "GsaJob": { "type": "object", "properties": { - "source": { - "$ref": "#/components/schemas/GsaObjectIdentifier" + "id": { + "type": "string", + "format": "uuid" }, - "targetIdentity": { - "type": "integer", - "description": "The identity of the integration schema attribute", - "format": "int32" + "name": { + "type": "string", + "nullable": true }, - "targetGuid": { + "description": { "type": "string", - "description": "The guid of the integration schema attribute", - "format": "uuid" + "nullable": true }, - "parameterMappings": { + "type": { + "type": "string", + "nullable": true + }, + "submitterName": { + "type": "string", + "nullable": true + }, + "submitterRoles": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaMappingOfObjectIdentifier" + "type": "string" }, - "description": "Any mapped parameters (float functional attributes only). The target parameters must be defined on the target integration attribute.\r\nNot every parameters from the source database needs to be mapped for each attribute.", "nullable": true }, - "linkSourceType": { - "$ref": "#/components/schemas/GsaLinkSourceType" - } - }, - "additionalProperties": false, - "description": "A mapping between a source database item and an integration schema attribute." - }, - "GsaMatchMode": { - "enum": [ - "BasicGuidMatch", - "MatchOnGuidThenName", - "FullGuidSync" - ], - "type": "string", - "description": "How to match update items.

Possible values:

\r\n
    \r\n
  • BasicGuidMatch: Items are matched based on their guids alone.
    • \r\n
  • MatchOnGuidThenName: Items are matched based on their guids. Missing items are matched on name.
    • \r\n
  • FullGuidSync: Items are matched on their guids. Missing items are matched on name and have their guids rewritten to match those from the update file.
    • \r\n
\r\n" - }, - "GsaMathsContent": { - "required": [ - "parameterContents", - "transposeAxes", - "useLogarithmicScale" - ], - "type": "object", - "properties": { - "curveLabel": { + "submissionDate": { "type": "string", + "format": "date-time", "nullable": true }, - "transposeAxes": { - "type": "boolean" + "scheduledExecutionDate": { + "type": "string", + "format": "date-time", + "nullable": true }, - "useLogarithmicScale": { - "type": "boolean" + "executionDate": { + "type": "string", + "format": "date-time", + "nullable": true }, - "expression": { - "$ref": "#/components/schemas/GsaSlimExpression" + "completionDate": { + "type": "string", + "format": "date-time", + "nullable": true }, - "freeParameter": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "status": { + "$ref": "#/components/schemas/GsaJobStatus" }, - "parameterContents": { + "inputFileIds": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaParameterContent" - } + "type": "string" + }, + "nullable": true + }, + "outputFileNames": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "position": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "jobSpecificOutputs": { + "type": "object", + "additionalProperties": { + "type": "object", + "nullable": true + }, + "nullable": true } }, "additionalProperties": false }, - "GsaMathsFunctionalAttribute": { + "GsaJobStatus": { + "enum": [ + "Pending", + "Running", + "Succeeded", + "Failed", + "Cancelled" + ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • Pending: Pending
    • \r\n
  • Running: Running
    • \r\n
  • Succeeded: Succeeded
    • \r\n
  • Failed: Failed
    • \r\n
  • Cancelled: Cancelled
    • \r\n
\r\n" + }, + "GsaJobTypeAndStatus": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttribute" + "properties": { + "jobType": { + "type": "string", + "nullable": true }, - { - "required": [ - "allowAllCompatibleExpressions", - "allowAnonymousExpressions", - "allowExtrapolation", - "attributeParameters", - "defaultContent", - "expressions", - "isRange" - ], - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" - }, - "attributeParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - }, - "expressions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimExpression" - } - }, - "allowExtrapolation": { - "type": "boolean" - }, - "isRange": { - "type": "boolean" - }, - "allowAllCompatibleExpressions": { - "type": "boolean" - }, - "allowAnonymousExpressions": { - "type": "boolean" - }, - "defaultContent": { - "$ref": "#/components/schemas/GsaMathsContent" - } - } + "status": { + "type": "string", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", - "x-discriminator-value": "mathsFunctional", - "x-discriminator-name": "type" + }, + "additionalProperties": false }, - "GsaMathsFunctionalAttributeErrorDetail": { + "GsaLastModifiedByUserProperty": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaProperty" }, { "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" - }, + "lastModifiedByUser": { + "type": "string", "nullable": true } } } ], "additionalProperties": false, - "description": "Errors specific to Maths Functional attributes.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'mathsFunctional'", - "x-discriminator-value": "mathsFunctional", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedByUser'", + "x-discriminator-value": "lastModifiedByUser", + "x-discriminator-name": "propertyName" }, - "GsaMathsFunctionalDatumCriterion": { + "GsaLastModifiedDateProperty": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatumCriterion" + "$ref": "#/components/schemas/GsaProperty" }, { "type": "object", "properties": { - "gte": { - "type": "number", - "description": "Greater than or equal to", - "format": "double", - "nullable": true - }, - "lte": { - "type": "number", - "description": "Less than or equal to", - "format": "double", - "nullable": true - }, - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterConstraint" - }, - "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.", - "nullable": true + "lastModifiedDate": { + "type": "string", + "format": "date-time" } } } ], "additionalProperties": false, - "description": "mathsFunctional: Criterion for matching records with maths functional data (EELs)\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", - "x-discriminator-value": "mathsFunctional", - "x-discriminator-name": "type" - }, - "GsaMathsFunctionalDatumExistsCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDatumExistsCriterion" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", - "x-discriminator-value": "mathsFunctional", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedDate'", + "x-discriminator-value": "lastModifiedDate", + "x-discriminator-name": "propertyName" }, - "GsaMathsFunctionalErrorDetail": { + "GsaLayout": { "required": [ - "message", - "reason" + "applicableApplications", + "displayNames", + "guid", + "name", + "sections" ], "type": "object", "properties": { - "message": { + "sections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaLayoutSection" + } + }, + "applicableApplications": { + "type": "array", + "items": { + "type": "string" + }, + "description": "If there are no ApplicableApplications, the layout is applicable in all applications." + }, + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + } + }, + "name": { "type": "string" }, - "reason": { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorReason" + "guid": { + "type": "string", + "format": "uuid" } }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail](#model-GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail)\r\n * [GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail](#model-GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail)\r\n * [GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail](#model-GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail)\r\n * [GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail](#model-GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail)\r\n * [GsaExpressionMathsFunctionalErrorDetail](#model-GsaExpressionMathsFunctionalErrorDetail)\r\n * [GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail](#model-GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail)\r\n * [GsaNoExpressionsMathsFunctionalErrorDetail](#model-GsaNoExpressionsMathsFunctionalErrorDetail)\r\n * [GsaNoSuchExpressionsMathsFunctionalErrorDetail](#model-GsaNoSuchExpressionsMathsFunctionalErrorDetail)\r\n * [GsaParameterContentMathsFunctionalErrorDetail](#model-GsaParameterContentMathsFunctionalErrorDetail)\r\n * [GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail](#model-GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail)\r\n * [GsaParameterContentUnknownParametersMathsFunctionalErrorDetail](#model-GsaParameterContentUnknownParametersMathsFunctionalErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "anonymousExpressionsMustAllowAllCompatible": "#/components/schemas/GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail", - "defaultExpressionNotFound": "#/components/schemas/GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail", - "defaultFreeParameterNotFound": "#/components/schemas/GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail", - "duplicateExpressionGuids": "#/components/schemas/GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail", - "expression": "#/components/schemas/GsaExpressionMathsFunctionalErrorDetail", - "expressionsHaveUnknownParameters": "#/components/schemas/GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail", - "noExpressions": "#/components/schemas/GsaNoExpressionsMathsFunctionalErrorDetail", - "noSuchExpressions": "#/components/schemas/GsaNoSuchExpressionsMathsFunctionalErrorDetail", - "parameterContent": "#/components/schemas/GsaParameterContentMathsFunctionalErrorDetail", - "parameterContentDuplicateGuids": "#/components/schemas/GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail", - "parameterContentUnknownParameters": "#/components/schemas/GsaParameterContentUnknownParametersMathsFunctionalErrorDetail" - } - } - }, - "GsaMathsFunctionalErrorReason": { - "enum": [ - "anonymousExpressionsMustAllowAllCompatible", - "defaultExpressionNotFound", - "defaultFreeParameterNotFound", - "duplicateExpressionGuids", - "expression", - "expressionsHaveUnknownParameters", - "noExpressions", - "noSuchExpressions", - "parameterContent", - "parameterContentDuplicateGuids", - "parameterContentUnknownParameters" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • anonymousExpressionsMustAllowAllCompatible: Anonymous expressions cannot be allowed without allowing all compatible expressions.
    • \r\n
  • defaultExpressionNotFound: Default expression must be from attribute's expressions.
    • \r\n
  • defaultFreeParameterNotFound: Default free parameter must be from attribute's parameters.
    • \r\n
  • duplicateExpressionGuids: No duplicate expression GUIDs allowed.
    • \r\n
  • expression: Expression is invalid. See \"errors\" for details.
    • \r\n
  • expressionsHaveUnknownParameters: Parameter lists lacks some parameters required by the chosen expressions.
    • \r\n
  • noExpressions: Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.
    • \r\n
  • noSuchExpressions: The not found GUIDs do not correspond to existing expressions.
    • \r\n
  • parameterContent: ParameterContent is not valid. See \"errors\" for details.
    • \r\n
  • parameterContentDuplicateGuids: No duplicate parameter GUIDs allowed in parameter contents.
    • \r\n
  • parameterContentUnknownParameters: Parameters in parameter contents must be from this attribute's parameters.
    • \r\n
\r\n" + "additionalProperties": false }, - "GsaMaxPermissionsReachedPermissionErrorDetail": { + "GsaLayoutAttributeItem": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" + "$ref": "#/components/schemas/GsaLayoutItem" }, { "required": [ - "maxNumberOfPermissions" + "attributeType", + "readOnly", + "required" ], "type": "object", "properties": { - "maxNumberOfPermissions": { - "type": "integer", - "format": "int32" + "attributeType": { + "$ref": "#/components/schemas/GsaAttributeType" + }, + "required": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "metaAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaLayoutAttributeItem" + }, + "nullable": true + }, + "tabularColumns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaLayoutTabularColumn" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "There are no more permissions available, the maximum number has been reached.\r\nA schema for a database may have up to 128 permissions.\r\nThis is the total number of permissions that have ever existed in the schema\r\n\r\nThis extends: [GsaPermissionErrorDetail](#model-GsaPermissionErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'maxPermissionsReached'", - "x-discriminator-value": "maxPermissionsReached", - "x-discriminator-name": "reason" - }, - "GsaMetaAttributeCannotHaveMetaAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Meta-attribute Cannot have a meta-attribute.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'metaAttributeCannotHaveMetaAttribute'", - "x-discriminator-value": "metaAttributeCannotHaveMetaAttribute", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", + "x-discriminator-value": "attribute", + "x-discriminator-name": "itemType" }, - "GsaMfaExpressionErrorDetail": { + "GsaLayoutItem": { "required": [ - "message", - "reason" + "guid", + "itemType", + "name", + "underlyingEntityGuid" ], "type": "object", "properties": { - "message": { + "itemType": { + "$ref": "#/components/schemas/GsaLayoutItemType" + }, + "underlyingEntityGuid": { + "type": "string", + "format": "uuid" + }, + "name": { "type": "string" }, - "reason": { - "$ref": "#/components/schemas/GsaMfaExpressionErrorReason" + "guid": { + "type": "string", + "format": "uuid" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaLayoutAttributeItem\r\n * GsaLayoutLinkItem", + "discriminator": { + "propertyName": "itemType", + "mapping": { + "attribute": "#/components/schemas/GsaLayoutAttributeItem", + "link": "#/components/schemas/GsaLayoutLinkItem" + } + } }, - "GsaMfaExpressionErrorReason": { + "GsaLayoutItemLinkType": { "enum": [ - "notAnAttributeExpression", - "incompatibleUnit", - "expressionAlreadyUsesThisAttribute", - "anonymousExpression" + "recordLink", + "smartLink", + "crossDatabaseLink", + "associationChain" ], "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • notAnAttributeExpression: Expression is not an attribute expression.
    • \r\n
  • incompatibleUnit: Expression unit is incompatible with attribute unit.
    • \r\n
  • expressionAlreadyUsesThisAttribute: Expression already uses this attribute.
    • \r\n
  • anonymousExpression: Expression is an anonymous expression.
    • \r\n
\r\n" + "description": "The types of layout items that represent links to another table." }, - "GsaMiVersion": { - "type": "object", - "properties": { - "binaryCompatibilityVersion": { - "type": "string" - }, - "version": { - "type": "string" - }, - "majorMinorVersion": { - "type": "string" - } - }, - "additionalProperties": false + "GsaLayoutItemType": { + "enum": [ + "attribute", + "link" + ], + "type": "string", + "description": "The types of layout item that are supported by the API." }, - "GsaMissingArgumentsParameterContentErrorDetail": { + "GsaLayoutLinkItem": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterContentErrorDetail" + "$ref": "#/components/schemas/GsaLayoutItem" }, { + "required": [ + "forwards", + "linkType", + "targetTable" + ], "type": "object", "properties": { - "missingArgument": { - "$ref": "#/components/schemas/GsaParameterContentMissingArgument" + "linkType": { + "$ref": "#/components/schemas/GsaLayoutItemLinkType" + }, + "targetDatabase": { + "type": "string", + "description": "May be null for a cross database link group that can target multiple databases", + "format": "uuid", + "nullable": true + }, + "targetDatabaseVersion": { + "type": "string", + "description": "May be null for a cross database link group that can target multiple databases", + "format": "uuid", + "nullable": true + }, + "targetTable": { + "type": "string", + "format": "uuid" + }, + "forwards": { + "type": "boolean", + "description": "true if the link points from the table the layout is in; or false if it points towards the table the layout is in (an inbound link)." + }, + "nextLink": { + "$ref": "#/components/schemas/GsaLayoutLinkItem" } } } ], "additionalProperties": false, - "description": "MissingArgument must be provided.\r\n\r\nThis extends: [GsaParameterContentErrorDetail](#model-GsaParameterContentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingArguments'", - "x-discriminator-value": "missingArguments", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'link'", + "x-discriminator-value": "link", + "x-discriminator-name": "itemType" }, - "GsaMissingParameterGuidAttributeErrorDetail": { + "GsaLayoutSection": { + "required": [ + "displayNames", + "guid", + "name", + "sectionDetailType" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "properties": { + "sectionDetailType": { + "$ref": "#/components/schemas/GsaLayoutSectionDetailType" }, - { - "type": "object" + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + } + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } - ], + }, "additionalProperties": false, - "description": "All supplied attribute parameters must have parameter GUIDs specified.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingParameterGuid'", - "x-discriminator-value": "missingParameterGuid", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis is one of: \r\n * GsaSlimLayoutSection\r\n * GsaFullLayoutSection", + "discriminator": { + "propertyName": "sectionDetailType", + "mapping": { + "slim": "#/components/schemas/GsaSlimLayoutSection", + "full": "#/components/schemas/GsaFullLayoutSection" + } + } }, - "GsaMoveFile": { - "required": [ - "folderGuid" + "GsaLayoutSectionDetailType": { + "enum": [ + "slim", + "full" ], + "type": "string", + "description": "The types of detail returned for a layout section." + }, + "GsaLayoutSectionsInfo": { "type": "object", "properties": { - "folderGuid": { - "type": "string", - "format": "uuid" + "layoutSections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaLayoutSection" + }, + "nullable": true } }, "additionalProperties": false }, - "GsaMoveFolder": { + "GsaLayoutTabularColumn": { "required": [ - "parentGuid" + "columnType", + "guid", + "name", + "tabularColumnGuid" ], "type": "object", "properties": { - "parentGuid": { + "columnType": { + "$ref": "#/components/schemas/GsaTabularColumnDtoType" + }, + "tabularColumnGuid": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "guid": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, - "GsaMoveRecordHistory": { + "GsaLayoutsInfo": { "type": "object", "properties": { - "newParent": { - "$ref": "#/components/schemas/GsaSlimRecordHistory" + "layouts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimLayout" + }, + "nullable": true } }, "additionalProperties": false }, - "GsaMultiValuedAttributeErrorDetail": { + "GsaLinkAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaAggregationDatum" }, { "type": "object", "properties": { - "multiValuedReasons": { + "localAggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaMultiValuedReason" + "$ref": "#/components/schemas/GsaLocalColumnAggregation" }, "nullable": true } @@ -111287,2289 +76493,2281 @@ } ], "additionalProperties": false, - "description": "Cannot update the multi-valued flag. See multiValuedReasons for details.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'multiValued'", - "x-discriminator-value": "multiValued", - "x-discriminator-name": "reason" - }, - "GsaMultiValuedPointDataUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'multiValuedPointData'", - "x-discriminator-value": "multiValuedPointData", - "x-discriminator-name": "referencedByType" - }, - "GsaMultiValuedReason": { - "enum": [ - "hasMultiValuedData", - "isInDynamicLinkIndex", - "isLinkedFromTabularColumn", - "isUsedInExpression", - "isUsedInXYChartTemplate" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • hasMultiValuedData: This attribute already has data with more than one value
    • \r\n
  • isInDynamicLinkIndex: This attribute is being used as an index in a smart link group
    • \r\n
  • isLinkedFromTabularColumn: There is a link to this attribute from one or more tabular attributes
    • \r\n
  • isUsedInExpression: This attribute is being linked to from an expression
    • \r\n
  • isUsedInXYChartTemplate: This attribute is being linked to from an XY chart template
    • \r\n
\r\n" + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'", + "x-discriminator-value": "link", + "x-discriminator-name": "datumType" }, - "GsaMultiValuedSmartAttributesErrorDetail": { + "GsaLinkAggregationDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, { - "required": [ - "attributeGuid" - ], "type": "object", "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" + "localAggregationCriteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "Multi-valued Attributes are not supported in Smart Link Group Attribute pairs.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'multiValued'", - "x-discriminator-value": "multiValued", - "x-discriminator-name": "reason" + "description": "Criterion for aggregating data within a tabular attribute. The local columns specified will be individually aggregated\r\nacross all rows (including rows without linked records, which may be hidden in clients).\r\n \r\nThe returned aggregation will contain a list of the individual column aggregations that have been performed. Within these\r\ncolumn aggregations, the 'record count' instead denotes the number of relevant tabular rows across all records in the\r\naggregation scope, rather than the number of records. This row count will include rows that may be hidden from the user's\r\nview in certain clients.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "x-discriminator-value": "link", + "x-discriminator-name": "type" }, - "GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail": { + "GsaLinkAttributeToExport": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" + "$ref": "#/components/schemas/GsaAttributeToExport" }, { "type": "object", "properties": { - "attributeGuid": { + "localData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSimpleAttributeToExport" + }, + "description": "The local columns to export. Reuse the attribute object here - but the 'attribute id' is now the column id.", + "nullable": true + }, + "targetTableGuid": { "type": "string", - "format": "uuid" + "description": "Table containing the linked records", + "format": "uuid", + "nullable": true }, - "tableDiscreteValueCount": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'multipleDefaultValuesInSingleValuedDiscrete'", - "x-discriminator-value": "multipleDefaultValuesInSingleValuedDiscrete", - "x-discriminator-name": "reason" - }, - "GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "The name matches the reverse name of a record link group targeting this table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadyExistsAsReverse'", - "x-discriminator-value": "nameAlreadyExistsAsReverse", - "x-discriminator-name": "reason" - }, - "GsaNameAlreadyExistsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { + "targetDatabaseGuid": { "type": "string", + "description": "Database containing the linked records. For reverse cross database links, this is the database where the link is defined.\r\nThis is not required for cross-database link groups that don't have a target database.", + "format": "uuid", "nullable": true }, - "parentEntityType": { - "$ref": "#/components/schemas/GsaEntityType" - } - } - } - ], - "additionalProperties": false, - "description": "Database Entity with name already exists.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadyExists'", - "x-discriminator-value": "nameAlreadyExists", - "x-discriminator-name": "reason" - }, - "GsaNameAlreadySpecifiedErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { + "targetAttributeGuid": { "type": "string", + "description": "For tabular searching: this is the identifier of the short-text linking attribute.\r\nOtherwise null.", + "format": "uuid", + "nullable": true + }, + "linkAttributeType": { + "$ref": "#/components/schemas/GsaLinkAttributeType" + }, + "exportInReversedDirection": { + "type": "boolean" + }, + "recordProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaRecordProperty" + }, + "description": "The properties to export on any linked records.", + "nullable": true + }, + "attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAttributeToExport" + }, + "description": "The attributes to export on any linked records.", "nullable": true + }, + "linkedRecordsExportBehavior": { + "$ref": "#/components/schemas/GsaLinkedRecordExportBehavior" + }, + "indirectLinksBehavior": { + "$ref": "#/components/schemas/GsaIndirectLinks" } } } ], "additionalProperties": false, - "description": "Name has been specified more than once in the request.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadySpecified'", - "x-discriminator-value": "nameAlreadySpecified", - "x-discriminator-name": "reason" - }, - "GsaNameMissingCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Currency must have a name.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameMissing'", - "x-discriminator-value": "nameMissing", - "x-discriminator-name": "reason" - }, - "GsaNameNotProvidedErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Entity must have a name.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameNotProvided'", - "x-discriminator-value": "nameNotProvided", - "x-discriminator-name": "reason" + "description": "Export request information for a 'link' attribute.\r\n\r\nThis extends: GsaAttributeToExport\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'link'", + "x-discriminator-value": "link", + "x-discriminator-name": "attributeType" }, - "GsaNameSameAsReverseNameRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } + "GsaLinkAttributeType": { + "enum": [ + "recordLink", + "crossDatabaseLink", + "dynamicLink", + "tabularAttribute" ], - "additionalProperties": false, - "description": "Record link group name and reverse name cannot be the same.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameSameAsReverseName'", - "x-discriminator-value": "nameSameAsReverseName", - "x-discriminator-name": "reason" + "type": "string" }, - "GsaNameWhitespaceCurrencyErrorDetail": { + "GsaLinkDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { + "required": [ + "linkDatumType" + ], "type": "object", "properties": { - "name": { + "targetTableIdentity": { + "type": "integer", + "description": "Table containing the linked records.\r\nThe target table can be omitted; it is likely to improve performance if it is included.\r\nFor tabular search, if either the target attribute or the target table is provided, they should both be provided.", + "format": "int32", + "nullable": true + }, + "targetTableGuid": { "type": "string", + "description": "Table containing the linked records.\r\nThe target table can be omitted; it is likely to improve performance if it is included.\r\nFor tabular search, if either the target attribute or the target table is provided, they should both be provided.", + "format": "uuid", "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Currency name must not contain leading or trailing whitespace.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameWhitespace'", - "x-discriminator-value": "nameWhitespace", - "x-discriminator-name": "reason" - }, - "GsaNameWhitespaceParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { + }, + "targetDatabaseKey": { + "type": "string", + "description": "Database containing the linked records. For reverse cross database links, this is the database where the link is defined", + "nullable": true + }, + "localCriterion": { + "$ref": "#/components/schemas/GsaCriterion" + }, + "linkDatumType": { + "$ref": "#/components/schemas/GsaLinkAttributeType" + }, + "indirectLinks": { + "$ref": "#/components/schemas/GsaIndirectLinks" + }, + "searchInReversedDirection": { + "type": "boolean" + }, + "targetAttributeIdentity": { + "type": "integer", + "description": "For tabular searching: this is the identity of the short-text linking attribute.\r\nThe target attribute and table can both be omitted; it is likely to improve performance if they are included.\r\nIf either the target attribute or the target table is provided, they should both be provided.\r\nOtherwise null.", + "format": "int32", + "nullable": true + }, + "targetAttributeGuid": { "type": "string", + "description": "For tabular searching: this is the GUID of the short-text linking attribute.\r\n/// The target attribute and table can both be omitted; it is likely to improve performance if they are included.\r\nIf either the target attribute or the target table is provided, they should both be provided.\r\nOtherwise null.", + "format": "uuid", "nullable": true + }, + "innerCriterion": { + "$ref": "#/components/schemas/GsaCriterion" + }, + "localRowsBehavior": { + "$ref": "#/components/schemas/GsaLocalRowsBehavior" } } } ], "additionalProperties": false, - "description": "Parameter value names must not contain leading or trailing whitespace.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameWhitespace'", - "x-discriminator-value": "nameWhitespace", - "x-discriminator-name": "reason" + "description": "link: Criterion for matching records that are linked to records that match the inner criterion. The target database and table specify the location of the linked records.\r\nThe inner criterion must be a criterion that applies to the records in the linked table. The link group followed will be the link group specified on the outer AttributeCriterion.\r\nA target database is required unless searching local tabular data - In that case, the inner criterion must be absent, and the local criterion will be used.\r\n\r\nlocalCriterion: Criterion to filter local properties of the link. For a tabular attribute search, this will be a criterion against the local columns and so it will use column ids/guids instead of attribute ones. For other types of link, this is currently unused.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\ninnerCriterion: Criterion to run to filter the linked records. When running linked search for tabular attribute we are searching against actual records and attributes, so attribute ids/guids should be used instead of column ids/guids.\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns, or a tabular data exists search.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "x-discriminator-value": "link", + "x-discriminator-name": "type" }, - "GsaNamedCriterion": { + "GsaLinkExistsDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaCriterion" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { + "required": [ + "targetDatabaseKey" + ], "type": "object", "properties": { - "name": { + "targetTableIdentity": { + "type": "integer", + "description": "Table containing the linked records", + "format": "int32", + "nullable": true + }, + "targetTableGuid": { "type": "string", + "description": "Table containing the linked records", + "format": "uuid", "nullable": true }, - "innerCriterion": { - "$ref": "#/components/schemas/GsaCriterion" + "targetDatabaseKey": { + "type": "string", + "description": "Database containing the linked records. For reverse cross database links, this is the database where the link is defined" + }, + "linkDatumType": { + "$ref": "#/components/schemas/GsaLinkAttributeType" + }, + "indirectLinks": { + "$ref": "#/components/schemas/GsaIndirectLinks" + }, + "searchInReversedDirection": { + "type": "boolean" + }, + "localRowsBehavior": { + "$ref": "#/components/schemas/GsaLocalRowsBehavior" + }, + "targetAttributeIdentity": { + "type": "integer", + "description": "For tabular searching: this is the identity of the short-text linking attribute.\r\nOtherwise null.", + "format": "int32", + "nullable": true + }, + "targetAttributeGuid": { + "type": "string", + "description": "For tabular searching: this is the GUID of the short-text linking attribute.\r\nOtherwise null.", + "format": "uuid", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'namedCriterion'", - "x-discriminator-value": "namedCriterion", + "description": "link: Criterion for matching records that are linked to records by the given link group. The target database and table specify the location of the linked records.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "x-discriminator-value": "link", "x-discriminator-name": "type" }, - "GsaNamedEntityAccessControlCategoryErrorDetail": { + "GsaLinkExportFailure": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" + "$ref": "#/components/schemas/GsaExportFailure" }, { "required": [ - "errors" + "failedLink" ], "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } + "failedLink": { + "$ref": "#/components/schemas/GsaLinkReference" } } } ], "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "x-discriminator-value": "link", + "x-discriminator-name": "type" }, - "GsaNamedEntityAttributeErrorDetail": { + "GsaLinkInfo": { + "required": [ + "linkSource", + "linkTarget" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "properties": { + "linkSource": { + "$ref": "#/components/schemas/GsaLinkTarget" }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } + "linkTarget": { + "$ref": "#/components/schemas/GsaLinkTarget" + } + }, + "additionalProperties": false + }, + "GsaLinkReference": { + "required": [ + "linkType" + ], + "type": "object", + "properties": { + "targetDatabaseGuid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "linkIdentity": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "linkGuid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "linkType": { + "$ref": "#/components/schemas/GsaLinkAttributeType" } + }, + "additionalProperties": false + }, + "GsaLinkSourceType": { + "enum": [ + "recordLink", + "crossDatabaseLink", + "reverseCrossDatabaseLink" ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "type": "string", + "description": "Source links for an integration schema can either be static (within an single database), or cross database. Cross database links\r\nmust indicate which database they are defined in - a reverse cross database link is defined in the \"target\" database of the mapped\r\nintegration schema attribute.

Possible values:

\r\n
    \r\n
  • recordLink: A static record link that links records within a single database.
    • \r\n
  • crossDatabaseLink: Links records across multiple databases.
    • \r\n
  • reverseCrossDatabaseLink: Links records across multiple databases, and is defined in the \"target\" database of the mapped integration schema attribute. Links records in that database to the source database defined in the mapping.
    • \r\n
\r\n" }, - "GsaNamedEntityConstantErrorDetail": { + "GsaLinkTarget": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaConstantErrorDetail" + "properties": { + "databaseGuid": { + "type": "string", + "format": "uuid", + "nullable": true }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } + "databaseVersionGuid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "tableGuid": { + "type": "string", + "format": "uuid", + "nullable": true } - ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaConstantErrorDetail](#model-GsaConstantErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaNamedEntityDiscreteTypeErrorDetail": { + "GsaLinkedAttributeTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteTypeErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { "required": [ - "errors" + "linkedAttribute" ], "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } + "linkedAttribute": { + "$ref": "#/components/schemas/GsaSlimAttribute" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteTypeErrorDetail](#model-GsaDiscreteTypeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", + "x-discriminator-value": "linkedAttribute", + "x-discriminator-name": "columnType" }, - "GsaNamedEntityDiscreteValueErrorDetail": { + "GsaLinkedColumnTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteValueErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { "required": [ - "errors" + "linkedAttribute", + "linkedColumn" ], "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } + "linkedAttribute": { + "$ref": "#/components/schemas/GsaSlimAttribute" + }, + "linkedColumn": { + "$ref": "#/components/schemas/GsaTabularColumn" + }, + "linkedTarget": { + "$ref": "#/components/schemas/GsaTabularAttributeTarget" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteValueErrorDetail](#model-GsaDiscreteValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nlinkedAttribute: The tabular attribute that the linked column belongs to. The target of this tabular attribute is linkedTarget.\r\n\r\nlinkedColumn: The tabular column in the tabular linkedAttribute. Data from this column will be included.\r\n\r\nlinkedTarget: The target of the tabular linkedAttribute.\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", + "x-discriminator-value": "linkedColumn", + "x-discriminator-name": "columnType" }, - "GsaNamedEntityErrorDetail": { - "required": [ - "entityType", - "message", - "reason" - ], + "GsaLinkedRecordExportBehavior": { "type": "object", "properties": { - "message": { - "type": "string" + "tabularRowBehavior": { + "$ref": "#/components/schemas/GsaTabularRowExportBehavior" }, - "reason": { - "$ref": "#/components/schemas/GsaNamedEntityErrorReason" + "summaryRollUpType": { + "$ref": "#/components/schemas/GsaTabularColumnRollUpType" + }, + "rollUpTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaTabularColumnRollUpType" + }, + "description": "Optional: if this attribute is being used as part of a tabular export, this can be used to specify how linked records should be rolled up", + "nullable": true }, - "entityType": { - "$ref": "#/components/schemas/GsaEntityType" + "linkedRecordsCriterion": { + "$ref": "#/components/schemas/GsaCriterion" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaEntityAlreadyExistsErrorDetail](#model-GsaEntityAlreadyExistsErrorDetail)\r\n * [GsaNameNotProvidedErrorDetail](#model-GsaNameNotProvidedErrorDetail)\r\n * [GsaNameAlreadyExistsErrorDetail](#model-GsaNameAlreadyExistsErrorDetail)\r\n * [GsaNameAlreadySpecifiedErrorDetail](#model-GsaNameAlreadySpecifiedErrorDetail)\r\n * [GsaEntityIdentifierAlreadySpecifiedErrorDetail](#model-GsaEntityIdentifierAlreadySpecifiedErrorDetail)\r\n * [GsaDisplayNameEmptyErrorDetail](#model-GsaDisplayNameEmptyErrorDetail)\r\n * [GsaDisplayNameLanguageNotProvidedErrorDetail](#model-GsaDisplayNameLanguageNotProvidedErrorDetail)\r\n * [GsaDisplayNameLanguageNotSupportedErrorDetail](#model-GsaDisplayNameLanguageNotSupportedErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "entityAlreadyExists": "#/components/schemas/GsaEntityAlreadyExistsErrorDetail", - "nameNotProvided": "#/components/schemas/GsaNameNotProvidedErrorDetail", - "nameAlreadyExists": "#/components/schemas/GsaNameAlreadyExistsErrorDetail", - "nameAlreadySpecified": "#/components/schemas/GsaNameAlreadySpecifiedErrorDetail", - "entityIdentifierAlreadySpecified": "#/components/schemas/GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "displayNameEmpty": "#/components/schemas/GsaDisplayNameEmptyErrorDetail", - "displayNameLanguageNotProvided": "#/components/schemas/GsaDisplayNameLanguageNotProvidedErrorDetail", - "displayNameLanguageNotSupported": "#/components/schemas/GsaDisplayNameLanguageNotSupportedErrorDetail" - } - } - }, - "GsaNamedEntityErrorReason": { - "enum": [ - "entityAlreadyExists", - "entityIdentifierAlreadySpecified", - "nameNotProvided", - "nameAlreadyExists", - "nameAlreadySpecified", - "displayNameEmpty", - "displayNameLanguageNotProvided", - "displayNameLanguageNotSupported" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • entityAlreadyExists: Entity with GUID already exists.
    • \r\n
  • entityIdentifierAlreadySpecified: GUID has been specified more than once in the request.
    • \r\n
  • nameNotProvided: Entity must have a name.
    • \r\n
  • nameAlreadyExists: Database Entity with name already exists.
    • \r\n
  • nameAlreadySpecified: Name has been specified more than once in the request.
    • \r\n
  • displayNameEmpty: Display name cannot be empty. Display names are optional and can be set to null to remove, but cannot be an empty string or white space only.
    • \r\n
  • displayNameLanguageNotProvided: Display name must have a language.
    • \r\n
  • displayNameLanguageNotSupported: Display name language is not supported. Language must be a .NET culture, e.g. \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\"
    • \r\n
\r\n" + "description": "Optional property to allow filtering of the linked records returned in an export. If used on a tabular export, can be used to filter both the linked records and the tabular rows.\r\nIf a summary roll up is included, the summary row for the tabular datum will include a rollup of the linked records." }, - "GsaNamedEntityFileErrorDetail": { + "GsaLinkedRecordTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFileErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } + "type": "object" } ], "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", + "x-discriminator-value": "linkedRecord", + "x-discriminator-name": "columnType" }, - "GsaNamedEntityFolderErrorDetail": { + "GsaLinkingValueExistsDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFolderErrorDetail" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true + "attributeType": { + "$ref": "#/components/schemas/GsaAttributeType" + }, + "innerHitsIdentifier": { + "type": "string", + "format": "uuid" } } } ], "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaFolderErrorDetail](#model-GsaFolderErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamicLinkingValue'", + "x-discriminator-value": "dynamicLinkingValue", + "x-discriminator-name": "type" }, - "GsaNamedEntityParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } - } + "GsaLinkingValueMatchBehavior": { + "enum": [ + "AllRows", + "VisibleRows", + "ExactMatchMatchingRows", + "FreeTextMatchingRows" ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "type": "string", + "description": "Enum for use in the Granta.Server.Api.Search.TabularLinkingValueCriterion to control which tabular rows are returned

Possible values:

\r\n
    \r\n
  • AllRows: Return any row where the local data matches
    • \r\n
  • VisibleRows: Return rows with matching linking values, or no linking value
    • \r\n
  • ExactMatchMatchingRows: Return rows with matching linking values
    • \r\n
  • FreeTextMatchingRows: Return rows with linking values that match when using the usual free text search analyzers
    • \r\n
\r\n" }, - "GsaNamedEntityParameterValueErrorDetail": { + "GsaLinksInfo": { + "required": [ + "links" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } + "properties": { + "links": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaResolvedLink" } } + }, + "additionalProperties": false + }, + "GsaListAction": { + "enum": [ + "ListCreated", + "ListDeleted", + "ItemAdded", + "ItemRemoved", + "ListNameChanged", + "ListDescriptionChanged", + "ListNotesChanged", + "ListSetToAwaitingApprovalForPublishing", + "ListAwaitingApprovalForPublishingRemoved", + "ListSetToAwaitingApprovalForWithdrawal", + "ListAwaitingApprovalForWithdrawalRemoved", + "ListPublished", + "ListUnpublished", + "ListRevisionCreated", + "UserSubscribed", + "UserUnsubscribed", + "ListCuratorAdded", + "ListCuratorRemoved", + "ListAdminAdded", + "ListAdminRemoved", + "ListPublisherAdded", + "ListPublisherRemoved", + "ListMadeInternal", + "ListMadeNotInternal", + "ListRevisionDiscarded" ], - "additionalProperties": false, - "description": "The parameter value name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • ListCreated: A list has been created.
    • \r\n
  • ListDeleted: A list has been deleted.
    • \r\n
  • ItemAdded: An item has been added to a list.
    • \r\n
  • ItemRemoved: An item has been removed from a list.
    • \r\n
  • ListNameChanged: The name of a list has been changed.
    • \r\n
  • ListDescriptionChanged: The description of a list has been changed.
    • \r\n
  • ListNotesChanged: The notes for a list have been changed.
    • \r\n
  • ListSetToAwaitingApprovalForPublishing: The status of an unpublished list was set to 'awaiting approval' for publishing.
    • \r\n
  • ListAwaitingApprovalForPublishingRemoved: The 'awaiting approval for publishing' status of an unpublished list was removed.
    • \r\n
  • ListSetToAwaitingApprovalForWithdrawal: The status of a published list was set to 'awaiting approval' for withdrawal.
    • \r\n
  • ListAwaitingApprovalForWithdrawalRemoved: The 'awaiting approval for withdrawal' status of a published list was removed.
    • \r\n
  • ListPublished: The status of the list was set to 'published'.
    • \r\n
  • ListUnpublished: The status of the list was set to 'unpublished'.
    • \r\n
  • ListRevisionCreated: A revision of a list was created.
    • \r\n
  • UserSubscribed: A user subscribed to a list.
    • \r\n
  • UserUnsubscribed: A user subscribed to a list.
    • \r\n
  • ListCuratorAdded: Permissions changed - a user was set as curator for a list.
    • \r\n
  • ListCuratorRemoved: Permissions changed - a user was removed as a curator for a list.
    • \r\n
  • ListAdminAdded: Permissions changed - a user was set as admin for a list.
    • \r\n
  • ListAdminRemoved: Permissions changed - a user was removed as an admin for a list.
    • \r\n
  • ListPublisherAdded: Permissions changed - a user was set a publisher for a list.
    • \r\n
  • ListPublisherRemoved: Permissions changed - a user was removed as a publisher for a list.
    • \r\n
  • ListMadeInternal: A list was changed to be flagged as 'internal use'.
    • \r\n
  • ListMadeNotInternal: A list was changed to be flagged as 'not internal use'.
    • \r\n
  • ListRevisionDiscarded: A list revision was 'published' and discarded. Publishing a revision results in any changes to the revision list being applied to its parent before marking the revision as discarded.
    • \r\n
\r\n" }, - "GsaNamedEntityPermissionCategoryErrorDetail": { + "GsaListAuditLogItem": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" + "properties": { + "listIdentifier": { + "type": "string", + "description": "The identifier of the list that the action was performed on", + "format": "uuid" }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } - } - } + "initiatingUser": { + "$ref": "#/components/schemas/GsaListsUserOrGroup" + }, + "userOrGroupAffected": { + "$ref": "#/components/schemas/GsaListsUserOrGroup" + }, + "listItemAffected": { + "$ref": "#/components/schemas/GsaListItem" + }, + "action": { + "$ref": "#/components/schemas/GsaListAction" + }, + "timestamp": { + "type": "string", + "description": "The date/time that the action occurred.", + "format": "date-time" } - ], + }, "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\ninitiatingUser: The user that carried out the action\r\n\r\nuserOrGroupAffected: The user or group associated with the action. May be null if not relevant to the action\r\n\r\nlistItemAffected: The list item associated with the action. May be null if not relevant to the action\r\n\r\naction: The action that was carried out." }, - "GsaNamedEntityPermissionErrorDetail": { + "GsaListAuditLogSearchRequest": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" + "properties": { + "listIdentifiers": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "description": "The lists to include actions for. If null, all items will be returned", + "nullable": true }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } - } - } + "listActionsToInclude": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListAction" + }, + "description": "The types of actions to include. If null, all action types will be returned", + "nullable": true + }, + "pagingOptions": { + "$ref": "#/components/schemas/GsaListsPagingOptions" } - ], + }, "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionErrorDetail](#model-GsaPermissionErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\npagingOptions: Paging options. If null, all items will be returned." }, - "GsaNamedEntityQualityDiscreteValueErrorDetail": { + "GsaListBooleanCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaQualityDiscreteValueErrorDetail" + "$ref": "#/components/schemas/GsaListCriterion" }, { - "required": [ - "errors" - ], "type": "object", "properties": { - "errors": { + "matchAny": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } + "$ref": "#/components/schemas/GsaListCriterion" + }, + "nullable": true + }, + "matchAll": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListCriterion" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualityDiscreteValueErrorDetail](#model-GsaQualityDiscreteValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "listBoolean: Criterion that wraps other criteria in order to specify how the results should be joined together. Used in searches for record lists.\r\n\r\nThis extends: GsaListCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'listBoolean'", + "x-discriminator-value": "listBoolean", + "x-discriminator-name": "type" }, - "GsaNamedEntityQualitySystemErrorDetail": { + "GsaListCriterion": { + "required": [ + "type" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaQualitySystemErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } - } - } + "properties": { + "type": { + "type": "string" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystemErrorDetail](#model-GsaQualitySystemErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "The criterion to be used in a search for record lists.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\" or \"all\" of the criteria.\r\nThese criteria can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * GsaListBooleanCriterion\r\n * GsaRecordListSearchCriterion", + "discriminator": { + "propertyName": "type", + "mapping": { + "listBoolean": "#/components/schemas/GsaListBooleanCriterion", + "recordList": "#/components/schemas/GsaRecordListSearchCriterion" + } + } }, - "GsaNamedEntityRecordLinkGroupErrorDetail": { + "GsaListItem": { + "required": [ + "databaseGuid", + "recordHistoryGuid", + "tableGuid" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "properties": { + "databaseGuid": { + "type": "string", + "format": "uuid" }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } - } - } + "recordHistoryGuid": { + "type": "string", + "format": "uuid" + }, + "recordGuid": { + "type": "string", + "description": "This may be null if the list item does not exist in a currently loaded database", + "format": "uuid", + "nullable": true + }, + "recordVersion": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "tableGuid": { + "type": "string", + "format": "uuid" } - ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaNamedEntityTableErrorDetail": { + "GsaListItemRecordReference": { + "required": [ + "databaseGuid", + "recordHistoryGuid" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" + "properties": { + "databaseGuid": { + "type": "string", + "description": "The database GUID of the record", + "format": "uuid" }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } - } - } + "recordHistoryGuid": { + "type": "string", + "description": "The record history GUID of the record", + "format": "uuid" + }, + "recordVersion": { + "type": "integer", + "description": "Optional record version. If not specified, search will return lists that were added with unspecified version", + "format": "int32", + "nullable": true } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "Object that uniquely identifies a record" }, - "GsaNamedEntityUnitErrorDetail": { + "GsaListRollupDatum": { + "required": [ + "datum", + "sourceRow" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitErrorDetail" + "properties": { + "sourceRow": { + "$ref": "#/components/schemas/GsaSlimEntity" }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } + "datum": { + "$ref": "#/components/schemas/GsaDatum" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaNewLayoutAssociationChainItem": { + "GsaListsPagingOptions": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "properties": { + "startIndex": { + "type": "integer", + "description": "The index of the first item in the collection to be returned. If not provided it will start at index 0.", + "format": "int32", + "nullable": true }, - { - "required": [ - "associationChainLinks", - "associationChainName" - ], - "type": "object", - "properties": { - "associationChainName": { - "type": "string" - }, - "associationChainLinks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutAssociationChainLink" - } - } - } + "pageSize": { + "type": "integer", + "description": "The number of items to be returned per page. If not provided the number of returned lists will be unlimited.", + "format": "int32", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'associationChain'", - "x-discriminator-value": "associationChain", - "x-discriminator-name": "itemType" + }, + "additionalProperties": false }, - "GsaNewLayoutAssociationChainLink": { + "GsaListsUserOrGroup": { "required": [ - "sourceDatabaseVersionGuid", - "tabularAttributeGuid" + "displayName", + "identifier", + "name" ], "type": "object", "properties": { - "forwards": { - "type": "boolean" - }, - "sourceDatabaseVersionGuid": { + "identifier": { "type": "string", "format": "uuid" }, - "tabularAttributeGuid": { - "type": "string", - "format": "uuid" + "displayName": { + "type": "string" + }, + "name": { + "type": "string" } }, "additionalProperties": false }, - "GsaNewLayoutAttributeItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNewLayoutItem" - }, - { - "required": [ - "attributeGuid" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "required": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "metaAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutAttributeItem" - }, - "nullable": true - }, - "tabularColumnGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } - } + "GsaLocalColumnAggregation": { + "required": [ + "localColumnAggregationType" ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "itemType" - }, - "GsaNewLayoutCrossDatabaseLinkItem": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "properties": { + "localColumnIdentity": { + "type": "integer", + "description": "The identity of the local column that was aggregated over.", + "format": "int32", + "nullable": true }, - { - "required": [ - "linkGroupGuid", - "sourceDatabaseGuid", - "sourceTableGuid" - ], - "type": "object", - "properties": { - "sourceDatabaseGuid": { - "type": "string", - "format": "uuid" - }, - "sourceTableGuid": { - "type": "string", - "format": "uuid" - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" - } - } + "localColumnGuid": { + "type": "string", + "description": "The GUID of the local column that was aggregated over.", + "format": "uuid", + "nullable": true + }, + "localColumnAggregationType": { + "$ref": "#/components/schemas/GsaLocalColumnAggregationType" + }, + "count": { + "type": "integer", + "description": "The number of records that have a populated (applicable) value for this local column.", + "format": "int32" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'crossDatabaseLink'", - "x-discriminator-value": "crossDatabaseLink", - "x-discriminator-name": "itemType" + "description": "The results of aggregation over a tabular local column. In all cases this will report the number of rows in\r\nthe aggregation scope that have a value for the local column. In some cases, depending on the datum\r\ntype, we may be able to report more information. For example, aggregating over a numeric datum will\r\nalso provide the minimum and maximum values that local column takes across records in the aggregation\r\nscope.\r\n\r\nThis is one of: \r\n * GsaLocalColumnValueAggregation\r\n * GsaLocalColumnExistsAggregation", + "discriminator": { + "propertyName": "localColumnAggregationType", + "mapping": { + "value": "#/components/schemas/GsaLocalColumnValueAggregation", + "exists": "#/components/schemas/GsaLocalColumnExistsAggregation" + } + } }, - "GsaNewLayoutItem": { + "GsaLocalColumnAggregationCriterion": { "required": [ - "itemType" + "localColumnAggregationCriterionType" ], "type": "object", "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaNewLayoutItemType" + "identity": { + "type": "integer", + "format": "int32", + "nullable": true }, "guid": { "type": "string", - "format": "uuid" + "format": "uuid", + "nullable": true + }, + "localColumnAggregationCriterionType": { + "$ref": "#/components/schemas/GsaLocalColumnAggregationType" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNewLayoutAttributeItem](#model-GsaNewLayoutAttributeItem)\r\n * [GsaNewLayoutRecordLinkItem](#model-GsaNewLayoutRecordLinkItem)\r\n * [GsaNewLayoutSmartLinkItem](#model-GsaNewLayoutSmartLinkItem)\r\n * [GsaNewLayoutCrossDatabaseLinkItem](#model-GsaNewLayoutCrossDatabaseLinkItem)\r\n * [GsaNewLayoutAssociationChainItem](#model-GsaNewLayoutAssociationChainItem)", + "description": "A criterion for requesting aggregations for a single specific tabular local column. Exactly one of the identity or GUID must be provided.\r\n\r\nThis is one of: \r\n * GsaLocalColumnAggregationValueCriterion\r\n * GsaLocalColumnAggregationExistsCriterion", "discriminator": { - "propertyName": "itemType", + "propertyName": "localColumnAggregationCriterionType", "mapping": { - "attribute": "#/components/schemas/GsaNewLayoutAttributeItem", - "recordLink": "#/components/schemas/GsaNewLayoutRecordLinkItem", - "smartLink": "#/components/schemas/GsaNewLayoutSmartLinkItem", - "crossDatabaseLink": "#/components/schemas/GsaNewLayoutCrossDatabaseLinkItem", - "associationChain": "#/components/schemas/GsaNewLayoutAssociationChainItem" + "value": "#/components/schemas/GsaLocalColumnAggregationValueCriterion", + "exists": "#/components/schemas/GsaLocalColumnAggregationExistsCriterion" } } }, - "GsaNewLayoutItemType": { + "GsaLocalColumnAggregationExistsCriterion": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion" + }, + { + "type": "object", + "properties": { + "innerCriterion": { + "$ref": "#/components/schemas/GsaAggregationDatumExistsCriterion" + } + } + } + ], + "additionalProperties": false, + "description": "A criterion for requesting aggregations for a single specific tabular local column.\r\n\r\nThis extends: GsaLocalColumnAggregationCriterion\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'exists'", + "x-discriminator-value": "exists", + "x-discriminator-name": "localColumnAggregationCriterionType" + }, + "GsaLocalColumnAggregationType": { "enum": [ - "attribute", - "recordLink", - "smartLink", - "crossDatabaseLink", - "associationChain" + "value", + "exists" ], - "type": "string", - "description": "The types of new layout item that are supported by the API." + "type": "string" }, - "GsaNewLayoutRecordLinkItem": { + "GsaLocalColumnAggregationValueCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion" }, { - "required": [ - "linkGroupGuid" - ], "type": "object", "properties": { - "forwards": { - "type": "boolean", - "description": "true if the record link points from the table the layout is in; or false if it points towards the table the layout is in (an inbound link). Optional - only required to determine the direction for a link group when the source and target table are the same.", - "nullable": true - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" + "innerCriterion": { + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'recordLink'", - "x-discriminator-value": "recordLink", - "x-discriminator-name": "itemType" + "description": "A criterion for requesting aggregations for a single specific tabular local column,\r\nincluding summary information about the values assumed by the local column.\r\n \r\nFor a numeric local column (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the local column.\r\n \r\nFor a simple text local column (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that local column.\r\n\r\nThis extends: GsaLocalColumnAggregationCriterion\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'value'", + "x-discriminator-value": "value", + "x-discriminator-name": "localColumnAggregationCriterionType" }, - "GsaNewLayoutSmartLinkItem": { + "GsaLocalColumnCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaCriterion" }, { "required": [ - "linkGroupGuid" + "localColumnCriterionType" ], "type": "object", "properties": { - "forwards": { - "type": "boolean", - "description": "true if the smart link points from the table the layout is in; or false if it points towards the table the layout is in (an inbound link)." + "identity": { + "type": "integer", + "format": "int32", + "nullable": true }, - "linkGroupGuid": { + "guid": { "type": "string", - "format": "uuid" + "format": "uuid", + "nullable": true + }, + "localColumnCriterionType": { + "$ref": "#/components/schemas/GsaLocalColumnCriterionType" + } + }, + "discriminator": { + "propertyName": "localColumnCriterionType", + "mapping": { + "matches": "#/components/schemas/GsaLocalColumnMatchesCriterion", + "exists": "#/components/schemas/GsaLocalColumnExistsCriterion", + "notApplicable": "#/components/schemas/GsaLocalColumnNotApplicableCriterion" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'smartLink'", - "x-discriminator-value": "smartLink", - "x-discriminator-name": "itemType" + "description": "Base class for local column criterions. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'localColumn'\r\n\r\nThis is one of: \r\n * GsaLocalColumnMatchesCriterion\r\n * GsaLocalColumnExistsCriterion\r\n * GsaLocalColumnNotApplicableCriterion", + "x-discriminator-value": "localColumn", + "x-discriminator-name": "type" + }, + "GsaLocalColumnCriterionType": { + "enum": [ + "matches", + "exists", + "notApplicable" + ], + "type": "string" }, - "GsaNoAttributePairsSmartAttributesErrorDetail": { + "GsaLocalColumnExistsAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" + "$ref": "#/components/schemas/GsaLocalColumnAggregation" }, { "type": "object" } ], "additionalProperties": false, - "description": "Smart record link group must have at least one attribute pair set.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noAttributePairs'", - "x-discriminator-value": "noAttributePairs", - "x-discriminator-name": "reason" + "description": "The results of aggregation over a tabular local column, reporting only the number of rows with a value\r\nfor the local column.\r\n\r\nThis extends: GsaLocalColumnAggregation\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'exists'", + "x-discriminator-value": "exists", + "x-discriminator-name": "localColumnAggregationType" }, - "GsaNoDataFileErrorDetail": { + "GsaLocalColumnExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFileErrorDetail" + "$ref": "#/components/schemas/GsaLocalColumnCriterion" }, { + "required": [ + "innerCriterion" + ], "type": "object", "properties": { - "isConfiguration": { - "type": "boolean" + "innerCriterion": { + "$ref": "#/components/schemas/GsaDatumExistsCriterion" } } } ], "additionalProperties": false, - "description": "The File is invalid as it has no data/Configuration must have a value.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noData'", - "x-discriminator-value": "noData", - "x-discriminator-name": "reason" + "description": "Criterion for matching record where there is data on the tabular local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaLocalColumnCriterion\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'exists'", + "x-discriminator-value": "exists", + "x-discriminator-name": "localColumnCriterionType" }, - "GsaNoExpressionsMathsFunctionalErrorDetail": { + "GsaLocalColumnMatchesCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "$ref": "#/components/schemas/GsaLocalColumnCriterion" }, { - "type": "object" + "required": [ + "innerCriterion" + ], + "type": "object", + "properties": { + "innerCriterion": { + "$ref": "#/components/schemas/GsaDatumCriterion" + } + } } ], "additionalProperties": false, - "description": "Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noExpressions'", - "x-discriminator-value": "noExpressions", - "x-discriminator-name": "reason" + "description": "Criterion for a search matching values in a given tabular local column. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaLocalColumnCriterion\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'matches'", + "x-discriminator-value": "matches", + "x-discriminator-name": "localColumnCriterionType" }, - "GsaNoFileFileErrorDetail": { + "GsaLocalColumnNotApplicableCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFileErrorDetail" + "$ref": "#/components/schemas/GsaLocalColumnCriterion" }, { "type": "object" } ], "additionalProperties": false, - "description": "No File found in the Form data.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noFile'", - "x-discriminator-value": "noFile", - "x-discriminator-name": "reason" + "description": "Criterion for matching record where there is not applicable data on the local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaLocalColumnCriterion\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'notApplicable'", + "x-discriminator-value": "notApplicable", + "x-discriminator-name": "localColumnCriterionType" }, - "GsaNoParameterValuesParameterErrorDetail": { + "GsaLocalColumnValueAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaLocalColumnAggregation" }, { - "type": "object" + "type": "object", + "properties": { + "aggregationDatum": { + "$ref": "#/components/schemas/GsaAggregationDatum" + } + } } ], "additionalProperties": false, - "description": "No parameter values provided. At least one parameter value is required.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noParameterValues'", - "x-discriminator-value": "noParameterValues", - "x-discriminator-name": "reason" + "description": "The results of aggregation over a tabular local column, reporting the number of rows that have a value for\r\nthe local column, plus additional aggregation information about the local column values. The exact type of\r\nadditional information will depend on the type of local column.\r\n\r\nThis extends: GsaLocalColumnAggregation\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'value'", + "x-discriminator-value": "value", + "x-discriminator-name": "localColumnAggregationType" }, - "GsaNoPermissionsPermissionCategoryErrorDetail": { + "GsaLocalDateTimeTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { - "type": "object" + "required": [ + "defaultThresholdType" + ], + "type": "object", + "properties": { + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + } + } } ], "additionalProperties": false, - "description": "Permission categories must have at least one permission.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noPermissions'", - "x-discriminator-value": "noPermissions", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", + "x-discriminator-value": "localDateTime", + "x-discriminator-name": "columnType" }, - "GsaNoQualityDiscreteValuesErrorDetail": { + "GsaLocalDiscreteTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaQualitySystemErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { - "type": "object" + "required": [ + "defaultThresholdType", + "discreteType" + ], + "type": "object", + "properties": { + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + }, + "discreteType": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystemErrorDetail](#model-GsaQualitySystemErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noQualityDiscreteValues'", - "x-discriminator-value": "noQualityDiscreteValues", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", + "x-discriminator-value": "localDiscrete", + "x-discriminator-name": "columnType" }, - "GsaNoSuchAttributeSmartAttributesErrorDetail": { + "GsaLocalFileTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { "required": [ - "attributeGuid", - "databaseKey", - "tableGuid" + "defaultThresholdType" ], "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "Attribute not found.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchAttribute'", - "x-discriminator-value": "noSuchAttribute", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", + "x-discriminator-value": "localFile", + "x-discriminator-name": "columnType" }, - "GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail": { + "GsaLocalHyperlinkTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { + "required": [ + "defaultThresholdType" + ], "type": "object", "properties": { - "missingGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "One or more permission categories specified for update could not be found.\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchCategories'", - "x-discriminator-value": "noSuchCategories", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", + "x-discriminator-value": "localHyperlink", + "x-discriminator-name": "columnType" }, - "GsaNoSuchCategoryAccessControlErrorDetail": { + "GsaLocalIntegerTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { "required": [ - "categoryGuid" + "defaultThresholdType" ], "type": "object", "properties": { - "categoryGuid": { - "type": "string", - "format": "uuid" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "The permission category specified does not exist.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchCategory'", - "x-discriminator-value": "noSuchCategory", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", + "x-discriminator-value": "localInteger", + "x-discriminator-name": "columnType" }, - "GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail": { + "GsaLocalLogicalTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDiscreteValueErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { + "required": [ + "defaultThresholdType" + ], "type": "object", "properties": { - "discreteTypeGuid": { - "type": "string", - "format": "uuid" - }, - "missingGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteValueErrorDetail](#model-GsaDiscreteValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchDiscreteValuesInDiscreteValues'", - "x-discriminator-value": "noSuchDiscreteValuesInDiscreteValues", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", + "x-discriminator-value": "localLogical", + "x-discriminator-name": "columnType" }, - "GsaNoSuchEntitiesAccessControlEntitiesErrorDetail": { + "GsaLocalLongTextTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlEntitiesErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { "required": [ - "entities" + "defaultThresholdType" ], "type": "object", "properties": { - "entities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlEntity" - } + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "The entities specified could not be found.\r\n\r\nThis extends: [GsaAccessControlEntitiesErrorDetail](#model-GsaAccessControlEntitiesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchEntities'", - "x-discriminator-value": "noSuchEntities", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", + "x-discriminator-value": "localLongText", + "x-discriminator-name": "columnType" }, - "GsaNoSuchEntityAccessControlCategoryErrorDetail": { + "GsaLocalPictureTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { "required": [ - "entityType", - "guid" + "defaultThresholdType" ], "type": "object", "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "entityType": { - "$ref": "#/components/schemas/GsaAccessControlCategoryNoSuchEntityType" + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "Could not find the entity with the given GUID.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchEntity'", - "x-discriminator-value": "noSuchEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", + "x-discriminator-value": "localPicture", + "x-discriminator-name": "columnType" }, - "GsaNoSuchEntityAttributeErrorDetail": { + "GsaLocalPointTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { + "required": [ + "defaultThresholdType" + ], "type": "object", "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "databaseKey": { - "type": "string", - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" }, - "entityType": { - "$ref": "#/components/schemas/GsaAttributeNoSuchEntityType" + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" } } } ], "additionalProperties": false, - "description": "Could not find the entityType with the given GUID.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchEntity'", - "x-discriminator-value": "noSuchEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", + "x-discriminator-value": "localPoint", + "x-discriminator-name": "columnType" }, - "GsaNoSuchEntityTabularColumnErrorDetail": { + "GsaLocalRangeTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { + "required": [ + "defaultThresholdType" + ], "type": "object", "properties": { - "columnName": { - "type": "string", - "description": "May be null if no column name was provided in the request.", - "nullable": true - }, - "columnGuid": { - "type": "string", - "description": "Only populated when updating an existing column.", - "format": "uuid", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "databaseKey": { - "type": "string", - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" }, - "entityType": { - "$ref": "#/components/schemas/GsaTabularColumnNoSuchEntityType" + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNoSuchEntity'", - "x-discriminator-value": "tabularColumnNoSuchEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", + "x-discriminator-value": "localRange", + "x-discriminator-name": "columnType" }, - "GsaNoSuchExpressionsMathsFunctionalErrorDetail": { + "GsaLocalRowsBehavior": { + "enum": [ + "AllRows", + "VisibleRows", + "ExactMatchMatchingRows", + "NoLinkingValueRows" + ], + "type": "string", + "description": "Enum for use in a tabular search, to optionally further filter the results based on whether the matching rows are linked. The default value of AllRows will return all rows matching the local search.

Possible values:

\r\n
    \r\n
  • AllRows: Return any row where the local data matches
    • \r\n
  • VisibleRows: Return rows with matching linking values, or no linking value
    • \r\n
  • ExactMatchMatchingRows: Return rows with matching linking values
    • \r\n
  • NoLinkingValueRows: Return rows with no linking value
    • \r\n
\r\n" + }, + "GsaLocalShortTextTabularColumn": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "$ref": "#/components/schemas/GsaTabularColumn" }, { + "required": [ + "defaultThresholdType" + ], "type": "object", "properties": { - "notFoundGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "databaseKey": { - "type": "string", - "nullable": true + "defaultThresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" } } } ], "additionalProperties": false, - "description": "The not found GUIDs do not correspond to existing expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchExpressions'", - "x-discriminator-value": "noSuchExpressions", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", + "x-discriminator-value": "localShortText", + "x-discriminator-name": "columnType" }, - "GsaNoSuchNewParentFileMoveErrorDetail": { + "GsaLogicalAggregation": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" + "$ref": "#/components/schemas/GsaAggregationDatum" }, { "type": "object", "properties": { - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "databaseKey": { - "type": "string", + "values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaValueWithCountOfBoolean" + }, "nullable": true } } } ], "additionalProperties": false, - "description": "A folder with the given GUID does not exist in database.\r\n\r\nThis extends: [GsaFileMoveErrorDetail](#model-GsaFileMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchNewParent'", - "x-discriminator-value": "noSuchNewParent", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", + "x-discriminator-value": "logical", + "x-discriminator-name": "datumType" }, - "GsaNoSuchNewParentFolderMoveErrorDetail": { + "GsaLogicalAggregationDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" + "$ref": "#/components/schemas/GsaAggregationDatumCriterion" }, { - "type": "object", - "properties": { - "newParentFolderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "databaseKey": { - "type": "string", - "nullable": true - } - } + "type": "object" } ], "additionalProperties": false, - "description": "A folder with the given GUID does not exist in the database.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchNewParent'", - "x-discriminator-value": "noSuchNewParent", - "x-discriminator-name": "reason" + "description": "Criterion for aggregating data within a logical attribute. The returned aggregation will contain a count of records with at least one value for the attribute,\r\nand a count of records for the true/false values.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "x-discriminator-value": "logical", + "x-discriminator-name": "type" }, - "GsaNoSuchParameterValueParameterContentErrorDetail": { + "GsaLogicalAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterContentErrorDetail" + "$ref": "#/components/schemas/GsaAttribute" }, { - "type": "object", - "properties": { - "parameterValueGuid": { - "type": "string", - "format": "uuid" - }, - "parameterGuid": { - "type": "string", - "format": "uuid" - }, - "databaseKey": { - "type": "string", - "nullable": true - } - } + "type": "object" } ], "additionalProperties": false, - "description": "Could not find parameter value for parameter.\r\n\r\nThis extends: [GsaParameterContentErrorDetail](#model-GsaParameterContentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchParameterValue'", - "x-discriminator-value": "noSuchParameterValue", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "x-discriminator-value": "logical", + "x-discriminator-name": "type" }, - "GsaNoSuchPermissionAccessControlErrorDetail": { + "GsaLogicalDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { "required": [ - "categoryGuid", - "permissionGuid" + "value" ], "type": "object", "properties": { - "permissionGuid": { - "type": "string", - "format": "uuid" - }, - "categoryGuid": { - "type": "string", - "format": "uuid" + "value": { + "type": "boolean" } } } ], "additionalProperties": false, - "description": "The permission specified does not exist.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchPermission'", - "x-discriminator-value": "noSuchPermission", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", + "x-discriminator-value": "logical", + "x-discriminator-name": "datumType" }, - "GsaNoSuchPermissionsPermissionCategoryErrorDetail": { + "GsaLogicalDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { + "required": [ + "value" + ], "type": "object", "properties": { - "missingGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "value": { + "type": "boolean", + "description": "Logical search value" } } } ], "additionalProperties": false, - "description": "One or more permissions specified for update could not be found in the category.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchPermissions'", - "x-discriminator-value": "noSuchPermissions", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "x-discriminator-value": "logical", + "x-discriminator-name": "type" }, - "GsaNoSuchSubsetAccessControlEntitiesErrorDetail": { + "GsaLogicalDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlEntitiesErrorDetail" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { - "required": [ - "entities" - ], - "type": "object", - "properties": { - "entities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlEntity" - } - } - } + "type": "object" } ], "additionalProperties": false, - "description": "The subset specified could not be found for these entities.\r\n\r\nThis extends: [GsaAccessControlEntitiesErrorDetail](#model-GsaAccessControlEntitiesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchSubset'", - "x-discriminator-value": "noSuchSubset", - "x-discriminator-name": "reason" + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "x-discriminator-value": "logical", + "x-discriminator-name": "type" }, - "GsaNoSuchTableMappingErrorDetail": { + "GsaLongSortingValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" + "$ref": "#/components/schemas/GsaSortingValue" }, { - "required": [ - "tableGuid" - ], "type": "object", "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" + "value": { + "type": "integer", + "format": "int64" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchTableMapping'", - "x-discriminator-value": "noSuchTableMapping", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaSortingValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'long'", + "x-discriminator-value": "long", + "x-discriminator-name": "type" }, - "GsaNoSuchTablesReorderTablesErrorDetail": { + "GsaLongTextAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaReorderTablesErrorDetail" + "$ref": "#/components/schemas/GsaAttribute" }, { - "type": "object", - "properties": { - "invalidGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaReorderTablesErrorDetail](#model-GsaReorderTablesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchTables'", - "x-discriminator-value": "noSuchTables", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "x-discriminator-value": "longText", + "x-discriminator-name": "type" }, - "GsaNoSuchTabularColumnAttributeErrorDetail": { + "GsaLongTextDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { + "required": [ + "richTextValue" + ], "type": "object", "properties": { - "databaseKey": { - "type": "string", - "nullable": true - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "columnGuid": { - "type": "string", - "format": "uuid" + "richTextValue": { + "$ref": "#/components/schemas/GsaRichTextValue" } } } ], "additionalProperties": false, - "description": "Could not find the Tabular Column with the given GUID.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchTabularColumn'", - "x-discriminator-value": "noSuchTabularColumn", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", + "x-discriminator-value": "longText", + "x-discriminator-name": "datumType" }, - "GsaNoSuchTargetTableRecordLinkGroupErrorDetail": { + "GsaLongTextDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { "required": [ - "databaseKey", - "tableGuid" + "value" ], "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, - "tableGuid": { + "value": { "type": "string", - "format": "uuid" + "description": "Long text search value" } } } ], "additionalProperties": false, - "description": "Target table not found.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchTargetTable'", - "x-discriminator-value": "noSuchTargetTable", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "x-discriminator-value": "longText", + "x-discriminator-name": "type" }, - "GsaNoSuchUnitConstantErrorDetail": { + "GsaLongTextDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaConstantErrorDetail" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "Could not find the unit with the given GUID.\r\n\r\nThis extends: [GsaConstantErrorDetail](#model-GsaConstantErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnit'", - "x-discriminator-value": "noSuchUnit", - "x-discriminator-name": "reason" + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "x-discriminator-value": "longText", + "x-discriminator-name": "type" }, - "GsaNoSuchUnitParameterErrorDetail": { + "GsaLongTextPrefixDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { + "required": [ + "prefix" + ], "type": "object", "properties": { - "guid": { - "type": "string", - "format": "uuid" + "prefix": { + "type": "string" } } } ], "additionalProperties": false, - "description": "Could not find the unit with the given GUID.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnit'", - "x-discriminator-value": "noSuchUnit", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'longTextPrefix'", + "x-discriminator-value": "longTextPrefix", + "x-discriminator-name": "type" + }, + "GsaMappingOfObjectIdentifier": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/GsaObjectIdentifier" + }, + "targetIdentity": { + "type": "integer", + "description": "The identity of the integration schema attribute", + "format": "int32" + }, + "targetGuid": { + "type": "string", + "description": "The guid of the integration schema attribute", + "format": "uuid" + }, + "parameterMappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaMappingOfObjectIdentifier" + }, + "description": "Any mapped parameters (float functional attributes only). The target parameters must be defined on the target integration attribute.\r\nNot every parameters from the source database needs to be mapped for each attribute.", + "nullable": true + }, + "linkSourceType": { + "$ref": "#/components/schemas/GsaLinkSourceType" + } + }, + "additionalProperties": false, + "description": "A mapping between a source database item and an integration schema attribute." + }, + "GsaMathsContent": { + "required": [ + "parameterContents", + "transposeAxes", + "useLogarithmicScale" + ], + "type": "object", + "properties": { + "curveLabel": { + "type": "string", + "nullable": true + }, + "transposeAxes": { + "type": "boolean" + }, + "useLogarithmicScale": { + "type": "boolean" + }, + "expression": { + "$ref": "#/components/schemas/GsaSlimExpression" + }, + "freeParameter": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "parameterContents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterContent" + } + } + }, + "additionalProperties": false }, - "GsaNoSuchUnitSystemUnitEquivalentErrorDetail": { + "GsaMathsFunctionalAttribute": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" + "$ref": "#/components/schemas/GsaAttribute" }, { + "required": [ + "allowAllCompatibleExpressions", + "allowAnonymousExpressions", + "allowExtrapolation", + "attributeParameters", + "defaultContent", + "expressions", + "isRange" + ], "type": "object", "properties": { - "guid": { - "type": "string", - "format": "uuid" + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" + }, + "attributeParameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } + }, + "expressions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimExpression" + } + }, + "allowExtrapolation": { + "type": "boolean" + }, + "isRange": { + "type": "boolean" + }, + "allowAllCompatibleExpressions": { + "type": "boolean" + }, + "allowAnonymousExpressions": { + "type": "boolean" + }, + "defaultContent": { + "$ref": "#/components/schemas/GsaMathsContent" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnitSystem'", - "x-discriminator-value": "noSuchUnitSystem", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "x-discriminator-value": "mathsFunctional", + "x-discriminator-name": "type" }, - "GsaNoSuchUnitUnitEquivalentErrorDetail": { + "GsaMathsFunctionalAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { "type": "object", "properties": { - "guid": { - "type": "string", - "format": "uuid" + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnit'", - "x-discriminator-value": "noSuchUnit", + "description": "Errors specific to Maths Functional attributes.\r\nSee \"errors\" for details.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'mathsFunctional'", + "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "reason" }, - "GsaNoValueExistsGraphValue": { + "GsaMathsFunctionalDatumCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaGraphValue" + "$ref": "#/components/schemas/GsaDatumCriterion" }, { - "type": "object" + "type": "object", + "properties": { + "gte": { + "type": "number", + "description": "Greater than or equal to", + "format": "double", + "nullable": true + }, + "lte": { + "type": "number", + "description": "Less than or equal to", + "format": "double", + "nullable": true + }, + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterConstraint" + }, + "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.", + "nullable": true + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphValue](#model-GsaGraphValue)\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'noValueExists'", - "x-discriminator-value": "noValueExists", - "x-discriminator-name": "graphValueType" + "description": "mathsFunctional: Criterion for matching records with maths functional data (EELs)\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "x-discriminator-value": "mathsFunctional", + "x-discriminator-name": "type" }, - "GsaNoValuesSpecifier": { + "GsaMathsFunctionalDatumExistsCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaValueSpecifier" + "$ref": "#/components/schemas/GsaDatumExistsCriterion" }, { "type": "object" } ], "additionalProperties": false, - "description": "Used to return no values.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'none'", - "x-discriminator-value": "none", - "x-discriminator-name": "filterOn" + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "x-discriminator-value": "mathsFunctional", + "x-discriminator-name": "type" + }, + "GsaMathsFunctionalErrorDetail": { + "required": [ + "message", + "reason" + ], + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "reason": { + "$ref": "#/components/schemas/GsaMathsFunctionalErrorReason" + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail\r\n * GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail\r\n * GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail\r\n * GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail\r\n * GsaExpressionMathsFunctionalErrorDetail\r\n * GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail\r\n * GsaNoExpressionsMathsFunctionalErrorDetail\r\n * GsaNoSuchExpressionsMathsFunctionalErrorDetail\r\n * GsaParameterContentMathsFunctionalErrorDetail\r\n * GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail\r\n * GsaParameterContentUnknownParametersMathsFunctionalErrorDetail", + "discriminator": { + "propertyName": "reason", + "mapping": { + "anonymousExpressionsMustAllowAllCompatible": "#/components/schemas/GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail", + "defaultExpressionNotFound": "#/components/schemas/GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail", + "defaultFreeParameterNotFound": "#/components/schemas/GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail", + "duplicateExpressionGuids": "#/components/schemas/GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail", + "expression": "#/components/schemas/GsaExpressionMathsFunctionalErrorDetail", + "expressionsHaveUnknownParameters": "#/components/schemas/GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail", + "noExpressions": "#/components/schemas/GsaNoExpressionsMathsFunctionalErrorDetail", + "noSuchExpressions": "#/components/schemas/GsaNoSuchExpressionsMathsFunctionalErrorDetail", + "parameterContent": "#/components/schemas/GsaParameterContentMathsFunctionalErrorDetail", + "parameterContentDuplicateGuids": "#/components/schemas/GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail", + "parameterContentUnknownParameters": "#/components/schemas/GsaParameterContentUnknownParametersMathsFunctionalErrorDetail" + } + } + }, + "GsaMathsFunctionalErrorReason": { + "enum": [ + "anonymousExpressionsMustAllowAllCompatible", + "defaultExpressionNotFound", + "defaultFreeParameterNotFound", + "duplicateExpressionGuids", + "expression", + "expressionsHaveUnknownParameters", + "noExpressions", + "noSuchExpressions", + "parameterContent", + "parameterContentDuplicateGuids", + "parameterContentUnknownParameters" + ], + "type": "string" + }, + "GsaMfaExpressionErrorDetail": { + "required": [ + "message" + ], + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "reason": { + "$ref": "#/components/schemas/GsaMfaExpressionErrorReason" + } + }, + "additionalProperties": false + }, + "GsaMfaExpressionErrorReason": { + "enum": [ + "notAnAttributeExpression", + "incompatibleUnit", + "expressionAlreadyUsesThisAttribute", + "anonymousExpression" + ], + "type": "string", + "description": "

Possible values:

\r\n
    \r\n
  • notAnAttributeExpression: Expression is not an attribute expression.
    • \r\n
  • incompatibleUnit: Expression unit is incompatible with attribute unit.
    • \r\n
  • expressionAlreadyUsesThisAttribute: Expression already uses this attribute.
    • \r\n
  • anonymousExpression: Expression is an anonymous expression.
    • \r\n
\r\n" + }, + "GsaMiVersion": { + "type": "object", + "properties": { + "binaryCompatibilityVersion": { + "type": "string" + }, + "version": { + "type": "string" + }, + "majorMinorVersion": { + "type": "string" + } + }, + "additionalProperties": false }, - "GsaNonCustomStandardNameCannotBeChangedErrorDetail": { + "GsaMissingArgumentsParameterContentErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" + "$ref": "#/components/schemas/GsaParameterContentErrorDetail" }, { - "required": [ - "standardName" - ], "type": "object", "properties": { - "standardName": { - "type": "string" + "missingArgument": { + "$ref": "#/components/schemas/GsaParameterContentMissingArgument" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nonCustomStandardNameCannotBeChanged'", - "x-discriminator-value": "nonCustomStandardNameCannotBeChanged", + "description": "MissingArgument must be provided.\r\n\r\nThis extends: GsaParameterContentErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingArguments'", + "x-discriminator-value": "missingArguments", "x-discriminator-name": "reason" }, - "GsaNotApplicableDatum": { + "GsaMissingParameterGuidAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDatum" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatum](#model-GsaDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", - "x-discriminator-value": "notApplicable", - "x-discriminator-name": "notApplicable" + "description": "All supplied attribute parameters must have parameter GUIDs specified.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingParameterGuid'", + "x-discriminator-value": "missingParameterGuid", + "x-discriminator-name": "reason" }, - "GsaNotTheLatestVersionErrorDetail": { + "GsaMoveFile": { + "required": [ + "folderGuid" + ], + "type": "object", + "properties": { + "folderGuid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaMoveFolder": { + "required": [ + "parentGuid" + ], + "type": "object", + "properties": { + "parentGuid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaMoveRecordHistory": { + "type": "object", + "properties": { + "newParent": { + "$ref": "#/components/schemas/GsaSlimRecordHistory" + } + }, + "additionalProperties": false + }, + "GsaNameAlreadyExistsErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaVersionControlErrorDetail" + "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" }, { "type": "object", "properties": { - "newerVersion": { - "$ref": "#/components/schemas/GsaSlimRecordVersion" + "name": { + "type": "string", + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notTheLatestVersion'", - "x-discriminator-value": "notTheLatestVersion", + "description": "Database Entity with name already exists.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadyExists'", + "x-discriminator-value": "nameAlreadyExists", "x-discriminator-name": "reason" }, - "GsaNotVersionedErrorDetail": { + "GsaNameNotProvidedErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaVersionControlErrorDetail" + "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notVersioned'", - "x-discriminator-value": "notVersioned", + "description": "Entity must have a name.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameNotProvided'", + "x-discriminator-value": "nameNotProvided", "x-discriminator-name": "reason" }, - "GsaNumberParsingUnitEquationErrorDetail": { + "GsaNamedCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" + "$ref": "#/components/schemas/GsaCriterion" }, { - "required": [ - "invalidNumber" - ], "type": "object", "properties": { - "invalidNumber": { - "type": "string" + "name": { + "type": "string", + "nullable": true + }, + "innerCriterion": { + "$ref": "#/components/schemas/GsaCriterion" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'numberParsing'", - "x-discriminator-value": "numberParsing", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'namedCriterion'", + "x-discriminator-value": "namedCriterion", + "x-discriminator-name": "type" }, - "GsaNumericGraphParameterValue": { + "GsaNamedEntityAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaGraphParameterValue" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { - "required": [ - "parameterValue" - ], "type": "object", "properties": { - "parameterValue": { - "type": "number", - "format": "double" + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" + }, + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphParameterValue](#model-GsaGraphParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "parameterType" + "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", + "x-discriminator-value": "namedEntity", + "x-discriminator-name": "reason" }, - "GsaNumericParameter": { + "GsaNamedEntityErrorDetail": { + "required": [ + "message", + "reason" + ], + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "reason": { + "$ref": "#/components/schemas/GsaNamedEntityErrorReason" + }, + "entityTypeName": { + "type": "string", + "description": "e.g. 'Attribute', 'Meta-attribute'", + "nullable": true + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaEntityAlreadyExistsErrorDetail\r\n * GsaNameNotProvidedErrorDetail\r\n * GsaNameAlreadyExistsErrorDetail\r\n * GsaEntityIdentifierAlreadySpecifiedErrorDetail", + "discriminator": { + "propertyName": "reason", + "mapping": { + "entityAlreadyExists": "#/components/schemas/GsaEntityAlreadyExistsErrorDetail", + "nameNotProvided": "#/components/schemas/GsaNameNotProvidedErrorDetail", + "nameAlreadyExists": "#/components/schemas/GsaNameAlreadyExistsErrorDetail", + "entityIdentifierAlreadySpecified": "#/components/schemas/GsaEntityIdentifierAlreadySpecifiedErrorDetail" + } + } + }, + "GsaNamedEntityErrorReason": { + "enum": [ + "entityAlreadyExists", + "entityIdentifierAlreadySpecified", + "nameNotProvided", + "nameAlreadyExists" + ], + "type": "string" + }, + "GsaNewLayoutAssociationChainItem": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameter" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, { "required": [ - "interpolationType", - "isRestricted", - "scaleType", - "values" + "associationChainLinks", + "associationChainName" ], "type": "object", "properties": { - "isRestricted": { - "type": "boolean" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" + "associationChainName": { + "type": "string" }, - "values": { + "associationChainLinks": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaNumericParameterValue" + "$ref": "#/components/schemas/GsaNewLayoutAssociationChainLink" } - }, - "interpolationType": { - "$ref": "#/components/schemas/GsaParameterInterpolationType" - }, - "scaleType": { - "$ref": "#/components/schemas/GsaParameterScaleType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameter](#model-GsaParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'associationChain'", + "x-discriminator-value": "associationChain", + "x-discriminator-name": "itemType" }, - "GsaNumericParameterConstraint": { + "GsaNewLayoutAssociationChainLink": { + "required": [ + "sourceDatabaseVersionGuid", + "tabularAttributeGuid" + ], + "type": "object", + "properties": { + "forwards": { + "type": "boolean" + }, + "sourceDatabaseVersionGuid": { + "type": "string", + "format": "uuid" + }, + "tabularAttributeGuid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaNewLayoutAttributeItem": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterConstraint" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, { + "required": [ + "attributeGuid" + ], "type": "object", "properties": { - "gte": { - "type": "number", - "format": "double", - "nullable": true + "attributeGuid": { + "type": "string", + "format": "uuid" }, - "lte": { - "type": "number", - "format": "double", + "required": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "metaAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaNewLayoutAttributeItem" + }, "nullable": true }, - "significantFigures": { - "type": "integer", - "format": "int32", + "tabularColumnGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterConstraint](#model-GsaParameterConstraint)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", + "x-discriminator-value": "attribute", + "x-discriminator-name": "itemType" }, - "GsaNumericParameterContent": { + "GsaNewLayoutCrossDatabaseLinkItem": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterContent" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, { + "required": [ + "linkGroupGuid", + "sourceDatabaseGuid", + "sourceTableGuid" + ], "type": "object", "properties": { - "value": { - "type": "number", - "format": "double", - "nullable": true + "sourceDatabaseGuid": { + "type": "string", + "format": "uuid" }, - "parameterRange": { - "$ref": "#/components/schemas/GsaContinuousRange" + "sourceTableGuid": { + "type": "string", + "format": "uuid" + }, + "linkGroupGuid": { + "type": "string", + "format": "uuid" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterContent](#model-GsaParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'crossDatabaseLink'", + "x-discriminator-value": "crossDatabaseLink", + "x-discriminator-name": "itemType" }, - "GsaNumericParameterDataValue": { + "GsaNewLayoutItem": { + "required": [ + "itemType" + ], + "type": "object", + "properties": { + "itemType": { + "$ref": "#/components/schemas/GsaNewLayoutItemType" + }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaNewLayoutAttributeItem\r\n * GsaNewLayoutRecordLinkItem\r\n * GsaNewLayoutSmartLinkItem\r\n * GsaNewLayoutCrossDatabaseLinkItem\r\n * GsaNewLayoutAssociationChainItem", + "discriminator": { + "propertyName": "itemType", + "mapping": { + "attribute": "#/components/schemas/GsaNewLayoutAttributeItem", + "recordLink": "#/components/schemas/GsaNewLayoutRecordLinkItem", + "smartLink": "#/components/schemas/GsaNewLayoutSmartLinkItem", + "crossDatabaseLink": "#/components/schemas/GsaNewLayoutCrossDatabaseLinkItem", + "associationChain": "#/components/schemas/GsaNewLayoutAssociationChainItem" + } + } + }, + "GsaNewLayoutItemType": { + "enum": [ + "attribute", + "recordLink", + "smartLink", + "crossDatabaseLink", + "associationChain" + ], + "type": "string", + "description": "The types of new layout item that are supported by the API." + }, + "GsaNewLayoutRecordLinkItem": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterDataValue" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, { "required": [ - "parameterValue" + "linkGroupGuid" ], "type": "object", "properties": { - "parameterValue": { - "type": "number", - "format": "double" - }, - "unit": { - "$ref": "#/components/schemas/GsaSlimUnit" + "forwards": { + "type": "boolean", + "description": "true if the record link points from the table the layout is in; or false if it points towards the table the layout is in (an inbound link). Optional - only required to determine the direction for a link group when the source and target table are the same.", + "nullable": true }, - "name": { + "linkGroupGuid": { "type": "string", - "nullable": true + "format": "uuid" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterDataValue](#model-GsaParameterDataValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "parameterType" + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'recordLink'", + "x-discriminator-value": "recordLink", + "x-discriminator-name": "itemType" }, - "GsaNumericParameterValue": { + "GsaNewLayoutSmartLinkItem": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterValue" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, { "required": [ - "value" + "linkGroupGuid" ], "type": "object", "properties": { - "value": { - "type": "number", - "format": "double" + "forwards": { + "type": "boolean", + "description": "true if the smart link points from the table the layout is in; or false if it points towards the table the layout is in (an inbound link)." }, - "name": { + "linkGroupGuid": { "type": "string", - "nullable": true + "format": "uuid" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterValue](#model-GsaParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", - "x-discriminator-value": "numeric", - "x-discriminator-name": "type" + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'smartLink'", + "x-discriminator-value": "smartLink", + "x-discriminator-name": "itemType" }, - "GsaNumericRestrictedInterpolationParameterErrorDetail": { + "GsaNoExpressionsMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, { "type": "object" } ], "additionalProperties": false, - "description": "Numeric restricted parameters cannot have interpolation type other than 'None'.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'numericRestrictedInterpolation'", - "x-discriminator-value": "numericRestrictedInterpolation", + "description": "Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noExpressions'", + "x-discriminator-value": "noExpressions", "x-discriminator-name": "reason" }, - "GsaObjectIdentifier": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of this object. The GUID represents the object on a semantic level, and two objects of\r\nthe same type with the same GUID are considered to represent \"the same concept\". GUIDs should be\r\nrobust against data changes and database upgrades, and should be preferred where possible.", - "format": "uuid", - "nullable": true - }, - "name": { - "type": "string", - "description": "The name of this object. The name represents the object at a human-readable level, but two objects of\r\nthe same type with the same need not represent \"the same concept\". Because the name is less uniquely identifying,\r\nclients should prefer GUIDs where possible, and operations based on name instead of GUID may fail if the name\r\ncannot be uniquely resolved. Certain object types may consider names to be equivalent", - "nullable": true - }, - "identity": { - "type": "integer", - "description": "The underlying identity of this object. This represents the object at a data level, and two objects\r\nof the same type with the same identity are considered to represent \"the same object\". However, identities\r\nare not robust against database upgrades, and are only reliable and consistent within a currently-\r\nloaded database in a running MI instance. Clients should prefer GUIDs where possible, and operations\r\nbased on identity which persist data will be resolved to GUIDs instead (and may fail if this cannot\r\nbe done).", - "format": "int32", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Properties that identify an object within the MI system.\r\n \r\nAn Granta.Server.Api.ObjectIdentifier created by MI will always contain values for all three\r\nproperties. An Granta.Server.Api.ObjectIdentifier created by a client need not contain values for\r\nall three properties, and is allowed to contain values or combinations of values that do\r\nnot correspond to an existing object in MI (in which case the Granta.Server.Api.ObjectIdentifier\r\nwill be resolved against MI objects first by GUID, and then by name, and finally by identity,\r\ntaking the first match and ignoring subsequent fields." - }, - "GsaPaginatedItemType": { - "enum": [ - "xyChartTemplate", - "activityLog" - ], - "type": "string" - }, - "GsaPaginatedResponseOf": { - "required": [ - "entries", - "itemType", - "links" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaPaginatedItemType" - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTItem" - } - }, - "links": { - "$ref": "#/components/schemas/GsaPaginationLinks" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaXYChartTemplatesInfo](#model-GsaXYChartTemplatesInfo)\r\n * [GsaActivityLogEntriesInfo](#model-GsaActivityLogEntriesInfo)", - "discriminator": { - "propertyName": "itemType", - "mapping": { - "xyChartTemplate": "#/components/schemas/GsaXYChartTemplatesInfo", - "activityLog": "#/components/schemas/GsaActivityLogEntriesInfo" - } - } - }, - "GsaPaginationLinks": { - "type": "object", - "properties": { - "next": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPagingOptions": { - "type": "object", - "properties": { - "pageSize": { - "type": "integer", - "description": "The number of results that should be returned in each page", - "format": "int32" - }, - "keepAliveInMinutes": { - "type": "integer", - "description": "The length of time that the paginated search should be kept in memory", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "description": "(Optional) the (1-indexed) number of the page to return from the search. No pages are returned if not provided", - "format": "int32", - "nullable": true - } - }, - "additionalProperties": false, - "description": "An optional field for paging options. If provided on a request, the response will contain an identifier that can be used to retrieve the other pages. Page size must be smaller than 10,000" - }, - "GsaParameter": { - "required": [ - "defaultParameterValueGuid", - "displayNames", - "guid", - "name", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "defaultParameterValueGuid": { - "type": "string", - "format": "uuid" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameter](#model-GsaDiscreteParameter)\r\n * [GsaNumericParameter](#model-GsaNumericParameter)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteParameter", - "numeric": "#/components/schemas/GsaNumericParameter" - } - } - }, - "GsaParameterConstraint": { - "required": [ - "parameter", - "type" - ], - "type": "object", - "properties": { - "parameter": { - "$ref": "#/components/schemas/GsaObjectIdentifier" - }, - "type": { - "$ref": "#/components/schemas/GsaParameterConstraintType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterNameConstraint](#model-GsaDiscreteParameterNameConstraint)\r\n * [GsaDiscreteParameterValueConstraint](#model-GsaDiscreteParameterValueConstraint)\r\n * [GsaNumericParameterConstraint](#model-GsaNumericParameterConstraint)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discreteName": "#/components/schemas/GsaDiscreteParameterNameConstraint", - "discreteValue": "#/components/schemas/GsaDiscreteParameterValueConstraint", - "numeric": "#/components/schemas/GsaNumericParameterConstraint" - } - } - }, - "GsaParameterConstraintType": { - "enum": [ - "discreteName", - "discreteValue", - "numeric" - ], - "type": "string" - }, - "GsaParameterContent": { - "required": [ - "parameter", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "parameter": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterContent](#model-GsaDiscreteParameterContent)\r\n * [GsaNumericParameterContent](#model-GsaNumericParameterContent)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteParameterContent", - "numeric": "#/components/schemas/GsaNumericParameterContent" - } - } - }, - "GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail": { + "GsaNoSuchEntityAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { "type": "object", "properties": { - "duplicatedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "guid": { + "type": "string", + "format": "uuid" + }, + "databaseKey": { + "type": "string", "nullable": true + }, + "entityType": { + "$ref": "#/components/schemas/GsaAttributeNoSuchEntityType" } } } ], "additionalProperties": false, - "description": "No duplicate parameter GUIDs allowed in parameter contents.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentDuplicateGuids'", - "x-discriminator-value": "parameterContentDuplicateGuids", + "description": "Could not find the entityType with the given GUID.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchEntity'", + "x-discriminator-value": "noSuchEntity", "x-discriminator-name": "reason" }, - "GsaParameterContentErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaParameterContentErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaParameterTypeParameterContentErrorDetail](#model-GsaParameterTypeParameterContentErrorDetail)\r\n * [GsaMissingArgumentsParameterContentErrorDetail](#model-GsaMissingArgumentsParameterContentErrorDetail)\r\n * [GsaNoSuchParameterValueParameterContentErrorDetail](#model-GsaNoSuchParameterValueParameterContentErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "parameterType": "#/components/schemas/GsaParameterTypeParameterContentErrorDetail", - "missingArguments": "#/components/schemas/GsaMissingArgumentsParameterContentErrorDetail", - "noSuchParameterValue": "#/components/schemas/GsaNoSuchParameterValueParameterContentErrorDetail" - } - } - }, - "GsaParameterContentErrorReason": { - "enum": [ - "parameterType", - "missingArguments", - "noSuchParameterValue" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • parameterType: Requested parameter content type does not align with its actual parameter type.
    • \r\n
  • missingArguments: MissingArgument must be provided.
    • \r\n
  • noSuchParameterValue: Could not find parameter value for parameter.
    • \r\n
\r\n" - }, - "GsaParameterContentMathsFunctionalErrorDetail": { + "GsaNoSuchEntityTabularColumnErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { "type": "object", "properties": { - "parameterGuid": { + "tabularColumnName": { + "type": "string", + "nullable": true + }, + "guid": { "type": "string", "format": "uuid" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterContentErrorDetail" - }, + "databaseKey": { + "type": "string", "nullable": true + }, + "entityType": { + "$ref": "#/components/schemas/GsaTabularColumnNoSuchEntityType" } } } ], "additionalProperties": false, - "description": "ParameterContent is not valid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContent'", - "x-discriminator-value": "parameterContent", + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNoSuchEntity'", + "x-discriminator-value": "tabularColumnNoSuchEntity", "x-discriminator-name": "reason" }, - "GsaParameterContentMissingArgument": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "description": "

Possible values:

\r\n
    \r\n
  • discreteParameterValueGuid: Parameter value GUID from parameter content must be provided.
    • \r\n
  • parameterRange: Parameter range from parameter content must be provided.
    • \r\n
  • parameterRangeParameterValues: Parameter values from parameter range from parameter content must be provided.
    • \r\n
\r\n", - "format": "int32" - }, - "GsaParameterContentUnknownParametersMathsFunctionalErrorDetail": { + "GsaNoSuchExpressionsMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { @@ -113578,7 +78776,7 @@ { "type": "object", "properties": { - "parameterGuids": { + "notFoundGuids": { "type": "array", "items": { "type": "string", @@ -113586,561 +78784,387 @@ }, "nullable": true }, - "attributeGuid": { + "tableGuid": { + "type": "string", + "format": "uuid" + }, + "databaseKey": { "type": "string", - "format": "uuid", "nullable": true } } } ], "additionalProperties": false, - "description": "Parameters in parameter contents must be from this attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentUnknownParameters'", - "x-discriminator-value": "parameterContentUnknownParameters", + "description": "The not found GUIDs do not correspond to existing expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchExpressions'", + "x-discriminator-value": "noSuchExpressions", "x-discriminator-name": "reason" }, - "GsaParameterCreationException": { + "GsaNoSuchParameterValueParameterContentErrorDetail": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/GsaParameterContentErrorDetail" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - "nullable": true + { + "type": "object", + "properties": { + "parameterValueGuid": { + "type": "string", + "format": "uuid" + }, + "parameterGuid": { + "type": "string", + "format": "uuid" + }, + "databaseKey": { + "type": "string", + "nullable": true + } + } } - }, - "additionalProperties": false - }, - "GsaParameterDataValue": { - "required": [ - "parameterType" ], - "type": "object", - "properties": { - "parameterType": { - "$ref": "#/components/schemas/GsaParameterType" - } - }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterDataValue](#model-GsaDiscreteParameterDataValue)\r\n * [GsaNumericParameterDataValue](#model-GsaNumericParameterDataValue)", - "discriminator": { - "propertyName": "parameterType", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteParameterDataValue", - "numeric": "#/components/schemas/GsaNumericParameterDataValue" - } - } + "description": "Could not find parameter value for parameter.\r\n\r\nThis extends: GsaParameterContentErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchParameterValue'", + "x-discriminator-value": "noSuchParameterValue", + "x-discriminator-name": "reason" }, - "GsaParameterDeletionException": { + "GsaNoValueExistsGraphValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDeletionException" + "$ref": "#/components/schemas/GsaGraphValue" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'parameter'", - "x-discriminator-value": "parameter", - "x-discriminator-name": "entityType" + "description": "\r\n\r\nThis extends: GsaGraphValue\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'noValueExists'", + "x-discriminator-value": "noValueExists", + "x-discriminator-name": "graphValueType" }, - "GsaParameterErrorDetail": { - "required": [ - "message", - "reason" - ], + "GsaNoValuesSpecifier": { "type": "object", - "properties": { - "message": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/GsaValueSpecifier" }, - "reason": { - "$ref": "#/components/schemas/GsaParameterErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDefaultParameterValueGuidParameterErrorDetail](#model-GsaDefaultParameterValueGuidParameterErrorDetail)\r\n * [GsaDefaultParameterValueIndexParameterErrorDetail](#model-GsaDefaultParameterValueIndexParameterErrorDetail)\r\n * [GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail](#model-GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail)\r\n * [GsaDefaultParameterValueIndexAndGuidParameterErrorDetail](#model-GsaDefaultParameterValueIndexAndGuidParameterErrorDetail)\r\n * [GsaNamedEntityParameterErrorDetail](#model-GsaNamedEntityParameterErrorDetail)\r\n * [GsaNoParameterValuesParameterErrorDetail](#model-GsaNoParameterValuesParameterErrorDetail)\r\n * [GsaNoSuchUnitParameterErrorDetail](#model-GsaNoSuchUnitParameterErrorDetail)\r\n * [GsaNumericRestrictedInterpolationParameterErrorDetail](#model-GsaNumericRestrictedInterpolationParameterErrorDetail)\r\n * [GsaParameterTypeParameterErrorDetail](#model-GsaParameterTypeParameterErrorDetail)\r\n * [GsaParameterValueParameterErrorDetail](#model-GsaParameterValueParameterErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "defaultParameterValueGuid": "#/components/schemas/GsaDefaultParameterValueGuidParameterErrorDetail", - "defaultParameterValueIndex": "#/components/schemas/GsaDefaultParameterValueIndexParameterErrorDetail", - "defaultParameterValueIndexWithoutValues": "#/components/schemas/GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", - "defaultParameterValueIndexAndGuid": "#/components/schemas/GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityParameterErrorDetail", - "noParameterValues": "#/components/schemas/GsaNoParameterValuesParameterErrorDetail", - "noSuchUnit": "#/components/schemas/GsaNoSuchUnitParameterErrorDetail", - "numericRestrictedInterpolation": "#/components/schemas/GsaNumericRestrictedInterpolationParameterErrorDetail", - "parameterType": "#/components/schemas/GsaParameterTypeParameterErrorDetail", - "parameterValue": "#/components/schemas/GsaParameterValueParameterErrorDetail" + { + "type": "object" } - } - }, - "GsaParameterErrorReason": { - "enum": [ - "defaultParameterValueGuid", - "defaultParameterValueIndex", - "defaultParameterValueIndexAndGuid", - "defaultParameterValueIndexWithoutValues", - "namedEntity", - "noParameterValues", - "noSuchUnit", - "numericRestrictedInterpolation", - "parameterType", - "parameterValue" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • defaultParameterValueGuid: Default parameter value GUID does not match any parameter value.
    • \r\n
  • defaultParameterValueIndex: Default parameter value index out of range.
    • \r\n
  • defaultParameterValueIndexAndGuid: Default parameter value can be specified by either index or GUID, not both.
    • \r\n
  • defaultParameterValueIndexWithoutValues: Default parameter value index can only be used when values are being updated. Use DefaultParameterValueGuid when values are not being updated.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noParameterValues: No parameter values provided. At least one parameter value is required.
    • \r\n
  • noSuchUnit: Could not find the unit with the given GUID.
    • \r\n
  • numericRestrictedInterpolation: Numeric restricted parameters cannot have interpolation type other than 'None'.
    • \r\n
  • parameterType: When updating an existing parameter, parameter type must match.
    • \r\n
  • parameterValue: Parameter value is not valid.
    • \r\n
\r\n" + "additionalProperties": false, + "description": "Used to return no values.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'none'", + "x-discriminator-value": "none", + "x-discriminator-name": "filterOn" }, - "GsaParameterInfo": { + "GsaNotApplicableDatum": { "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "identity": { - "type": "integer", - "format": "int32" - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "unitSymbol": { - "type": "string", - "nullable": true - }, - "scaleType": { - "$ref": "#/components/schemas/GsaParameterInfoScaleType" - }, - "interpolationType": { - "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" - }, - "parameterType": { - "$ref": "#/components/schemas/GsaParameterInfoParameterType" + "allOf": [ + { + "$ref": "#/components/schemas/GsaDatum" }, - "defaultValue": { - "$ref": "#/components/schemas/GsaDataExportParameterValue" + { + "type": "object" } - }, - "additionalProperties": false, - "description": "\r\n\r\nparameterType: Parameter type can be null for integration schema" - }, - "GsaParameterInfoInterpolationType": { - "enum": [ - "auto", - "none", - "linear", - "cubicSpline" - ], - "type": "string" - }, - "GsaParameterInfoParameterType": { - "enum": [ - "discrete", - "numericRestricted", - "numericUnrestricted" - ], - "type": "string" - }, - "GsaParameterInfoScaleType": { - "enum": [ - "notSet", - "linear", - "log" - ], - "type": "string" - }, - "GsaParameterInterpolationType": { - "enum": [ - "none", - "linear", - "cubicSpline" - ], - "type": "string" - }, - "GsaParameterScaleType": { - "enum": [ - "linear", - "logarithmic" - ], - "type": "string" - }, - "GsaParameterSettingDefinedAt": { - "enum": [ - "parameter", - "attribute", - "datum" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • parameter: Parameter Level
    • \r\n
  • attribute: Attribute Level
    • \r\n
  • datum: Datum Level
    • \r\n
\r\n" - }, - "GsaParameterType": { - "enum": [ - "discrete", - "numeric" ], - "type": "string" + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", + "x-discriminator-value": "notApplicable", + "x-discriminator-name": "notApplicable" }, - "GsaParameterTypeParameterContentErrorDetail": { + "GsaNotTheLatestVersionErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterContentErrorDetail" + "$ref": "#/components/schemas/GsaVersionControlErrorDetail" }, { "type": "object", "properties": { - "requestedParameterType": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "actualParameterType": { - "$ref": "#/components/schemas/GsaParameterType" + "newerVersion": { + "$ref": "#/components/schemas/GsaSlimRecordVersion" } } } ], "additionalProperties": false, - "description": "Requested parameter content type does not align with its actual parameter type.\r\n\r\nThis extends: [GsaParameterContentErrorDetail](#model-GsaParameterContentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterType'", - "x-discriminator-value": "parameterType", + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notTheLatestVersion'", + "x-discriminator-value": "notTheLatestVersion", "x-discriminator-name": "reason" }, - "GsaParameterTypeParameterErrorDetail": { + "GsaNotVersionedErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaVersionControlErrorDetail" }, { - "type": "object", - "properties": { - "newParameterType": { - "$ref": "#/components/schemas/GsaParameterType" - } - } + "type": "object" } ], "additionalProperties": false, - "description": "When updating an existing parameter, parameter type must match.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterType'", - "x-discriminator-value": "parameterType", + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notVersioned'", + "x-discriminator-value": "notVersioned", "x-discriminator-name": "reason" }, - "GsaParameterUpdateException": { + "GsaNumericGraphParameterValue": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "parameterGuid": { - "type": "string", - "format": "uuid" + "allOf": [ + { + "$ref": "#/components/schemas/GsaGraphParameterValue" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - "nullable": true + { + "required": [ + "parameterValue" + ], + "type": "object", + "properties": { + "parameterValue": { + "type": "number", + "format": "double" + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaGraphParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "parameterType" }, - "GsaParameterUsageDataModificationErrorDetail": { + "GsaNumericParameter": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "$ref": "#/components/schemas/GsaParameter" }, { + "required": [ + "interpolationType", + "isRestricted", + "scaleType", + "values" + ], "type": "object", "properties": { - "referencedBy": { + "isRestricted": { + "type": "boolean" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" + }, + "values": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true + "$ref": "#/components/schemas/GsaNumericParameterValue" + } + }, + "interpolationType": { + "$ref": "#/components/schemas/GsaParameterInterpolationType" + }, + "scaleType": { + "$ref": "#/components/schemas/GsaParameterScaleType" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'parameter'", - "x-discriminator-value": "parameter", - "x-discriminator-name": "referencedByType" - }, - "GsaParameterValue": { - "required": [ - "guid", - "type" - ], - "type": "object", - "properties": { - "parameterGuid": { - "type": "string", - "format": "uuid" - }, - "type": { - "$ref": "#/components/schemas/GsaParameterValueType" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterValue](#model-GsaDiscreteParameterValue)\r\n * [GsaNumericParameterValue](#model-GsaNumericParameterValue)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteParameterValue", - "numeric": "#/components/schemas/GsaNumericParameterValue" - } - } - }, - "GsaParameterValueCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "parameterGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false + "description": "\r\n\r\nThis extends: GsaParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" }, - "GsaParameterValueDeletionException": { + "GsaNumericParameterConstraint": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaDeletionException" + "$ref": "#/components/schemas/GsaParameterConstraint" }, { - "type": "object" + "type": "object", + "properties": { + "gte": { + "type": "number", + "format": "double", + "nullable": true + }, + "lte": { + "type": "number", + "format": "double", + "nullable": true + }, + "significantFigures": { + "type": "integer", + "format": "int32", + "nullable": true + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'parameterValue'", - "x-discriminator-value": "parameterValue", - "x-discriminator-name": "entityType" - }, - "GsaParameterValueErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaParameterValueErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaInUseParameterValueErrorDetail](#model-GsaInUseParameterValueErrorDetail)\r\n * [GsaLogScaleNegativeParameterValueErrorDetail](#model-GsaLogScaleNegativeParameterValueErrorDetail)\r\n * [GsaNamedEntityParameterValueErrorDetail](#model-GsaNamedEntityParameterValueErrorDetail)\r\n * [GsaNameWhitespaceParameterValueErrorDetail](#model-GsaNameWhitespaceParameterValueErrorDetail)\r\n * [GsaParameterValueTypeParameterValueErrorDetail](#model-GsaParameterValueTypeParameterValueErrorDetail)\r\n * [GsaValueNotProvidedParameterValueErrorDetail](#model-GsaValueNotProvidedParameterValueErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "inUse": "#/components/schemas/GsaInUseParameterValueErrorDetail", - "logScaleNegative": "#/components/schemas/GsaLogScaleNegativeParameterValueErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityParameterValueErrorDetail", - "nameWhitespace": "#/components/schemas/GsaNameWhitespaceParameterValueErrorDetail", - "parameterValueType": "#/components/schemas/GsaParameterValueTypeParameterValueErrorDetail", - "valueNotProvided": "#/components/schemas/GsaValueNotProvidedParameterValueErrorDetail" - } - } - }, - "GsaParameterValueErrorReason": { - "enum": [ - "inUse", - "logScaleNegative", - "namedEntity", - "nameWhitespace", - "parameterValueType", - "valueNotProvided" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • inUse: The parameter value is being used.
    • \r\n
  • logScaleNegative: For a log-scale parameter, all values must be greater than zero.
    • \r\n
  • namedEntity: The parameter value name or GUID is not valid.
    • \r\n
  • nameWhitespace: Parameter value names must not contain leading or trailing whitespace.
    • \r\n
  • parameterValueType: All parameter values should match the type (discrete or numeric) of the parameter.
    • \r\n
  • valueNotProvided: Numeric parameter values must have a value.
    • \r\n
\r\n" + "description": "\r\n\r\nThis extends: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" }, - "GsaParameterValueParameterErrorDetail": { + "GsaNumericParameterContent": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaParameterContent" }, { "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, + "value": { + "type": "number", + "format": "double", "nullable": true + }, + "parameterRange": { + "$ref": "#/components/schemas/GsaContinuousRange" } } } ], "additionalProperties": false, - "description": "Parameter value is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterValue'", - "x-discriminator-value": "parameterValue", - "x-discriminator-name": "reason" - }, - "GsaParameterValueType": { - "enum": [ - "discrete", - "numeric" - ], - "type": "string" + "description": "\r\n\r\nThis extends: GsaParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" }, - "GsaParameterValueTypeParameterValueErrorDetail": { + "GsaNumericParameterDataValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" + "$ref": "#/components/schemas/GsaParameterDataValue" }, { + "required": [ + "parameterValue" + ], "type": "object", "properties": { - "parameterType": { - "$ref": "#/components/schemas/GsaParameterType" + "parameterValue": { + "type": "number", + "format": "double" + }, + "unit": { + "$ref": "#/components/schemas/GsaSlimUnit" + }, + "name": { + "type": "string", + "nullable": true } } } ], "additionalProperties": false, - "description": "All parameter values should match the type (discrete or numeric) of the parameter.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterValueType'", - "x-discriminator-value": "parameterValueType", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaParameterDataValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "parameterType" }, - "GsaParameterValueUpdateException": { + "GsaNumericParameterValue": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "parameterValueGuid": { - "type": "string", - "format": "uuid" - }, - "parameterGuid": { - "type": "string", - "format": "uuid" + "allOf": [ + { + "$ref": "#/components/schemas/GsaParameterValue" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - "nullable": true + { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "double" + }, + "name": { + "type": "string", + "nullable": true + } + } } - }, - "additionalProperties": false - }, - "GsaParameterValueUsedByType": { - "enum": [ - "functionalDataDefault", - "multiValuedPointData" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • functionalDataDefault: The parameter value is used as the default parameter value on one or more functional datums.
    • \r\n
  • multiValuedPointData: The discrete parameter value is used by multi-valued point data.
    • \r\n
\r\n" - }, - "GsaParameterWithDataValue": { - "required": [ - "parameter", - "parameterDataValue" ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "x-discriminator-value": "numeric", + "x-discriminator-name": "type" + }, + "GsaObjectIdentifier": { "type": "object", "properties": { - "parameter": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" + "guid": { + "type": "string", + "description": "The GUID of this object. The GUID represents the object on a semantic level, and two objects of\r\nthe same type with the same GUID are considered to represent \"the same concept\". GUIDs should be\r\nrobust against data changes and database upgrades, and should be preferred where possible.", + "format": "uuid", + "nullable": true }, - "parameterDataValue": { - "$ref": "#/components/schemas/GsaParameterDataValue" + "name": { + "type": "string", + "description": "The name of this object. The name represents the object at a human-readable level, but two objects of\r\nthe same type with the same need not represent \"the same concept\". Because the name is less uniquely identifying,\r\nclients should prefer GUIDs where possible, and operations based on name instead of GUID may fail if the name\r\ncannot be uniquely resolved. Certain object types may consider names to be equivalent", + "nullable": true + }, + "identity": { + "type": "integer", + "description": "The underlying identity of this object. This represents the object at a data level, and two objects\r\nof the same type with the same identity are considered to represent \"the same object\". However, identities\r\nare not robust against database upgrades, and are only reliable and consistent within a currently-\r\nloaded database in a running MI instance. Clients should prefer GUIDs where possible, and operations\r\nbased on identity which persist data will be resolved to GUIDs instead (and may fail if this cannot\r\nbe done).", + "format": "int32", + "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Properties that identify an object within the MI system.\r\n \r\nAn Granta.Server.Api.ObjectIdentifier created by MI will always contain values for all three\r\nproperties. An Granta.Server.Api.ObjectIdentifier created by a client need not contain values for\r\nall three properties, and is allowed to contain values or combinations of values that do\r\nnot correspond to an existing object in MI (in which case the Granta.Server.Api.ObjectIdentifier\r\nwill be resolved against MI objects first by GUID, and then by name, and finally by identity,\r\ntaking the first match and ignoring subsequent fields." }, - "GsaParametersInfo": { + "GsaPagingOptions": { "type": "object", "properties": { - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameter" - }, + "pageSize": { + "type": "integer", + "description": "The number of results that should be returned in each page", + "format": "int32" + }, + "keepAliveInMinutes": { + "type": "integer", + "description": "The length of time that the paginated search should be kept in memory", + "format": "int32", + "nullable": true + }, + "pageNumber": { + "type": "integer", + "description": "(Optional) the (1-indexed) number of the page to return from the search. No pages are returned if not provided", + "format": "int32", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "An optional field for paging options. If provided on a request, the response will contain an identifier that can be used to retrieve the other pages. Page size must be smaller than 10,000" }, - "GsaPermission": { + "GsaParameter": { "required": [ + "defaultParameterValueGuid", + "displayNames", "guid", - "name" + "name", + "type" ], "type": "object", "properties": { - "role": { - "type": "string", - "nullable": true + "type": { + "$ref": "#/components/schemas/GsaParameterType" }, - "description": { + "helpPath": { "type": "string", "nullable": true }, - "setMessage": { + "defaultParameterValueGuid": { "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true + "format": "uuid" }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + } }, "name": { "type": "string" @@ -114150,144 +79174,99 @@ "format": "uuid" } }, - "additionalProperties": false - }, - "GsaPermissionAccessControl": { - "required": [ - "canRead", - "canWrite", - "permission" - ], - "type": "object", - "properties": { - "permission": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "canRead": { - "type": "boolean" - }, - "canWrite": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaPermissionAccessControlAggregate": { - "required": [ - "canReadCount", - "canWriteCount", - "permission" - ], - "type": "object", - "properties": { - "permission": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "canReadCount": { - "type": "integer", - "format": "int32" - }, - "canWriteCount": { - "type": "integer", - "format": "int32" + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameter\r\n * GsaNumericParameter", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaDiscreteParameter", + "numeric": "#/components/schemas/GsaNumericParameter" } - }, - "additionalProperties": false + } }, - "GsaPermissionBasedAccessControlAggregationErrorDetail": { + "GsaParameterConstraint": { "required": [ - "message", - "reason" + "parameter", + "type" ], "type": "object", "properties": { - "message": { - "type": "string" + "parameter": { + "$ref": "#/components/schemas/GsaObjectIdentifier" }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlAggregationErrorReason" + "type": { + "$ref": "#/components/schemas/GsaParameterConstraintType" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAccessControlEntitiesAggregationErrorDetail](#model-GsaAccessControlEntitiesAggregationErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterNameConstraint\r\n * GsaDiscreteParameterValueConstraint\r\n * GsaNumericParameterConstraint", "discriminator": { - "propertyName": "reason", + "propertyName": "type", "mapping": { - "accessControlEntities": "#/components/schemas/GsaAccessControlEntitiesAggregationErrorDetail" + "discreteName": "#/components/schemas/GsaDiscreteParameterNameConstraint", + "discreteValue": "#/components/schemas/GsaDiscreteParameterValueConstraint", + "numeric": "#/components/schemas/GsaNumericParameterConstraint" } } }, - "GsaPermissionBasedAccessControlAggregationErrorReason": { + "GsaParameterConstraintType": { "enum": [ - "accessControlEntities" + "discreteName", + "discreteValue", + "numeric" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • accessControlEntities: The access control entities are not valid.
    • \r\n
\r\n" + "type": "string" }, - "GsaPermissionBasedAccessControlAggregationException": { + "GsaParameterContent": { + "required": [ + "parameter", + "type" + ], "type": "object", "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "type": { + "$ref": "#/components/schemas/GsaParameterType" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlAggregationErrorDetail" - }, - "nullable": true + "parameter": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" } }, - "additionalProperties": false - }, - "GsaPermissionBasedAccessControlEntitiesErrorReason": { - "enum": [ - "noSuchEntities", - "noSuchSubset" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • noSuchEntities: The entities specified could not be found.
    • \r\n
  • noSuchSubset: The subset specified could not be found for these entities.
    • \r\n
\r\n" + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterContent\r\n * GsaNumericParameterContent", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaDiscreteParameterContent", + "numeric": "#/components/schemas/GsaNumericParameterContent" + } + } }, - "GsaPermissionBasedAccessControlInfo": { + "GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAccessControlInfo" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, { - "type": "object" + "type": "object", + "properties": { + "duplicatedGuids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "nullable": true + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlInfo](#model-GsaAccessControlInfo)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'permissionBased'", - "x-discriminator-value": "permissionBased", - "x-discriminator-name": "mode" - }, - "GsaPermissionBasedAccessControlUpdateOperationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlUpdateOperationsErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false + "description": "No duplicate parameter GUIDs allowed in parameter contents.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentDuplicateGuids'", + "x-discriminator-value": "parameterContentDuplicateGuids", + "x-discriminator-name": "reason" }, - "GsaPermissionBasedAccessControlUpdateOperationsErrorDetail": { + "GsaParameterContentErrorDetail": { "required": [ "message", "reason" @@ -114298,333 +79277,277 @@ "type": "string" }, "reason": { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlUpdateOperationsErrorReason" + "$ref": "#/components/schemas/GsaParameterContentErrorReason" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAccessControlEntitiesUpdateOperationsErrorDetail](#model-GsaAccessControlEntitiesUpdateOperationsErrorDetail)\r\n * [GsaPermissionCategoriesUpdateOperationsErrorDetail](#model-GsaPermissionCategoriesUpdateOperationsErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaParameterTypeParameterContentErrorDetail\r\n * GsaMissingArgumentsParameterContentErrorDetail\r\n * GsaNoSuchParameterValueParameterContentErrorDetail", "discriminator": { "propertyName": "reason", "mapping": { - "accessControlEntities": "#/components/schemas/GsaAccessControlEntitiesUpdateOperationsErrorDetail", - "permissionCategories": "#/components/schemas/GsaPermissionCategoriesUpdateOperationsErrorDetail" + "parameterType": "#/components/schemas/GsaParameterTypeParameterContentErrorDetail", + "missingArguments": "#/components/schemas/GsaMissingArgumentsParameterContentErrorDetail", + "noSuchParameterValue": "#/components/schemas/GsaNoSuchParameterValueParameterContentErrorDetail" } } }, - "GsaPermissionBasedAccessControlUpdateOperationsErrorReason": { + "GsaParameterContentErrorReason": { "enum": [ - "accessControlEntities", - "permissionCategories" + "parameterType", + "missingArguments", + "noSuchParameterValue" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • accessControlEntities: The access control entities are not valid.
    • \r\n
  • permissionCategories: The permission categories are not valid.
    • \r\n
\r\n" + "type": "string" }, - "GsaPermissionCategoriesAccessControlErrorDetail": { - "required": [ - "message", - "reason" - ], + "GsaParameterContentMathsFunctionalErrorDetail": { "type": "object", - "properties": { - "message": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorReason" + { + "type": "object", + "properties": { + "parameterGuid": { + "type": "string", + "format": "uuid" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaParameterContentErrorDetail" + }, + "nullable": true + } + } } - }, + ], "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNoSuchCategoryAccessControlErrorDetail](#model-GsaNoSuchCategoryAccessControlErrorDetail)\r\n * [GsaNoSuchPermissionAccessControlErrorDetail](#model-GsaNoSuchPermissionAccessControlErrorDetail)\r\n * [GsaDuplicateCategoryGuidsAccessControlErrorDetail](#model-GsaDuplicateCategoryGuidsAccessControlErrorDetail)\r\n * [GsaDuplicatePermissionGuidsAccessControlErrorDetail](#model-GsaDuplicatePermissionGuidsAccessControlErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "noSuchCategory": "#/components/schemas/GsaNoSuchCategoryAccessControlErrorDetail", - "noSuchPermission": "#/components/schemas/GsaNoSuchPermissionAccessControlErrorDetail", - "duplicateCategoryGuids": "#/components/schemas/GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "duplicatePermissionGuids": "#/components/schemas/GsaDuplicatePermissionGuidsAccessControlErrorDetail" - } - } + "description": "ParameterContent is not valid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContent'", + "x-discriminator-value": "parameterContent", + "x-discriminator-name": "reason" }, - "GsaPermissionCategoriesAccessControlErrorReason": { + "GsaParameterContentMissingArgument": { "enum": [ - "noSuchPermission", - "noSuchCategory", - "duplicateCategoryGuids", - "duplicatePermissionGuids" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • noSuchPermission: The permission specified does not exist.
    • \r\n
  • noSuchCategory: The permission category specified does not exist.
    • \r\n
  • duplicateCategoryGuids: Duplicate permission category GUIDs were specified in the request.
    • \r\n
  • duplicatePermissionGuids: Duplicate permission GUIDs were specified within a category in the request.
    • \r\n
\r\n" - }, - "GsaPermissionCategoriesAccessControlUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoriesInfo": { - "required": [ - "categories" + 0, + 1, + 2 ], - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategory" - } - } - }, - "additionalProperties": false + "type": "integer", + "description": "

Possible values:

\r\n
    \r\n
  • discreteParameterValueGuid: Parameter value GUID from parameter content must be provided.
    • \r\n
  • parameterRange: Parameter range from parameter content must be provided.
    • \r\n
  • parameterRangeParameterValues: Parameter values from parameter range from parameter content must be provided.
    • \r\n
\r\n", + "format": "int32" }, - "GsaPermissionCategoriesUpdateOperationsErrorDetail": { + "GsaParameterContentUnknownParametersMathsFunctionalErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionBasedAccessControlUpdateOperationsErrorDetail" + "$ref": "#/components/schemas/GsaMathsFunctionalErrorDetail" }, { - "required": [ - "errors" - ], "type": "object", "properties": { - "errors": { + "parameterGuids": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" - } + "type": "string", + "format": "uuid" + }, + "nullable": true + }, + "attributeGuid": { + "type": "string", + "format": "uuid", + "nullable": true } } } ], "additionalProperties": false, - "description": "The permission categories are not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionBasedAccessControlUpdateOperationsErrorDetail](#model-GsaPermissionBasedAccessControlUpdateOperationsErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'permissionCategories'", - "x-discriminator-value": "permissionCategories", + "description": "Parameters in parameter contents must be from this attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentUnknownParameters'", + "x-discriminator-value": "parameterContentUnknownParameters", "x-discriminator-name": "reason" }, - "GsaPermissionCategory": { + "GsaParameterDataValue": { "required": [ - "guid", - "name", - "permissions" + "parameterType" ], "type": "object", "properties": { - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermission" - } - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" + "parameterType": { + "$ref": "#/components/schemas/GsaParameterType" } }, - "additionalProperties": false - }, - "GsaPermissionCategoryAccessControl": { - "required": [ - "category", - "permissionAccessControls" - ], - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "permissionAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionAccessControl" - } + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterDataValue\r\n * GsaNumericParameterDataValue", + "discriminator": { + "propertyName": "parameterType", + "mapping": { + "discrete": "#/components/schemas/GsaDiscreteParameterDataValue", + "numeric": "#/components/schemas/GsaNumericParameterDataValue" } - }, - "additionalProperties": false + } }, - "GsaPermissionCategoryAccessControlAggregate": { - "required": [ - "category", - "permissionAggregates" - ], + "GsaParameterDeletionException": { "type": "object", "properties": { - "category": { - "$ref": "#/components/schemas/GsaSlimEntity" + "message": { + "type": "string", + "nullable": true }, - "permissionAggregates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionAccessControlAggregate" - } - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryAccessControlAggregateInfo": { - "type": "object", - "properties": { - "entityCount": { - "type": "integer", - "format": "int32" + "code": { + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, - "categoryAggregates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlAggregate" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryAccessControlInfo": { - "type": "object", - "properties": { - "categoryAccessControls": { + "errors": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControl" + "$ref": "#/components/schemas/GsaDataModificationErrorDetail" }, "nullable": true } }, "additionalProperties": false }, - "GsaPermissionCategoryCreationException": { - "required": [ - "name" - ], + "GsaParameterInfo": { "type": "object", "properties": { - "message": { + "name": { "type": "string", "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "identity": { + "type": "integer", + "format": "int32" }, - "name": { - "type": "string" + "guid": { + "type": "string", + "format": "uuid", + "nullable": true }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, + "unitSymbol": { + "type": "string", "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorReason" + "scaleType": { + "$ref": "#/components/schemas/GsaParameterInfoScaleType" + }, + "interpolationType": { + "$ref": "#/components/schemas/GsaParameterInfoInterpolationType" + }, + "parameterType": { + "$ref": "#/components/schemas/GsaParameterInfoParameterType" + }, + "defaultValue": { + "$ref": "#/components/schemas/GsaDataExportParameterValue" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityPermissionCategoryErrorDetail](#model-GsaNamedEntityPermissionCategoryErrorDetail)\r\n * [GsaNoPermissionsPermissionCategoryErrorDetail](#model-GsaNoPermissionsPermissionCategoryErrorDetail)\r\n * [GsaTooManyPermissionsPermissionCategoryErrorDetail](#model-GsaTooManyPermissionsPermissionCategoryErrorDetail)\r\n * [GsaDuplicatePermissionsPermissionCategoryErrorDetail](#model-GsaDuplicatePermissionsPermissionCategoryErrorDetail)\r\n * [GsaPermissionPermissionCategoryErrorDetail](#model-GsaPermissionPermissionCategoryErrorDetail)\r\n * [GsaNoSuchPermissionsPermissionCategoryErrorDetail](#model-GsaNoSuchPermissionsPermissionCategoryErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityPermissionCategoryErrorDetail", - "noPermissions": "#/components/schemas/GsaNoPermissionsPermissionCategoryErrorDetail", - "tooManyPermissions": "#/components/schemas/GsaTooManyPermissionsPermissionCategoryErrorDetail", - "duplicatePermissions": "#/components/schemas/GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "permission": "#/components/schemas/GsaPermissionPermissionCategoryErrorDetail", - "noSuchPermissions": "#/components/schemas/GsaNoSuchPermissionsPermissionCategoryErrorDetail" - } - } + "description": "\r\n\r\nparameterType: Parameter type can be null for integration schema" + }, + "GsaParameterInfoInterpolationType": { + "enum": [ + "auto", + "none", + "linear", + "cubicSpline" + ], + "type": "string" }, - "GsaPermissionCategoryErrorReason": { + "GsaParameterInfoParameterType": { "enum": [ - "namedEntity", - "noPermissions", - "tooManyPermissions", - "duplicatePermissions", - "permission", - "noSuchPermissions" + "discrete", + "numericRestricted", + "numericUnrestricted" + ], + "type": "string" + }, + "GsaParameterInfoScaleType": { + "enum": [ + "notSet", + "linear", + "log" + ], + "type": "string" + }, + "GsaParameterInterpolationType": { + "enum": [ + "none", + "linear", + "cubicSpline" + ], + "type": "string" + }, + "GsaParameterScaleType": { + "enum": [ + "linear", + "logarithmic" + ], + "type": "string" + }, + "GsaParameterSettingDefinedAt": { + "enum": [ + "parameter", + "attribute", + "datum" ], "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noPermissions: Permission categories must have at least one permission.
    • \r\n
  • tooManyPermissions: The new permissions cannot be added, there are not enough permissions available. A schema for a database may have up to 128 permissions. This is the total number of permissions that have ever existed in the schema
    • \r\n
  • duplicatePermissions: Duplicate permissions were specified, either by name or GUID.
    • \r\n
  • permission: A permission in the category is not valid.
    • \r\n
  • noSuchPermissions: One or more permissions specified for update do not exist in the category.
    • \r\n
\r\n" + "description": "

Possible values:

\r\n
    \r\n
  • parameter: Parameter Level
    • \r\n
  • attribute: Attribute Level
    • \r\n
  • datum: Datum Level
    • \r\n
\r\n" + }, + "GsaParameterType": { + "enum": [ + "discrete", + "numeric" + ], + "type": "string" }, - "GsaPermissionCategoryReplaceException": { + "GsaParameterTypeParameterContentErrorDetail": { "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "allOf": [ + { + "$ref": "#/components/schemas/GsaParameterContentErrorDetail" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false + { + "type": "object", + "properties": { + "requestedParameterType": { + "$ref": "#/components/schemas/GsaParameterType" + }, + "actualParameterType": { + "$ref": "#/components/schemas/GsaParameterType" + } + } + } + ], + "additionalProperties": false, + "description": "Requested parameter content type does not align with its actual parameter type.\r\n\r\nThis extends: GsaParameterContentErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterType'", + "x-discriminator-value": "parameterType", + "x-discriminator-name": "reason" }, - "GsaPermissionCategoryUpdateException": { + "GsaParameterValue": { "required": [ - "guid" + "guid", + "type" ], "type": "object", "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "type": { + "$ref": "#/components/schemas/GsaParameterValueType" }, "guid": { "type": "string", "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterValue\r\n * GsaNumericParameterValue", + "discriminator": { + "propertyName": "type", + "mapping": { + "discrete": "#/components/schemas/GsaDiscreteParameterValue", + "numeric": "#/components/schemas/GsaNumericParameterValue" + } + } }, - "GsaPermissionCreationException": { - "required": [ - "name" - ], + "GsaParameterValueDeletionException": { "type": "object", "properties": { "message": { @@ -114632,186 +79555,124 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" + "$ref": "#/components/schemas/GsaDataModificationErrorDetail" }, "nullable": true } }, "additionalProperties": false }, - "GsaPermissionDeletionErrorDetail": { + "GsaParameterValueType": { + "enum": [ + "discrete", + "numeric" + ], + "type": "string" + }, + "GsaParameterWithDataValue": { "required": [ - "message", - "reason" + "parameter", + "parameterDataValue" ], "type": "object", "properties": { - "message": { - "type": "string" + "parameter": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionDeletionErrorReason" + "parameterDataValue": { + "$ref": "#/components/schemas/GsaParameterDataValue" } }, "additionalProperties": false }, - "GsaPermissionDeletionErrorReason": { - "enum": [ - "categoryMustHavePermissions" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • categoryMustHavePermissions: Permission categories must have at least one permission.
    • \r\n
\r\n" - }, - "GsaPermissionDeletionException": { - "required": [ - "guid" - ], + "GsaParametersInfo": { "type": "object", "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "errors": { + "parameters": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermissionDeletionErrorDetail" + "$ref": "#/components/schemas/GsaParameter" }, "nullable": true } }, "additionalProperties": false }, - "GsaPermissionErrorDetail": { + "GsaPermission": { "required": [ - "message", - "reason" + "guid", + "name", + "role" ], "type": "object", "properties": { - "message": { + "role": { "type": "string" }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityPermissionErrorDetail](#model-GsaNamedEntityPermissionErrorDetail)\r\n * [GsaRoleNotProvidedPermissionErrorDetail](#model-GsaRoleNotProvidedPermissionErrorDetail)\r\n * [GsaMaxPermissionsReachedPermissionErrorDetail](#model-GsaMaxPermissionsReachedPermissionErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityPermissionErrorDetail", - "roleNotProvided": "#/components/schemas/GsaRoleNotProvidedPermissionErrorDetail", - "maxPermissionsReached": "#/components/schemas/GsaMaxPermissionsReachedPermissionErrorDetail" - } - } - }, - "GsaPermissionErrorReason": { - "enum": [ - "namedEntity", - "roleNotProvided", - "maxPermissionsReached" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • roleNotProvided: Role must be provided, and cannot be empty or whitespace.
    • \r\n
  • maxPermissionsReached: There are no more permissions available, the maximum number has been reached. A schema for a database may have up to 128 permissions. This is the total number of permissions that have ever existed in the schema
    • \r\n
\r\n" - }, - "GsaPermissionPermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" + "description": { + "type": "string", + "nullable": true }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The permission is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'permission'", - "x-discriminator-value": "permission", - "x-discriminator-name": "reason" - }, - "GsaPermissionUpdateException": { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "message": { + "setMessage": { "type": "string", + "description": "Message to show when this permission is set.", "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "unsetMessage": { + "type": "string", + "description": "Message to show when this permission is not set.", + "nullable": true + }, + "name": { + "type": "string" }, "guid": { "type": "string", "format": "uuid" - }, - "errors": { + } + }, + "additionalProperties": false + }, + "GsaPermissionCategoriesInfo": { + "required": [ + "categories" + ], + "type": "object", + "properties": { + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - }, - "nullable": true + "$ref": "#/components/schemas/GsaSlimPermissionCategory" + } } }, "additionalProperties": false }, - "GsaPermissionsInUseInfo": { + "GsaPermissionCategory": { "required": [ - "maxPermissionsAvailable", - "permissionsAvailableForUse", - "permissionsUsed" + "guid", + "name", + "permissions" ], "type": "object", "properties": { - "permissionsUsed": { - "type": "integer", - "format": "int32" + "permissions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } }, - "maxPermissionsAvailable": { - "type": "integer", - "format": "int32" + "name": { + "type": "string" }, - "permissionsAvailableForUse": { - "type": "integer", - "format": "int32" + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false @@ -114825,7 +79686,7 @@ "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermission" + "$ref": "#/components/schemas/GsaSlimPermission" } } }, @@ -114842,7 +79703,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -114865,7 +79726,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "datumType" }, @@ -114880,7 +79741,7 @@ } ], "additionalProperties": false, - "description": "picture: Criterion for matching records where picture data exists.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "picture: Criterion for matching records where picture data exists.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -114895,7 +79756,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -114922,7 +79783,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "datumType" }, @@ -114937,7 +79798,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with at least one value for the attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with at least one value for the attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -114970,35 +79831,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", - "x-discriminator-value": "point", - "x-discriminator-name": "type" - }, - "GsaPointChartData": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaChartData" - }, - { - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "estimated": { - "type": "boolean" - }, - "parameterValues": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -115054,7 +79887,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "datumType" }, @@ -115083,7 +79916,7 @@ } ], "additionalProperties": false, - "description": "Criterion for matching records where the point data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "Criterion for matching records where the point data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -115098,7 +79931,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -115125,7 +79958,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointFixedWidthHistogram'", + "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointFixedWidthHistogram'", "x-discriminator-value": "pointFixedWidthHistogram", "x-discriminator-name": "type" }, @@ -115145,7 +79978,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'pointHistogram'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'pointHistogram'", "x-discriminator-value": "pointHistogram", "x-discriminator-name": "datumType" }, @@ -115166,518 +79999,195 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointHistogram'", + "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointHistogram'", "x-discriminator-value": "pointHistogram", "x-discriminator-name": "type" }, - "GsaPointParametersRequiresMultiValuedAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Only attributes marked as multi-valued can be parameterized.\r\nPoint attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'pointParametersRequiresMultiValued'", - "x-discriminator-value": "pointParametersRequiresMultiValued", - "x-discriminator-name": "reason" - }, - "GsaProcessingConfig": { - "type": "object", - "properties": { - "purgeJobAgeInMilliseconds": { - "type": "integer", - "format": "int64" - }, - "purgeIntervalInMilliseconds": { - "type": "integer", - "format": "int64" - }, - "pollingIntervalInMilliseconds": { - "type": "integer", - "format": "int64" - }, - "concurrency": { - "type": "integer", - "format": "int32" - } - }, - "additionalProperties": false - }, - "GsaProfile": { - "required": [ - "isImplicit", - "key", - "name", - "profileTables" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "homepageUrl": { - "type": "string", - "nullable": true - }, - "profileTables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimProfileTable" - } - }, - "key": { - "type": "string", - "description": "Key is a unique identifier of a profile. Separate from guid." - }, - "guid": { - "type": "string", - "description": "Guid is a unique identifier of a profile. Separate from key.", - "format": "uuid", - "nullable": true - }, - "groupName": { - "type": "string", - "nullable": true - }, - "isImplicit": { - "type": "boolean" - }, - "name": { - "type": "string" - } - }, - "additionalProperties": false, - "description": "A profile, consisting of a set of tables from one or more databases." - }, - "GsaProfileTable": { - "required": [ - "databaseGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "subsetGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "subsetFallbackHint": { - "type": "string", - "nullable": true - }, - "layoutGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "layoutFallbackHint": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "databaseGuid": { - "type": "string", - "format": "uuid" - }, - "databaseFallbackHint": { - "type": "string", - "nullable": true - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "tableFallbackHint": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false, - "description": "A table within a profile. Contains display customization." - }, - "GsaProfileTablesInfo": { - "type": "object", - "properties": { - "profileTables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimProfileTable" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaProperty": { - "required": [ - "propertyName" - ], - "type": "object", - "properties": { - "propertyName": { - "$ref": "#/components/schemas/GsaRecordProperty" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaBreadcrumbsProperty](#model-GsaBreadcrumbsProperty)\r\n * [GsaCreatedByUserProperty](#model-GsaCreatedByUserProperty)\r\n * [GsaCreatedDateProperty](#model-GsaCreatedDateProperty)\r\n * [GsaDatabaseKeyProperty](#model-GsaDatabaseKeyProperty)\r\n * [GsaFullNameProperty](#model-GsaFullNameProperty)\r\n * [GsaLastModifiedDateProperty](#model-GsaLastModifiedDateProperty)\r\n * [GsaLastModifiedByUserProperty](#model-GsaLastModifiedByUserProperty)\r\n * [GsaRecordColorProperty](#model-GsaRecordColorProperty)\r\n * [GsaRecordGuidProperty](#model-GsaRecordGuidProperty)\r\n * [GsaRecordHistoryGuidProperty](#model-GsaRecordHistoryGuidProperty)\r\n * [GsaRecordTypeProperty](#model-GsaRecordTypeProperty)\r\n * [GsaReleasedDateProperty](#model-GsaReleasedDateProperty)\r\n * [GsaShortNameProperty](#model-GsaShortNameProperty)\r\n * [GsaTableGuidProperty](#model-GsaTableGuidProperty)\r\n * [GsaTableIdentityProperty](#model-GsaTableIdentityProperty)\r\n * [GsaTableNameProperty](#model-GsaTableNameProperty)\r\n * [GsaVersionNumberProperty](#model-GsaVersionNumberProperty)\r\n * [GsaVersionStateProperty](#model-GsaVersionStateProperty)", - "discriminator": { - "propertyName": "propertyName", - "mapping": { - "breadcrumbs": "#/components/schemas/GsaBreadcrumbsProperty", - "createdByUser": "#/components/schemas/GsaCreatedByUserProperty", - "createdDate": "#/components/schemas/GsaCreatedDateProperty", - "databaseKey": "#/components/schemas/GsaDatabaseKeyProperty", - "fullName": "#/components/schemas/GsaFullNameProperty", - "lastModifiedDate": "#/components/schemas/GsaLastModifiedDateProperty", - "lastModifiedByUser": "#/components/schemas/GsaLastModifiedByUserProperty", - "recordColor": "#/components/schemas/GsaRecordColorProperty", - "recordGuid": "#/components/schemas/GsaRecordGuidProperty", - "recordHistoryGuid": "#/components/schemas/GsaRecordHistoryGuidProperty", - "recordType": "#/components/schemas/GsaRecordTypeProperty", - "releasedDate": "#/components/schemas/GsaReleasedDateProperty", - "shortName": "#/components/schemas/GsaShortNameProperty", - "tableGuid": "#/components/schemas/GsaTableGuidProperty", - "tableIdentity": "#/components/schemas/GsaTableIdentityProperty", - "tableName": "#/components/schemas/GsaTableNameProperty", - "versionNumber": "#/components/schemas/GsaVersionNumberProperty", - "versionState": "#/components/schemas/GsaVersionStateProperty" - } - } - }, - "GsaPutDiscreteValue": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaPutType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePutDiscreteValue](#model-GsaCreatePutDiscreteValue)\r\n * [GsaUpdatePutDiscreteValue](#model-GsaUpdatePutDiscreteValue)", - "discriminator": { - "propertyName": "type", - "mapping": { - "create": "#/components/schemas/GsaCreatePutDiscreteValue", - "update": "#/components/schemas/GsaUpdatePutDiscreteValue" - } - } - }, - "GsaPutLayoutItem": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaPutType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n * [GsaUpdatePutLayoutItem](#model-GsaUpdatePutLayoutItem)", - "discriminator": { - "propertyName": "type", - "mapping": { - "create": "#/components/schemas/GsaCreatePutLayoutItem", - "update": "#/components/schemas/GsaUpdatePutLayoutItem" - } - } - }, - "GsaPutPermission": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaPutType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePutPermission](#model-GsaCreatePutPermission)\r\n * [GsaUpdatePutPermission](#model-GsaUpdatePutPermission)", - "discriminator": { - "propertyName": "type", - "mapping": { - "create": "#/components/schemas/GsaCreatePutPermission", - "update": "#/components/schemas/GsaUpdatePutPermission" - } - } - }, - "GsaPutPermissionCategory": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaPutType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory)\r\n * [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory)", - "discriminator": { - "propertyName": "type", - "mapping": { - "create": "#/components/schemas/GsaCreatePutPermissionCategory", - "update": "#/components/schemas/GsaUpdatePutPermissionCategory" - } - } - }, - "GsaPutType": { - "enum": [ - "create", - "update" - ], - "type": "string" - }, - "GsaQualityDiscreteValue": { - "required": [ - "guid", - "name", - "order" - ], - "type": "object", - "properties": { - "order": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaQualityDiscreteValueErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaQualityDiscreteValueErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityQualityDiscreteValueErrorDetail](#model-GsaNamedEntityQualityDiscreteValueErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityQualityDiscreteValueErrorDetail" - } - } - }, - "GsaQualityDiscreteValueErrorReason": { - "enum": [ - "namedEntity" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
\r\n" - }, - "GsaQualityDiscreteValuesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaQualitySystemErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQualityDiscreteValueErrorDetail" - } - } - } + "GsaPointParametersRequiresMultiValuedAttributeErrorDetail": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaAttributeErrorDetail" + }, + { + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystemErrorDetail](#model-GsaQualitySystemErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'qualityDiscreteValues'", - "x-discriminator-value": "qualityDiscreteValues", + "description": "Only attributes marked as multi-valued can be parameterized.\r\nPoint attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'pointParametersRequiresMultiValued'", + "x-discriminator-value": "pointParametersRequiresMultiValued", "x-discriminator-name": "reason" }, - "GsaQualitySystem": { + "GsaProcessingConfig": { + "type": "object", + "properties": { + "purgeJobAgeInMilliseconds": { + "type": "integer", + "format": "int64" + }, + "purgeIntervalInMilliseconds": { + "type": "integer", + "format": "int64" + }, + "pollingIntervalInMilliseconds": { + "type": "integer", + "format": "int64" + }, + "concurrency": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "GsaProfile": { "required": [ - "guid", + "isImplicit", + "key", "name", - "type" + "profileTables" ], "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/GsaQualitySystemType" + "description": { + "type": "string", + "nullable": true }, - "name": { - "type": "string" + "homepageUrl": { + "type": "string", + "nullable": true + }, + "profileTables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimProfileTable" + } + }, + "key": { + "type": "string", + "description": "Key is a unique identifier of a profile. Separate from guid." }, "guid": { "type": "string", - "format": "uuid" + "description": "Guid is a unique identifier of a profile. Separate from key.", + "format": "uuid", + "nullable": true + }, + "groupName": { + "type": "string", + "nullable": true + }, + "isImplicit": { + "type": "boolean" + }, + "name": { + "type": "string" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteQualitySystem](#model-GsaDiscreteQualitySystem)\r\n * [GsaContinuousQualitySystem](#model-GsaContinuousQualitySystem)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteQualitySystem", - "continuous": "#/components/schemas/GsaContinuousQualitySystem" - } - } + "description": "A profile, consisting of a set of tables from one or more databases." }, - "GsaQualitySystemCreationException": { + "GsaProfileTable": { "required": [ - "name" + "databaseGuid", + "tableGuid" ], "type": "object", "properties": { - "message": { + "subsetGuid": { "type": "string", + "format": "uuid", "nullable": true }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "subsetFallbackHint": { + "type": "string", + "nullable": true }, - "name": { - "type": "string" + "layoutGuid": { + "type": "string", + "format": "uuid", + "nullable": true }, - "errors": { + "layoutFallbackHint": { + "type": "string", + "nullable": true + }, + "guid": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "databaseGuid": { + "type": "string", + "format": "uuid" + }, + "databaseFallbackHint": { + "type": "string", + "nullable": true + }, + "tableGuid": { + "type": "string", + "format": "uuid" + }, + "tableFallbackHint": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false, + "description": "A table within a profile. Contains display customization." + }, + "GsaProfileTablesInfo": { + "type": "object", + "properties": { + "profileTables": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaQualitySystemErrorDetail" + "$ref": "#/components/schemas/GsaSlimProfileTable" }, "nullable": true } }, "additionalProperties": false }, - "GsaQualitySystemDeletionException": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDeletionException" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'qualitySystem'", - "x-discriminator-value": "qualitySystem", - "x-discriminator-name": "entityType" - }, - "GsaQualitySystemErrorDetail": { + "GsaProperty": { "required": [ - "message", - "reason" + "propertyName" ], "type": "object", "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaQualitySystemErrorReason" + "propertyName": { + "$ref": "#/components/schemas/GsaRecordProperty" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityQualitySystemErrorDetail](#model-GsaNamedEntityQualitySystemErrorDetail)\r\n * [GsaQualityDiscreteValuesErrorDetail](#model-GsaQualityDiscreteValuesErrorDetail)\r\n * [GsaThresholdValueNameInvalidErrorDetail](#model-GsaThresholdValueNameInvalidErrorDetail)\r\n * [GsaThresholdValueNameEmptyErrorDetail](#model-GsaThresholdValueNameEmptyErrorDetail)\r\n * [GsaNoQualityDiscreteValuesErrorDetail](#model-GsaNoQualityDiscreteValuesErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreatedByUserProperty\r\n * GsaCreatedDateProperty\r\n * GsaDatabaseKeyProperty\r\n * GsaFullNameProperty\r\n * GsaLastModifiedDateProperty\r\n * GsaLastModifiedByUserProperty\r\n * GsaRecordColorProperty\r\n * GsaRecordGuidProperty\r\n * GsaRecordHistoryGuidProperty\r\n * GsaRecordTypeProperty\r\n * GsaReleasedDateProperty\r\n * GsaShortNameProperty\r\n * GsaTableGuidProperty\r\n * GsaTableIdentityProperty\r\n * GsaTableNameProperty\r\n * GsaVersionNumberProperty\r\n * GsaVersionStateProperty", "discriminator": { - "propertyName": "reason", + "propertyName": "propertyName", "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityQualitySystemErrorDetail", - "qualityDiscreteValues": "#/components/schemas/GsaQualityDiscreteValuesErrorDetail", - "thresholdValueNameInvalid": "#/components/schemas/GsaThresholdValueNameInvalidErrorDetail", - "thresholdValueNameEmpty": "#/components/schemas/GsaThresholdValueNameEmptyErrorDetail", - "noQualityDiscreteValues": "#/components/schemas/GsaNoQualityDiscreteValuesErrorDetail" + "createdByUser": "#/components/schemas/GsaCreatedByUserProperty", + "createdDate": "#/components/schemas/GsaCreatedDateProperty", + "databaseKey": "#/components/schemas/GsaDatabaseKeyProperty", + "fullName": "#/components/schemas/GsaFullNameProperty", + "lastModifiedDate": "#/components/schemas/GsaLastModifiedDateProperty", + "lastModifiedByUser": "#/components/schemas/GsaLastModifiedByUserProperty", + "recordColor": "#/components/schemas/GsaRecordColorProperty", + "recordGuid": "#/components/schemas/GsaRecordGuidProperty", + "recordHistoryGuid": "#/components/schemas/GsaRecordHistoryGuidProperty", + "recordType": "#/components/schemas/GsaRecordTypeProperty", + "releasedDate": "#/components/schemas/GsaReleasedDateProperty", + "shortName": "#/components/schemas/GsaShortNameProperty", + "tableGuid": "#/components/schemas/GsaTableGuidProperty", + "tableIdentity": "#/components/schemas/GsaTableIdentityProperty", + "tableName": "#/components/schemas/GsaTableNameProperty", + "versionNumber": "#/components/schemas/GsaVersionNumberProperty", + "versionState": "#/components/schemas/GsaVersionStateProperty" } } }, - "GsaQualitySystemErrorReason": { - "enum": [ - "namedEntity", - "qualityDiscreteValues", - "thresholdValueNameInvalid", - "thresholdValueNameEmpty", - "noQualityDiscreteValues" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • qualityDiscreteValues: One or more errors occurred when creating or updating the quality discrete values for the discrete quality type.
    • \r\n
  • thresholdValueNameInvalid: Threshold Value Name does not match any quality discrete value.
    • \r\n
  • thresholdValueNameEmpty: Threshold Value Name is an empty string or whitespace.
    • \r\n
  • noQualityDiscreteValues: No Quality Discrete Values provided. At least one Quality Discrete Value is required for a Discrete Quality System.
    • \r\n
\r\n" - }, - "GsaQualitySystemGuidErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "type": "object", - "properties": { - "databaseKey": { - "type": "string", - "nullable": true - }, - "qualitySystemGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'qualitySystemGuid'", - "x-discriminator-value": "qualitySystemGuid", - "x-discriminator-name": "reason" - }, - "GsaQualitySystemType": { - "enum": [ - "discrete", - "continuous" - ], - "type": "string" - }, - "GsaQualitySystemsInfo": { - "type": "object", - "properties": { - "qualitySystems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQualitySystem" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaQueryAttribute": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "type": { "$ref": "#/components/schemas/GsaAttributeType" }, @@ -115696,19 +80206,12 @@ "type": "boolean", "nullable": true }, - "helpPath": { - "type": "string", - "nullable": true - }, "axisName": { "$ref": "#/components/schemas/GsaQueryAxisName" }, "info": { "$ref": "#/components/schemas/GsaQueryAttributeInfo" }, - "table": { - "$ref": "#/components/schemas/GsaQuerySlimEntity" - }, "unit": { "$ref": "#/components/schemas/GsaQueryUnit" }, @@ -115727,7 +80230,7 @@ "tabularColumns": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaQueryTabularColumn" + "$ref": "#/components/schemas/GsaQuerySlimNamedEntity" }, "nullable": true }, @@ -115793,13 +80296,10 @@ }, "description": "If set, attribute GUID must match any of these GUIDs.", "nullable": true - }, - "discreteType": { - "$ref": "#/components/schemas/GsaQuerySlimNamedEntityFilter" } }, "additionalProperties": false, - "description": "Optionally filter results.\r\n \r\nIf multiple properties are set, then attributes must match all of them.\r\n\r\ndiscreteType: If set, attribute must have a discrete type that matches the filter. If the filter has no criteria set, this means the attribute must have any discrete type assigned." + "description": "Optionally filter results.\r\n \r\nIf multiple properties are set, then attributes must match all of them." }, "GsaQueryAttributeInfo": { "type": "object", @@ -115835,10 +80335,6 @@ "GsaQueryAttributeProperties": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "type": { "type": "boolean", "nullable": true @@ -115860,19 +80356,12 @@ "description": "For a Granta.Server.Api.AttributeType.FloatFunctional attribute, whether the value for this attribute is ranged.\r\nFor other attribute types, returns null", "nullable": true }, - "helpPath": { - "type": "boolean", - "nullable": true - }, "axisName": { "$ref": "#/components/schemas/GsaQueryAxisNameProperties" }, "info": { "$ref": "#/components/schemas/GsaQueryAttributeInfoProperties" }, - "table": { - "$ref": "#/components/schemas/GsaQuerySlimEntityProperties" - }, "unit": { "$ref": "#/components/schemas/GsaQueryUnitProperties" }, @@ -115889,7 +80378,7 @@ "$ref": "#/components/schemas/GsaQueryTabularAttributeTargetProperties" }, "tabularColumns": { - "$ref": "#/components/schemas/GsaQueryTabularColumnProperties" + "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties" }, "attributeParameters": { "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties" @@ -116025,10 +80514,6 @@ "GsaQueryDiscreteType": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "discreteValues": { "type": "array", "items": { @@ -116079,10 +80564,6 @@ "GsaQueryDiscreteTypeProperties": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "discreteValues": { "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties" }, @@ -116132,277 +80613,6 @@ }, "additionalProperties": false }, - "GsaQueryLayout": { - "type": "object", - "properties": { - "sections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayoutSection" - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutFilter": { - "type": "object", - "properties": { - "sections": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionFilter" - } - }, - "additionalProperties": false, - "description": "Optionally filter results.\r\n \r\nIf multiple properties are set, then layouts must match all of them.\r\n\r\nsections: Filter by sections that the layout contains." - }, - "GsaQueryLayoutItem": { - "type": "object", - "properties": { - "underlyingEntityGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "itemType": { - "$ref": "#/components/schemas/GsaLayoutItemType" - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutItemFilter": { - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaLayoutItemType" - }, - "underlyingEntityGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "linkType": { - "$ref": "#/components/schemas/GsaLayoutItemLinkType" - }, - "targetDatabase": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "targetDatabaseVersion": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "targetTable": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "forwards": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "If multiple properties are set, then layout items must match all of them." - }, - "GsaQueryLayoutItemProperties": { - "type": "object", - "properties": { - "underlyingEntityGuid": { - "type": "boolean", - "nullable": true - }, - "itemType": { - "type": "boolean", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, - "GsaQueryLayoutProperties": { - "type": "object", - "properties": { - "sections": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionProperties" - }, - "displayNames": { - "type": "boolean", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, - "GsaQueryLayoutSection": { - "type": "object", - "properties": { - "sectionItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayoutItem" - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutSectionFilter": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "sectionItems": { - "$ref": "#/components/schemas/GsaQueryLayoutItemFilter" - } - }, - "additionalProperties": false, - "description": "If multiple properties are set, then layout sections must match all of them.\r\n\r\nsectionItems: Filter by items that the section contains." - }, - "GsaQueryLayoutSectionProperties": { - "type": "object", - "properties": { - "sectionItems": { - "$ref": "#/components/schemas/GsaQueryLayoutItemProperties" - }, - "displayNames": { - "type": "boolean", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, - "GsaQueryLayoutSectionsInfo": { - "required": [ - "layoutSections" - ], - "type": "object", - "properties": { - "layoutSections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayoutSection" - } - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutSectionsRequest": { - "required": [ - "properties" - ], - "type": "object", - "properties": { - "properties": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionProperties" - }, - "filter": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionFilter" - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutsInfo": { - "required": [ - "layouts" - ], - "type": "object", - "properties": { - "layouts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayout" - } - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutsRequest": { - "required": [ - "properties" - ], - "type": "object", - "properties": { - "properties": { - "$ref": "#/components/schemas/GsaQueryLayoutProperties" - }, - "filter": { - "$ref": "#/components/schemas/GsaQueryLayoutFilter" - } - }, - "additionalProperties": false - }, "GsaQuerySlimDiscreteType": { "type": "object", "properties": { @@ -116441,28 +80651,6 @@ "additionalProperties": false, "description": "Set values to true to include those properties in the query response" }, - "GsaQuerySlimEntity": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQuerySlimEntityProperties": { - "type": "object", - "properties": { - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, "GsaQuerySlimNamedEntity": { "type": "object", "properties": { @@ -116478,29 +80666,6 @@ }, "additionalProperties": false }, - "GsaQuerySlimNamedEntityFilter": { - "type": "object", - "properties": { - "name": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If set, entity name must match any of these names.", - "nullable": true - }, - "guid": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "If set, entity GUID must match any of these GUIDs.", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaQuerySlimNamedEntityProperties": { "type": "object", "properties": { @@ -116771,56 +80936,6 @@ "additionalProperties": false, "description": "Set values to true to include those properties in the query response" }, - "GsaQueryTabularColumn": { - "type": "object", - "properties": { - "linkedAttributeGuid": { - "type": "string", - "description": "This can only be populated for linked attribute type columns", - "format": "uuid", - "nullable": true - }, - "linkedColumnGuid": { - "type": "string", - "description": "This can only be populated for linked column type columns", - "format": "uuid", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryTabularColumnProperties": { - "type": "object", - "properties": { - "linkedAttributeGuid": { - "type": "boolean", - "nullable": true - }, - "linkedColumnGuid": { - "type": "boolean", - "description": "This can only be populated for linked column type columns", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaQueryUnit": { "type": "object", "properties": { @@ -116898,7 +81013,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "datumType" }, @@ -116913,7 +81028,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with a value for the attribute.\r\n \r\nAs in MI elsewhere, a range with only one boundary specified is treated like a point, rather than an infinitely large range.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with a value for the attribute.\r\n \r\nAs in MI elsewhere, a range with only one boundary specified is treated like a point, rather than an infinitely large range.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, @@ -116933,17 +81048,24 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, - "GsaRangeChartData": { + "GsaRangeDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaChartData" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { + "required": [ + "estimated", + "highValue", + "highValueIsInclusive", + "lowValue", + "lowValueIsInclusive" + ], "type": "object", "properties": { "lowValue": { @@ -116954,34 +81076,11 @@ "type": "number", "format": "double" }, - "estimated": { + "lowValueIsInclusive": { "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", - "x-discriminator-value": "range", - "x-discriminator-name": "type" - }, - "GsaRangeDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaApplicableDatum" - }, - { - "required": [ - "estimated" - ], - "type": "object", - "properties": { - "highEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" }, - "lowEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "highValueIsInclusive": { + "type": "boolean" }, "lowValueSignificantFiguresInfo": { "$ref": "#/components/schemas/GsaSignificantFiguresInfo" @@ -116999,7 +81098,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "datumType" }, @@ -117028,7 +81127,7 @@ } ], "additionalProperties": false, - "description": "Criterion for matching records where the range data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "Criterion for matching records where the range data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, @@ -117043,27 +81142,10 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, - "GsaRangeEndpoint": { - "required": [ - "inclusiveness", - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "inclusiveness": { - "$ref": "#/components/schemas/GsaInclusiveness" - } - }, - "additionalProperties": false - }, "GsaRangeFixedWidthHistogramAggregationDatumCriterion": { "type": "object", "allOf": [ @@ -117087,7 +81169,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeFixedWidthHistogram'", + "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeFixedWidthHistogram'", "x-discriminator-value": "rangeFixedWidthHistogram", "x-discriminator-name": "type" }, @@ -117132,7 +81214,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphValue](#model-GsaGraphValue)\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaGraphValue\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "graphValueType" }, @@ -117152,7 +81234,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'rangeHistogram'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'rangeHistogram'", "x-discriminator-value": "rangeHistogram", "x-discriminator-name": "datumType" }, @@ -117173,7 +81255,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeHistogram'", + "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeHistogram'", "x-discriminator-value": "rangeHistogram", "x-discriminator-name": "type" }, @@ -117201,7 +81283,7 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestor'", + "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestor'", "x-discriminator-value": "recordAncestor", "x-discriminator-name": "type" }, @@ -117229,18 +81311,47 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor history GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestorHistory'", + "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor history GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestorHistory'", "x-discriminator-value": "recordAncestorHistory", "x-discriminator-name": "type" }, - "GsaRecordAndAttributeSelectionType": { - "enum": [ - "Profile", - "AllAttributes", - "AllAttributesAndRecords" + "GsaRecordCapabilities": { + "required": [ + "canDelete", + "canGetModifiableVersion", + "canModify", + "canRelease", + "canWithdraw", + "canWrite" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • Profile: The original type of selection - attributes and records are retrieved from the selected profile. If no profile is selected, then no attributes or records are selected.
    • \r\n
  • AllAttributes: All attributes in the database are selected.
    • \r\n
  • AllAttributesAndRecords: All attributes and records in the database are selected.
    • \r\n
\r\n" + "type": "object", + "properties": { + "canWrite": { + "type": "boolean", + "description": "True if the current user has write permission for this record version, and is in write mode.\r\nWrite permission is required to edit record properties, and to perform version control actions." + }, + "canModify": { + "type": "boolean", + "description": "True if the current user can modify this record version, e.g. edit record properties.\r\nThe user needs write permission, and if the table is version controlled, the record must be unreleased." + }, + "canRelease": { + "type": "boolean", + "description": "True if the current user can release this record version." + }, + "canGetModifiableVersion": { + "type": "boolean", + "description": "True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists)." + }, + "canWithdraw": { + "type": "boolean", + "description": "True if the current user can withdraw this record version." + }, + "canDelete": { + "type": "boolean", + "description": "True if the current user can delete this record version." + } + }, + "additionalProperties": false }, "GsaRecordColor": { "enum": [ @@ -117280,7 +81391,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordColor'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordColor'", "x-discriminator-value": "recordColor", "x-discriminator-name": "propertyName" }, @@ -117306,7 +81417,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'record'", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'record'", "x-discriminator-value": "record", "x-discriminator-name": "type" }, @@ -117327,7 +81438,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordGuid'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordGuid'", "x-discriminator-value": "recordGuid", "x-discriminator-name": "propertyName" }, @@ -117377,79 +81488,18 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "recordHistoryGuid": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaErrorDetailOfRecordHistoryErrorReason" + "$ref": "#/components/schemas/GsaErrorDetail" }, "nullable": true } }, "additionalProperties": false }, - "GsaRecordHistoryDescendantsAccessControlEntity": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlEntity" - }, - { - "required": [ - "recordHistoryGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "subsetGuid": { - "type": "string", - "description": "Optional.\r\nIf set, only include descendants in this subset", - "format": "uuid", - "nullable": true - }, - "latestVersionFilter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaVersionControlMode" - }, - "description": "Optional.\r\nIf set, only include descendants that match this filter. For each descendant record history:\r\n - read: include only the record version that is the latest version in read mode.\r\n - write: include only the record version that is the latest version in write mode.\r\n - read and write: include the record versions that are the latest versions in read or write mode.\r\n - empty: include record versions that are not the latest version in read or write mode.\r\nIf not set, include all versions of all descendant record histories.", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "To include the descendants of a record history.\r\nThis will not include the record history itself.\r\n\r\nThis extends: [GsaAccessControlEntity](#model-GsaAccessControlEntity)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'recordHistoryDescendants'", - "x-discriminator-value": "recordHistoryDescendants", - "x-discriminator-name": "entityType" - }, - "GsaRecordHistoryErrorReason": { - "enum": [ - "NoName", - "NoShortName", - "ParentNotInSameTable", - "ParentNotAFolder", - "ParentIsADescendant", - "ParentIsItself", - "ParentIsWithdrawn", - "ShortNameExistsInFolder" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • NoName: Record history must have a name.
    • \r\n
  • NoShortName: Record history must have a tree name.
    • \r\n
  • ParentNotInSameTable: New parent record history is not in the same table.
    • \r\n
  • ParentNotAFolder: New parent record history is not a folder.
    • \r\n
  • ParentIsADescendant: New parent record history is a descendant so will cause a circular reference.
    • \r\n
  • ParentIsItself: Record history cannot be set as the parent of itself.
    • \r\n
  • ParentIsWithdrawn: New parent record history is withdrawn or has a withdrawn ancestor.
    • \r\n
  • ShortNameExistsInFolder: A record with the short name already exists in the parent folder.
    • \r\n
\r\n" - }, "GsaRecordHistoryGuidProperty": { "type": "object", "allOf": [ @@ -117467,293 +81517,11 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordHistoryGuid'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordHistoryGuid'", "x-discriminator-value": "recordHistoryGuid", "x-discriminator-name": "propertyName" - }, - "GsaRecordHistoryMoveException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaErrorDetailOfRecordHistoryErrorReason" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaRecordHistoryReference": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordReference" - }, - { - "type": "object", - "properties": { - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "The unique way to identify a record history (which may have multiple versions) in an MI system\r\n\r\nThis extends: [GsaRecordReference](#model-GsaRecordReference)\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'history'", - "x-discriminator-value": "history", - "x-discriminator-name": "recordReferenceType" - }, - "GsaRecordLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" - }, - { - "required": [ - "includeIndirectLinks" - ], - "type": "object", - "properties": { - "includeIndirectLinks": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordLink'", - "x-discriminator-value": "recordLink", - "x-discriminator-name": "type" - }, - "GsaRecordLinkBase": { - "required": [ - "guid", - "recordLinkGroupType", - "sourceRecordHistoryGuid", - "targetRecordHistoryGuid" - ], - "type": "object", - "properties": { - "recordLinkGroupType": { - "$ref": "#/components/schemas/GsaRecordLinkGroupType" - }, - "sourceRecordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "targetRecordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "notes": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "A record Link\r\n\r\nThis is one of: \r\n * [GsaStaticRecordLink](#model-GsaStaticRecordLink)\r\n * [GsaCrossDatabaseRecordLink](#model-GsaCrossDatabaseRecordLink)", - "discriminator": { - "propertyName": "recordLinkGroupType", - "mapping": { - "static": "#/components/schemas/GsaStaticRecordLink", - "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLink" - } - } - }, - "GsaRecordLinkCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "linkGroupGuid" - ], - "type": "object", - "properties": { - "forwards": { - "type": "boolean", - "nullable": true - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'recordLink'", - "x-discriminator-value": "recordLink", - "x-discriminator-name": "itemType" - }, - "GsaRecordLinkGroup": { - "required": [ - "displayNames", - "guid", - "linkInfo", - "name", - "reverseName", - "type" - ], - "type": "object", - "properties": { - "linkInfo": { - "$ref": "#/components/schemas/GsaLinkInfo" - }, - "identity": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "type": { - "$ref": "#/components/schemas/GsaRecordLinkGroupType" - }, - "reverseName": { - "type": "string" - }, - "reverseDisplayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaStaticRecordLinkGroup](#model-GsaStaticRecordLinkGroup)\r\n * [GsaSmartRecordLinkGroup](#model-GsaSmartRecordLinkGroup)\r\n * [GsaCrossDatabaseRecordLinkGroup](#model-GsaCrossDatabaseRecordLinkGroup)", - "discriminator": { - "propertyName": "type", - "mapping": { - "static": "#/components/schemas/GsaStaticRecordLinkGroup", - "smart": "#/components/schemas/GsaSmartRecordLinkGroup", - "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLinkGroup" - } - } - }, - "GsaRecordLinkGroupCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaRecordLinkGroupErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaForbidOrphansRecordLinkGroupErrorDetail](#model-GsaForbidOrphansRecordLinkGroupErrorDetail)\r\n * [GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail](#model-GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail)\r\n * [GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail](#model-GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail)\r\n * [GsaNamedEntityRecordLinkGroupErrorDetail](#model-GsaNamedEntityRecordLinkGroupErrorDetail)\r\n * [GsaNameSameAsReverseNameRecordLinkGroupErrorDetail](#model-GsaNameSameAsReverseNameRecordLinkGroupErrorDetail)\r\n * [GsaNoSuchTargetTableRecordLinkGroupErrorDetail](#model-GsaNoSuchTargetTableRecordLinkGroupErrorDetail)\r\n * [GsaReferentialIntegrityModelRecordLinkGroupErrorDetail](#model-GsaReferentialIntegrityModelRecordLinkGroupErrorDetail)\r\n * [GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail](#model-GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail)\r\n * [GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail](#model-GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail)\r\n * [GsaReverseNameNotProvidedRecordLinkGroupErrorDetail](#model-GsaReverseNameNotProvidedRecordLinkGroupErrorDetail)\r\n * [GsaSmartAttributesRecordLinkGroupErrorDetail](#model-GsaSmartAttributesRecordLinkGroupErrorDetail)\r\n * [GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail](#model-GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "forbidOrphans": "#/components/schemas/GsaForbidOrphansRecordLinkGroupErrorDetail", - "manyToManyForbidOrphans": "#/components/schemas/GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", - "nameAlreadyExistsAsReverse": "#/components/schemas/GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityRecordLinkGroupErrorDetail", - "nameSameAsReverseName": "#/components/schemas/GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "noSuchTargetTable": "#/components/schemas/GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "referentialIntegrityModel": "#/components/schemas/GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "reverseNameAlreadyExists": "#/components/schemas/GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "reverseNameAlreadyExistsAsName": "#/components/schemas/GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "reverseNameNotProvided": "#/components/schemas/GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", - "smartAttributes": "#/components/schemas/GsaSmartAttributesRecordLinkGroupErrorDetail", - "swapNameAndReverseNameCircular": "#/components/schemas/GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail" - } - } - }, - "GsaRecordLinkGroupErrorReason": { - "enum": [ - "forbidOrphans", - "manyToManyForbidOrphans", - "nameAlreadyExistsAsReverse", - "namedEntity", - "nameSameAsReverseName", - "noSuchTargetTable", - "referentialIntegrityModel", - "reverseNameAlreadyExists", - "reverseNameAlreadyExistsAsName", - "reverseNameNotProvided", - "smartAttributes", - "swapNameAndReverseNameCircular" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • forbidOrphans: To set forbid orphans, all records in the target table must be linked to a record in the source table.
    • \r\n
  • manyToManyForbidOrphans: The Many to Many model cannot forbid orphans.
    • \r\n
  • nameAlreadyExistsAsReverse: The name matches the reverse name of a record link group targeting this table.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • nameSameAsReverseName: Record link group name and reverse name cannot be the same.
    • \r\n
  • noSuchTargetTable: Target table not found.
    • \r\n
  • referentialIntegrityModel: The ReferentialIntegrityModel cannot be set due to existing links.
    • \r\n
  • reverseNameAlreadyExists: Record link group with reverse name already exists targeting this target table.
    • \r\n
  • reverseNameAlreadyExistsAsName: The reverse name matches the name of a record link group from the target table.
    • \r\n
  • reverseNameNotProvided: Record link group must have a reverse name.
    • \r\n
  • smartAttributes: The attributes used as linking attribute pairs for a smart link group are not valid.
    • \r\n
  • swapNameAndReverseNameCircular: Cannot swap name and reverse name when the source and target table are the same.
    • \r\n
\r\n" - }, - "GsaRecordLinkGroupType": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - }, - "GsaRecordLinkGroupUpdateException": { - "required": [ - "recordLinkGroupGuid" - ], + }, + "GsaRecordHistoryMoveException": { "type": "object", "properties": { "message": { @@ -117761,75 +81529,115 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "recordLinkGroupGuid": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "$ref": "#/components/schemas/GsaErrorDetail" }, "nullable": true } }, "additionalProperties": false }, - "GsaRecordLinkGroupsInfo": { + "GsaRecordHistoryReference": { "type": "object", - "properties": { - "recordLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" - }, - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/GsaRecordReference" + }, + { + "type": "object", + "properties": { + "recordHistoryGuid": { + "type": "string", + "format": "uuid" + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "The unique way to identify a record history (which may have multiple versions) in an MI system\r\n\r\nThis extends: GsaRecordReference\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'history'", + "x-discriminator-value": "history", + "x-discriminator-name": "recordReferenceType" }, - "GsaRecordLinkResult": { + "GsaRecordLinkGroup": { "required": [ - "linkedRecord", - "recordLinkGroupType" + "displayNames", + "guid", + "linkInfo", + "name", + "reverseName", + "type" ], "type": "object", "properties": { - "recordLinkGroupType": { + "linkInfo": { + "$ref": "#/components/schemas/GsaLinkInfo" + }, + "identity": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "type": { "$ref": "#/components/schemas/GsaRecordLinkGroupType" }, - "linkedRecord": { - "$ref": "#/components/schemas/GsaSlimRecordVersion" + "reverseName": { + "type": "string" + }, + "reverseDisplayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "nullable": true + }, + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + } + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false, - "description": "A record link result\r\n\r\nThis is one of: \r\n * [GsaStaticRecordLinkResult](#model-GsaStaticRecordLinkResult)\r\n * [GsaSmartRecordLinkResult](#model-GsaSmartRecordLinkResult)\r\n * [GsaCrossDatabaseRecordLinkResult](#model-GsaCrossDatabaseRecordLinkResult)", + "description": "\r\n\r\nThis is one of: \r\n * GsaStaticRecordLinkGroup\r\n * GsaDynamicRecordLinkGroup\r\n * GsaCrossDatabaseRecordLinkGroup", "discriminator": { - "propertyName": "recordLinkGroupType", + "propertyName": "type", "mapping": { - "static": "#/components/schemas/GsaStaticRecordLinkResult", - "smart": "#/components/schemas/GsaSmartRecordLinkResult", - "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLinkResult" + "static": "#/components/schemas/GsaStaticRecordLinkGroup", + "dynamic": "#/components/schemas/GsaDynamicRecordLinkGroup", + "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLinkGroup" } } }, - "GsaRecordLinkResults": { - "required": [ - "recordLinkGroup", - "results" + "GsaRecordLinkGroupType": { + "enum": [ + "static", + "dynamic", + "crossDatabase" ], + "type": "string" + }, + "GsaRecordLinkGroupsInfo": { "type": "object", "properties": { - "recordLinkGroup": { - "$ref": "#/components/schemas/GsaSlimRecordLinkGroup" - }, - "results": { + "recordLinkGroups": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaRecordLinkResult" - } + "$ref": "#/components/schemas/GsaSlimRecordLinkGroup" + }, + "nullable": true } }, "additionalProperties": false @@ -117968,7 +81776,7 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records contained within at least one of the referenced record lists.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordListMember'", + "description": "Criterion that returns records contained within at least one of the referenced record lists.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordListMember'", "x-discriminator-value": "recordListMember", "x-discriminator-name": "type" }, @@ -118081,7 +81889,7 @@ } ], "additionalProperties": false, - "description": "recordList: Search criterion for a set of record lists.\r\n \r\nThe properties in the this class represent an AND search - only lists that match all of the non-null properties will be returned\r\n\r\nThis extends: [GsaListCriterion](#model-GsaListCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordList'", + "description": "recordList: Search criterion for a set of record lists.\r\n \r\nThe properties in the this class represent an AND search - only lists that match all of the non-null properties will be returned\r\n\r\nThis extends: GsaListCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordList'", "x-discriminator-value": "recordList", "x-discriminator-name": "type" }, @@ -118166,7 +81974,6 @@ "versionState", "versionNumber", "releasedDate", - "breadcrumbs", "fullName", "shortName", "recordColor" @@ -118196,7 +82003,7 @@ } ], "additionalProperties": false, - "description": "Criterion for a search matching values in a given record property.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", + "description": "Criterion for a search matching values in a given record property.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", "x-discriminator-value": "recordProperty", "x-discriminator-name": "type" }, @@ -118228,7 +82035,7 @@ } ], "additionalProperties": false, - "description": "Specifies a record property based sort criterion for a search query.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: [GsaSortCriterion](#model-GsaSortCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", + "description": "Specifies a record property based sort criterion for a search query.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: GsaSortCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", "x-discriminator-value": "recordProperty", "x-discriminator-name": "type" }, @@ -118247,7 +82054,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaRecordHistoryReference](#model-GsaRecordHistoryReference)\r\n * [GsaRecordVersionReference](#model-GsaRecordVersionReference)", + "description": "\r\n\r\nThis is one of: \r\n * GsaRecordHistoryReference\r\n * GsaRecordVersionReference", "discriminator": { "propertyName": "recordReferenceType", "mapping": { @@ -118271,37 +82078,21 @@ "databaseKey": { "type": "string" }, - "recordGuid": { + "recordHistoryGuid": { "type": "string", "format": "uuid", "nullable": true }, - "recordHistoryGuid": { + "recordGuid": { "type": "string", "format": "uuid", "nullable": true - }, - "anyRecordHistoryGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "anyRecordGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true } } } ], "additionalProperties": false, - "description": "Criterion that returns records matching a specific reference. The database key must be provided, plus at least one guid\r\nThis can be a single record version GUID or record history GUID, or an array of either which will match on any of the GUIDS\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'reference'", + "description": "Criterion that returns records matching a specific reference. The database key must be provided, along with the record GUID.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'reference'", "x-discriminator-value": "reference", "x-discriminator-name": "type" }, @@ -118335,7 +82126,7 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records matching a specific subset. The database key must be provided, along with either the subset GUID or the subset identity.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'subset'", + "description": "Criterion that returns records matching a specific subset. The database key must be provided, along with either the subset GUID or the subset identity.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'subset'", "x-discriminator-value": "subset", "x-discriminator-name": "type" }, @@ -118348,19 +82139,6 @@ "type": "string", "description": "An API-level enum for the supported record types." }, - "GsaRecordTypeCriterion": { - "type": "object", - "properties": { - "recordTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordType" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaRecordTypeProperty": { "type": "object", "allOf": [ @@ -118377,50 +82155,13 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordType'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordType'", "x-discriminator-value": "recordType", "x-discriminator-name": "propertyName" }, - "GsaRecordUserCapabilities": { - "required": [ - "canDelete", - "canGetModifiableVersion", - "canModify", - "canRelease", - "canWithdraw", - "canWrite" - ], - "type": "object", - "properties": { - "canWrite": { - "type": "boolean", - "description": "True if the current user has write permission for this record version, and is in write mode.\r\nWrite permission is required to edit record properties, and to perform version control actions." - }, - "canModify": { - "type": "boolean", - "description": "True if the current user can modify this record version, e.g. edit record properties.\r\nThe user needs write permission, and if the table is version controlled, the record must be unreleased." - }, - "canRelease": { - "type": "boolean", - "description": "True if the current user can release this record version." - }, - "canGetModifiableVersion": { - "type": "boolean", - "description": "True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists)." - }, - "canWithdraw": { - "type": "boolean", - "description": "True if the current user can withdraw this record version." - }, - "canDelete": { - "type": "boolean", - "description": "True if the current user can delete this record version." - } - }, - "additionalProperties": false - }, "GsaRecordVersion": { "required": [ + "capabilities", "createdByUser", "createdDate", "databaseKey", @@ -118433,7 +82174,6 @@ "recordType", "shortName", "table", - "userCapabilities", "versionNumber", "versionState" ], @@ -118476,8 +82216,8 @@ "recordColor": { "$ref": "#/components/schemas/GsaRecordColor" }, - "userCapabilities": { - "$ref": "#/components/schemas/GsaRecordUserCapabilities" + "capabilities": { + "$ref": "#/components/schemas/GsaRecordCapabilities" }, "versionNumber": { "type": "integer", @@ -118496,40 +82236,6 @@ }, "additionalProperties": false }, - "GsaRecordVersionAccessControlEntity": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlEntity" - }, - { - "required": [ - "recordHistoryGuid", - "recordVersionGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "recordVersionGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlEntity](#model-GsaAccessControlEntity)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'recordVersion'", - "x-discriminator-value": "recordVersion", - "x-discriminator-name": "entityType" - }, "GsaRecordVersionReference": { "type": "object", "allOf": [ @@ -118550,7 +82256,7 @@ } ], "additionalProperties": false, - "description": "The unique way to identify a record version in an MI system\r\n\r\nThis extends: [GsaRecordReference](#model-GsaRecordReference)\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'version'", + "description": "The unique way to identify a record version in an MI system\r\n\r\nThis extends: GsaRecordReference\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'version'", "x-discriminator-value": "version", "x-discriminator-name": "recordReferenceType" }, @@ -118593,22 +82299,14 @@ "enum": [ "expression", "versionControlledData", - "smartLinkGroup", + "dynamicLinkGroup", "tabularAttribute", "xyChartTemplate", "searchMask", "securityAttribute", "attribute", "data", - "defaultParameterValue", - "functionalDataDefault", - "multiValuedPointData", - "tabularColumn", - "databaseCurrencyUnit", - "unit", - "parameter", - "constant", - "table" + "defaultParameterValue" ], "type": "string" }, @@ -118620,37 +82318,6 @@ ], "type": "string" }, - "GsaReferentialIntegrityModelRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "The ReferentialIntegrityModel cannot be set due to existing links.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'referentialIntegrityModel'", - "x-discriminator-value": "referentialIntegrityModel", - "x-discriminator-name": "reason" - }, - "GsaRegisterUpdateRequest": { - "required": [ - "applyOptions", - "header" - ], - "type": "object", - "properties": { - "header": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" - }, - "applyOptions": { - "$ref": "#/components/schemas/GsaApplyOptions" - } - }, - "additionalProperties": false - }, "GsaReleaseRecordVersionControlException": { "type": "object", "properties": { @@ -118659,11 +82326,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "recordVersionGuid": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -118683,11 +82346,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "tableGuid": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -118717,566 +82376,212 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'releasedDate'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'releasedDate'", "x-discriminator-value": "releasedDate", "x-discriminator-name": "propertyName" }, "GsaRelevanceSortCriterion": { "type": "object", "allOf": [ - { - "$ref": "#/components/schemas/GsaSortCriterion" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Specifies a relevance based sort criterion for a search query\r\n\r\nThis extends: [GsaSortCriterion](#model-GsaSortCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'relevance'", - "x-discriminator-value": "relevance", - "x-discriminator-name": "type" - }, - "GsaRemoveRecordHistoryFromSubset": { - "required": [ - "recordHistoryGuid" - ], - "type": "object", - "properties": { - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaReorderSectionsInfo": { - "required": [ - "layoutSections" - ], - "type": "object", - "properties": { - "layoutSections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - }, - "additionalProperties": false - }, - "GsaReorderTablesErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaReorderTablesErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaTablesMissingReorderTablesErrorDetail](#model-GsaTablesMissingReorderTablesErrorDetail)\r\n * [GsaNoSuchTablesReorderTablesErrorDetail](#model-GsaNoSuchTablesReorderTablesErrorDetail)\r\n * [GsaDuplicateTablesReorderTablesErrorDetail](#model-GsaDuplicateTablesReorderTablesErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "tablesMissing": "#/components/schemas/GsaTablesMissingReorderTablesErrorDetail", - "noSuchTables": "#/components/schemas/GsaNoSuchTablesReorderTablesErrorDetail", - "duplicateTables": "#/components/schemas/GsaDuplicateTablesReorderTablesErrorDetail" - } - } - }, - "GsaReorderTablesErrorReason": { - "enum": [ - "tablesMissing", - "noSuchTables", - "duplicateTables" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • tablesMissing: One or more tables are missing.
    • \r\n
  • noSuchTables: One or more tables specified for re-ordering do not exist in the database.
    • \r\n
  • duplicateTables: Duplicate tables were specified.
    • \r\n
\r\n" - }, - "GsaReorderTablesException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "databaseKey": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaReorderTablesErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaReorderTablesRequest": { - "required": [ - "tables" - ], - "type": "object", - "properties": { - "tables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - }, - "additionalProperties": false - }, - "GsaReplaceDiscreteValuesException": { - "required": [ - "discreteTypeGuid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "discreteTypeGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValueErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaReplacePermissionCategoriesRequest": { - "required": [ - "categories" - ], - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutPermissionCategory" - }, - "description": "This can result in adding, modifying and deleting permission categories.\r\nTo insert a new category, use a [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory).\r\nTo modify an existing category, use a [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory).\r\nExisting categories will be matched by GUID.\r\nIf an existing category is not included, it will be deleted." - } - }, - "additionalProperties": false - }, - "GsaReplacePermissionCategoryErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail](#model-GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail)\r\n * [GsaCategoryReplacePermissionCategoryErrorDetail](#model-GsaCategoryReplacePermissionCategoryErrorDetail)\r\n * [GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail](#model-GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail)\r\n * [GsaTooManyPermissionsReplacePermissionCategoryErrorDetail](#model-GsaTooManyPermissionsReplacePermissionCategoryErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "duplicateCategories": "#/components/schemas/GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "category": "#/components/schemas/GsaCategoryReplacePermissionCategoryErrorDetail", - "noSuchCategories": "#/components/schemas/GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "tooManyPermissions": "#/components/schemas/GsaTooManyPermissionsReplacePermissionCategoryErrorDetail" - } - } - }, - "GsaReplacePermissionCategoryErrorReason": { - "enum": [ - "duplicateCategories", - "category", - "noSuchCategories", - "tooManyPermissions" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • duplicateCategories: Duplicate categories were specified, either by name or GUID.
    • \r\n
  • category: The category is not valid.
    • \r\n
  • noSuchCategories: One or more permission categories specified for update could not be found.
    • \r\n
  • tooManyPermissions: The new permissions cannot be added, there are not enough permissions available. A schema for a database may have up to 128 permissions. This is the total number of permissions that have ever existed in the schema
    • \r\n
\r\n" - }, - "GsaReplacementString": { - "required": [ - "guid", - "name", - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "A piece of text that can be inserted into a data value so that multiple data can be changed in one place." - }, - "GsaReplacementStringsInfo": { - "required": [ - "replacementStrings" - ], - "type": "object", - "properties": { - "replacementStrings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimReplacementString" - } - } - }, - "additionalProperties": false - }, - "GsaResolveLinkTargetsInfo": { - "required": [ - "resolvedLinkTargets" - ], - "type": "object", - "properties": { - "resolvedLinkTargets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaResolvedLinkTarget" - } - } - }, - "additionalProperties": false - }, - "GsaResolveLinkTargetsRequest": { - "required": [ - "linkTargets" - ], - "type": "object", - "properties": { - "linkTargets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLinkTarget" - } - } - }, - "additionalProperties": false - }, - "GsaResolvedBreadcrumb": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaBreadcrumb" - }, - { - "required": [ - "name", - "recordGuid", - "recordHistoryGuid" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "recordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "recordGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaBreadcrumb](#model-GsaBreadcrumb)\r\n\r\nThe value of discriminator property ('breadcrumbType') must be equal to 'resolved'", - "x-discriminator-value": "resolved", - "x-discriminator-name": "breadcrumbType" - }, - "GsaResolvedLinkTarget": { - "required": [ - "linkTarget", - "tables" - ], - "type": "object", - "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaLinkTarget" - }, - "tables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimTable" - } - } - }, - "additionalProperties": false - }, - "GsaResolvedTargetAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTargetAttribute" - }, - { - "required": [ - "attributeType", - "displayNames", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - } - }, - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "aboutAttribute": { - "$ref": "#/components/schemas/GsaSlimTypedAttribute" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTargetAttribute](#model-GsaTargetAttribute)\r\n\r\nThe value of discriminator property ('targetType') must be equal to 'resolved'", - "x-discriminator-value": "resolved", - "x-discriminator-name": "targetType" - }, - "GsaResponseOptions": { - "type": "object", - "properties": { - "includeUserActions": { - "type": "boolean" - }, - "includeUserPermissions": { - "type": "boolean" + { + "$ref": "#/components/schemas/GsaSortCriterion" }, - "includeRecordListItems": { - "type": "boolean" + { + "type": "object" } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "Specifies a relevance based sort criterion for a search query\r\n\r\nThis extends: GsaSortCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'relevance'", + "x-discriminator-value": "relevance", + "x-discriminator-name": "type" }, - "GsaResubmitJobRequest": { + "GsaRemoveRecordHistoryFromSubset": { + "required": [ + "recordHistoryGuid" + ], "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "scheduledExecutionDate": { + "recordHistoryGuid": { "type": "string", - "format": "date-time", - "nullable": true + "format": "uuid" } }, "additionalProperties": false }, - "GsaRetargetPotentialRequest": { + "GsaReorderSectionsInfo": { "required": [ - "targetDatabaseKeys" + "layoutSections" ], "type": "object", "properties": { - "targetDatabaseKeys": { + "layoutSections": { "type": "array", "items": { - "type": "string" - }, - "description": "List of database keys to check for retargeting potential." + "$ref": "#/components/schemas/GsaSlimEntity" + } } }, - "additionalProperties": false, - "description": "Request to get databases with retarget potential - whether there are any cross-database tabular attributes that target them." + "additionalProperties": false }, - "GsaRetargetRequest": { + "GsaReplacementString": { "required": [ - "newTargetDatabaseKey", - "previousTargetDatabaseKey" + "guid", + "name", + "value" ], "type": "object", "properties": { - "previousTargetDatabaseKey": { - "type": "string", - "description": "Database key that the tabular attributes were targeting before the operation." + "value": { + "type": "string" + }, + "name": { + "type": "string" }, - "newTargetDatabaseKey": { + "guid": { "type": "string", - "description": "Database key that the tabular attributes will target after the operation." + "format": "uuid" } }, "additionalProperties": false, - "description": "Request to retarget tabular attributes from one database to another." + "description": "A piece of text that can be inserted into a data value so that multiple data can be changed in one place." }, - "GsaRetargetResult": { + "GsaReplacementStringsInfo": { "required": [ - "attributeName", - "result", - "sourceDatabaseKey", - "tableName" + "replacementStrings" ], "type": "object", "properties": { - "sourceDatabaseKey": { - "type": "string", - "description": "Database key of the source database - the one holding the tabular attribute that was retargeted." + "replacementStrings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimReplacementString" + } + } + }, + "additionalProperties": false + }, + "GsaResolvedLink": { + "required": [ + "displayNames", + "guid", + "linkInfo", + "name", + "reverseName", + "type" + ], + "type": "object", + "properties": { + "identity": { + "type": "integer", + "format": "int32", + "nullable": true }, - "tableName": { - "type": "string", - "description": "Table name of the source table - the one holding the tabular attribute that was retargeted." + "type": { + "$ref": "#/components/schemas/GsaLinkAttributeType" }, - "attributeName": { - "type": "string", - "description": "Name of the tabular attribute that was retargeted." + "reverseName": { + "type": "string" }, - "targetDatabaseKey": { - "type": "string", - "description": "Database key of the target database of the retargeted tabular attribute if the retarget was successful.\r\nOtherwise, Null if the retarget was not successful.", + "reverseDisplayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, "nullable": true }, - "targetTableName": { - "type": "string", - "description": "Table name of the target table of the retargeted tabular attribute if the retarget was successful.\r\nOtherwise, Null if the retarget was not successful.", - "nullable": true + "linkInfo": { + "$ref": "#/components/schemas/GsaResolvedLinkInfo" + }, + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + } + }, + "name": { + "type": "string" }, - "result": { - "$ref": "#/components/schemas/GsaRetargetResultType" + "guid": { + "type": "string", + "format": "uuid" } }, - "additionalProperties": false, - "description": "Result of a retargeting operation.\r\n\r\nresult: Result type of the retargeting operation." - }, - "GsaRetargetResultType": { - "enum": [ - "success", - "tableNotFound", - "linkingAttributeNotFound", - "columnMissing", - "missingAdminPermissions" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • success: Success.
    • \r\n
  • tableNotFound: Target table could not be found.
    • \r\n
  • linkingAttributeNotFound: Linking attribute could not be found.
    • \r\n
  • columnMissing: Column missing.
    • \r\n
  • missingAdminPermissions: User does not have admin permissions to the database.
    • \r\n
\r\n" + "additionalProperties": false }, - "GsaRetargetResultsInfo": { + "GsaResolvedLinkInfo": { "required": [ - "results" + "linkSource", + "linkTarget" ], "type": "object", "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRetargetResult" - } + "linkSource": { + "$ref": "#/components/schemas/GsaResolvedLinkTarget" + }, + "linkTarget": { + "$ref": "#/components/schemas/GsaResolvedLinkTarget" } }, "additionalProperties": false }, - "GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail": { + "GsaResolvedLinkTarget": { + "required": [ + "databaseGuid", + "databaseVersionGuid", + "tableGuid" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "properties": { + "databaseGuid": { + "type": "string", + "format": "uuid" }, - { - "required": [ - "reverseName", - "targetTableGuid" - ], - "type": "object", - "properties": { - "reverseName": { - "type": "string" - }, - "targetTableGuid": { - "type": "string", - "format": "uuid" - } - } + "databaseVersionGuid": { + "type": "string", + "format": "uuid" + }, + "tableGuid": { + "type": "string", + "format": "uuid" } - ], - "additionalProperties": false, - "description": "The reverse name matches the name of a record link group from the target table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'reverseNameAlreadyExistsAsName'", - "x-discriminator-value": "reverseNameAlreadyExistsAsName", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail": { + "GsaResponseOptions": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "properties": { + "includeUserActions": { + "type": "boolean" }, - { - "required": [ - "reverseName", - "targetTableGuid" - ], - "type": "object", - "properties": { - "reverseName": { - "type": "string" - }, - "targetTableGuid": { - "type": "string", - "format": "uuid" - } - } + "includeUserPermissions": { + "type": "boolean" + }, + "includeRecordListItems": { + "type": "boolean" } - ], - "additionalProperties": false, - "description": "Record link group with reverse name already exists targeting this target table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'reverseNameAlreadyExists'", - "x-discriminator-value": "reverseNameAlreadyExists", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaReverseNameNotProvidedRecordLinkGroupErrorDetail": { + "GsaResubmitJobRequest": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "properties": { + "name": { + "type": "string", + "nullable": true }, - { - "type": "object" + "description": { + "type": "string", + "nullable": true + }, + "scheduledExecutionDate": { + "type": "string", + "format": "date-time", + "nullable": true } - ], - "additionalProperties": false, - "description": "Record link group must have a reverse name.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'reverseNameNotProvided'", - "x-discriminator-value": "reverseNameNotProvided", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, "GsaRichTextType": { "enum": [ @@ -119302,21 +82607,6 @@ }, "additionalProperties": false }, - "GsaRoleNotProvidedPermissionErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Role must be provided, and cannot be empty or whitespace.\r\n\r\nThis extends: [GsaPermissionErrorDetail](#model-GsaPermissionErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'roleNotProvided'", - "x-discriminator-value": "roleNotProvided", - "x-discriminator-name": "reason" - }, "GsaRollupExportFailure": { "type": "object", "allOf": [ @@ -119336,7 +82626,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'rollup'", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'rollup'", "x-discriminator-value": "rollup", "x-discriminator-name": "type" }, @@ -119384,122 +82674,19 @@ }, "additionalProperties": false }, - "GsaRootFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "You cannot move the root folder.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'root'", - "x-discriminator-value": "root", - "x-discriminator-name": "reason" - }, - "GsaRootRecordNotAvailableToRenameErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "required": [ - "tableName" - ], - "type": "object", - "properties": { - "tableName": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'rootRecordNotAvailableToRename'", - "x-discriminator-value": "rootRecordNotAvailableToRename", - "x-discriminator-name": "reason" - }, - "GsaRuleEngine": { - "required": [ - "fullyQualifiedTypeName", - "name" - ], + "GsaSaveSearchRequest": { "type": "object", "properties": { - "name": { + "searchConfig": { "type": "string", - "description": "The name of the rule engine." + "nullable": true }, - "fullyQualifiedTypeName": { - "type": "string", - "description": "The fully qualified name of the rule engine implementation." + "detail": { + "$ref": "#/components/schemas/GsaSearchDetail" } }, "additionalProperties": false }, - "GsaSameParentFileMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "newParentFolderGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Unable to move file as it is already under this folder.\r\n\r\nThis extends: [GsaFileMoveErrorDetail](#model-GsaFileMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'sameParent'", - "x-discriminator-value": "sameParent", - "x-discriminator-name": "reason" - }, - "GsaSameParentFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "newParentFolderGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Unable to move folder as it is already under this folder.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'sameParent'", - "x-discriminator-value": "sameParent", - "x-discriminator-name": "reason" - }, - "GsaSchemaGenerationWarningReason": { - "enum": [ - "unknown", - "standardNameNotFound", - "hasAttributeAndLinkSources", - "inconsistentLinkToTargetDatabase", - "missingTargetDatabase", - "inconsistentLinkToTargetTable", - "inconsistentAttributeTypes", - "inconsistentDiscreteTypes", - "inconsistentUnits", - "parametersNotFound", - "inconsistentSourceTables", - "inconsistentInterpolationMethods", - "inconsistentScaleTypes" - ], - "type": "string" - }, "GsaSchemaTooNewAddDatabaseValidationIssue": { "type": "object", "allOf": [ @@ -119519,7 +82706,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooNew'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooNew'", "x-discriminator-value": "schemaTooNew", "x-discriminator-name": "IssueType" }, @@ -119542,7 +82729,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooOld'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooOld'", "x-discriminator-value": "schemaTooOld", "x-discriminator-name": "IssueType" }, @@ -119575,6 +82762,28 @@ }, "additionalProperties": false }, + "GsaSearchDetail": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "notes": { + "type": "string", + "nullable": true + }, + "criteria": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, "GsaSearchIndexStatus": { "type": "object", "properties": { @@ -119618,54 +82827,6 @@ }, "additionalProperties": false }, - "GsaSearchMask": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "nullable": true - }, - "recordProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordProperty" - }, - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSearchMaskInfo": { - "type": "object", - "properties": { - "searchMasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimSearchMask" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaSearchMaskUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -119686,7 +82847,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'searchMask'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'searchMask'", "x-discriminator-value": "searchMask", "x-discriminator-name": "referencedByType" }, @@ -119706,19 +82867,10 @@ }, "pagingOptions": { "$ref": "#/components/schemas/GsaPagingOptions" - }, - "tableSearchBehaviour": { - "$ref": "#/components/schemas/GsaTableSearchBehaviour" - }, - "findSimilarId": { - "type": "string", - "description": "An optional identifier of a find similar calculation to include in this search. Results will include a similarity score.", - "format": "uuid", - "nullable": true } }, "additionalProperties": false, - "description": "\r\n\r\ncriterion: The main search criterion.\r\n\r\npagingOptions: An optional field for paging options. If provided, the response will contain an identifier that can be used to retrieve the other pages.\r\n\r\ntableSearchBehaviour: Determines the behaviour of records in tables that are marked as hidden from search. The default behaviour is that these records are excluded." + "description": "\r\n\r\ncriterion: The main search criterion.\r\n\r\npagingOptions: An optional field for paging options. If provided, the response will contain an identifier that can be used to retrieve the other pages." }, "GsaSearchResponse": { "required": [ @@ -119807,11 +82959,6 @@ "format": "double", "nullable": true }, - "similarityScore": { - "type": "number", - "format": "double", - "nullable": true - }, "sortingValue": { "$ref": "#/components/schemas/GsaSortingValue" } @@ -119829,172 +82976,6 @@ }, "additionalProperties": false }, - "GsaSearchServiceStatus": { - "required": [ - "isRunning" - ], - "type": "object", - "properties": { - "isRunning": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaSearchTemplate": { - "required": [ - "guid", - "name", - "table" - ], - "type": "object", - "properties": { - "searchAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSearchTemplateAttributeItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSearchTemplateItem](#model-GsaSearchTemplateItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "itemType" - }, - "GsaSearchTemplateInfo": { - "type": "object", - "properties": { - "searchTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimSearchTemplate" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaSearchTemplateItem": { - "required": [ - "attribute", - "itemType" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaSearchTemplateItemType" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSearchTemplateAttributeItem](#model-GsaSearchTemplateAttributeItem)\r\n * [GsaSearchTemplateTabularColumnItem](#model-GsaSearchTemplateTabularColumnItem)\r\n * [GsaSearchTemplateLinkItem](#model-GsaSearchTemplateLinkItem)", - "discriminator": { - "propertyName": "itemType", - "mapping": { - "attribute": "#/components/schemas/GsaSearchTemplateAttributeItem", - "tabularColumn": "#/components/schemas/GsaSearchTemplateTabularColumnItem", - "link": "#/components/schemas/GsaSearchTemplateLinkItem" - } - } - }, - "GsaSearchTemplateItemType": { - "enum": [ - "attribute", - "tabularColumn", - "link" - ], - "type": "string" - }, - "GsaSearchTemplateLinkItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - { - "required": [ - "forwards", - "linkType", - "recordLinkGroup" - ], - "type": "object", - "properties": { - "recordLinkGroup": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "linkType": { - "$ref": "#/components/schemas/GsaRecordLinkGroupType" - }, - "targetDatabase": { - "type": "string", - "description": "May be null for a static link group, or a cross database link group that can target multiple databases", - "format": "uuid", - "nullable": true - }, - "forwards": { - "type": "boolean", - "description": "true if the link points from the table the template is in; or false if it points towards the table the template is in (an inbound link)." - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSearchTemplateItem](#model-GsaSearchTemplateItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "itemType" - }, - "GsaSearchTemplateTabularColumnItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - { - "required": [ - "tabularColumn" - ], - "type": "object", - "properties": { - "tabularColumn": { - "$ref": "#/components/schemas/GsaTabularColumn" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSearchTemplateItem](#model-GsaSearchTemplateItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'tabularColumn'", - "x-discriminator-value": "tabularColumn", - "x-discriminator-name": "itemType" - }, "GsaSearchableRecordProperty": { "enum": [ "createdDate", @@ -120015,6 +82996,27 @@ "type": "string", "description": "Properties of a record that can be used to in searches

Possible values:

\r\n
    \r\n
  • createdDate: The date a record was created.
    • \r\n
  • creator: The username of the person who created the record.
    • \r\n
  • lastModifiedDate: The date a record was last modified.
    • \r\n
  • lastModifier: The username of the person who last modified the record.
    • \r\n
  • recordType: Whether we return records, generics or folders (or a mixture).
    • \r\n
  • color: The color of the record.
    • \r\n
  • versionState: The version state of the records that will be returned. Only Released, Unreleased or Unversioned are supported.
    • \r\n
  • versionNumber: The version number of the record.
    • \r\n
  • recordName: The full name of the record.
    • \r\n
  • treeName: The name of the record as it is displayed in the tree.
    • \r\n
  • databaseKey: The database key of the record.
    • \r\n
  • tableName: The name of the table that the record is in.
    • \r\n
  • tableIdentity: The identity of the table that the record is in.
    • \r\n
  • tableGuid: The guid of the table that the record is in.
    • \r\n
\r\n" }, + "GsaSecurityAttributeGrouping": { + "type": "object", + "properties": { + "identity": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "availableDiscreteValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDiscreteValue" + }, + "nullable": true + } + }, + "additionalProperties": false + }, "GsaSecurityAttributeUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -120035,7 +83037,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'securityAttribute'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'securityAttribute'", "x-discriminator-value": "securityAttribute", "x-discriminator-name": "referencedByType" }, @@ -120056,152 +83058,57 @@ "additionalProperties": false, "description": "The security groups that apply to an integration schema. If null or empty, the default MI security groups will be used." }, - "GsaSelection": { + "GsaSelectionSearch": { "type": "object", "properties": { - "tableGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "attributeGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "recordGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "discreteTypeGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "parameterGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "layoutGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "subsetGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "standardNameGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "searchIdentifier": { + "type": "string", + "format": "uuid" }, - "recordLinkedGroupGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "name": { + "type": "string", "nullable": true }, - "unitGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "description": { + "type": "string", "nullable": true }, - "replacementStringGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "notes": { + "type": "string", "nullable": true }, - "constantGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" + "currentUserAccessInfo": { + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "type": "boolean" + }, + "nullable": true }, "nullable": true }, - "unitSystemGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "criteria": { + "type": "string", "nullable": true }, - "fileGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "exploreConfig": { + "type": "string", "nullable": true }, - "searchMaskGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "createdTimestamp": { + "type": "string", + "format": "date-time" }, - "searchTemplateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "createdUserOrGroup": { + "$ref": "#/components/schemas/GsaUserOrGroup" }, - "dynamicLinkGroupGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "lastModifiedTimestamp": { + "type": "string", + "format": "date-time" }, - "crossDatabaseLinkGroupGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "lastModifiedUserOrGroup": { + "$ref": "#/components/schemas/GsaUserOrGroup" } }, "additionalProperties": false @@ -120248,7 +83155,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraph](#model-GsaGraph)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'\r\n\r\nThis is one of: \r\n * [GsaFloatSeriesGraph](#model-GsaFloatSeriesGraph)\r\n * [GsaDiscreteSeriesGraph](#model-GsaDiscreteSeriesGraph)", + "description": "\r\n\r\nThis extends: GsaGraph\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'\r\n\r\nThis is one of: \r\n * GsaFloatSeriesGraph\r\n * GsaDiscreteSeriesGraph", "x-discriminator-value": "series", "x-discriminator-name": "graphType" }, @@ -120272,7 +83179,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'datetime'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'datetime'", "x-discriminator-value": "datetime", "x-discriminator-name": "setDatumType" }, @@ -120287,7 +83194,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSetIntegerDatum](#model-GsaSetIntegerDatum)\r\n * [GsaSetLogicalDatum](#model-GsaSetLogicalDatum)\r\n * [GsaSetShortTextDatum](#model-GsaSetShortTextDatum)\r\n * [GsaSetRangeDatum](#model-GsaSetRangeDatum)\r\n * [GsaSetDateTimeDatum](#model-GsaSetDateTimeDatum)\r\n * [GsaSetLongTextDatum](#model-GsaSetLongTextDatum)\r\n * [GsaSetHyperlinkDatum](#model-GsaSetHyperlinkDatum)\r\n * [GsaSetPointDatum](#model-GsaSetPointDatum)\r\n * [GsaSetDiscreteDatum](#model-GsaSetDiscreteDatum)\r\n * [GsaSetTabularDatum](#model-GsaSetTabularDatum)", + "description": "\r\n\r\nThis is one of: \r\n * GsaSetIntegerDatum\r\n * GsaSetLogicalDatum\r\n * GsaSetShortTextDatum\r\n * GsaSetRangeDatum\r\n * GsaSetDateTimeDatum\r\n * GsaSetLongTextDatum\r\n * GsaSetHyperlinkDatum\r\n * GsaSetPointDatum\r\n * GsaSetDiscreteDatum\r\n * GsaSetTabularDatum", "discriminator": { "propertyName": "setDatumType", "mapping": { @@ -120342,7 +83249,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "setDatumType" }, @@ -120365,7 +83272,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetParameterValue](#model-GsaSetParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaSetParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "parameterType" }, @@ -120396,7 +83303,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'hyperLink'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'hyperLink'", "x-discriminator-value": "hyperLink", "x-discriminator-name": "setDatumType" }, @@ -120420,7 +83327,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "setDatumType" }, @@ -120443,7 +83350,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "setDatumType" }, @@ -120466,7 +83373,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "setDatumType" }, @@ -120490,7 +83397,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetParameterValue](#model-GsaSetParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaSetParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "parameterType" }, @@ -120505,7 +83412,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSetDiscreteParameterValue](#model-GsaSetDiscreteParameterValue)\r\n * [GsaSetNumericParameterValue](#model-GsaSetNumericParameterValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaSetDiscreteParameterValue\r\n * GsaSetNumericParameterValue", "discriminator": { "propertyName": "parameterType", "mapping": { @@ -120556,7 +83463,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "setDatumType" }, @@ -120588,15 +83495,27 @@ }, { "required": [ - "estimated" + "estimated", + "highValue", + "highValueIsInclusive", + "lowValue", + "lowValueIsInclusive" ], "type": "object", "properties": { - "lowEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "lowValue": { + "type": "number", + "format": "double" + }, + "highValue": { + "type": "number", + "format": "double" + }, + "lowValueIsInclusive": { + "type": "boolean" }, - "highEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "highValueIsInclusive": { + "type": "boolean" }, "estimated": { "type": "boolean" @@ -120605,7 +83524,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "setDatumType" }, @@ -120628,7 +83547,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "setDatumType" }, @@ -120654,7 +83573,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'tabular'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'tabular'", "x-discriminator-value": "tabular", "x-discriminator-name": "setDatumType" }, @@ -120673,62 +83592,6 @@ }, "additionalProperties": false }, - "GsaSetUnitEquivalent": { - "required": [ - "equivalentUnitGuid", - "unitGuid", - "unitSystemGuid" - ], - "type": "object", - "properties": { - "unitGuid": { - "type": "string", - "format": "uuid" - }, - "unitSystemGuid": { - "type": "string", - "format": "uuid" - }, - "equivalentUnitGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSetUnitEquivalentsException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaSetUnitEquivalentsInfo": { - "type": "object", - "properties": { - "setUnitEquivalents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSetUnitEquivalent" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaShortNameProperty": { "type": "object", "allOf": [ @@ -120746,7 +83609,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'shortName'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'shortName'", "x-discriminator-value": "shortName", "x-discriminator-name": "propertyName" }, @@ -120770,7 +83633,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "datumType" }, @@ -120797,7 +83660,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a short-text attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "Criterion for aggregating data within a short-text attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -120824,7 +83687,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -120847,7 +83710,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "datumType" }, @@ -120873,7 +83736,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -120888,7 +83751,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -120911,7 +83774,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortTextPrefix'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortTextPrefix'", "x-discriminator-value": "shortTextPrefix", "x-discriminator-name": "type" }, @@ -120936,72 +83799,6 @@ }, "additionalProperties": false }, - "GsaSimilaritySetting": { - "required": [ - "attribute", - "weight", - "weightingType" - ], - "type": "object", - "properties": { - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "weight": { - "type": "number", - "format": "double" - }, - "weightingType": { - "$ref": "#/components/schemas/GsaWeightingType" - } - }, - "additionalProperties": false - }, - "GsaSimilaritySettings": { - "required": [ - "name", - "settings" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "includeMissingData": { - "type": "boolean" - }, - "isDefault": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "settings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSimilaritySetting" - } - } - }, - "additionalProperties": false - }, - "GsaSimilaritySortCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSortCriterion" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Specifies a similarity based sort criterion for a search query\r\n\r\nThis extends: [GsaSortCriterion](#model-GsaSortCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'similarity'", - "x-discriminator-value": "similarity", - "x-discriminator-name": "type" - }, "GsaSimpleAttributeToExport": { "type": "object", "allOf": [ @@ -121021,32 +83818,15 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nrollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify how linked data should be rolled up\r\n\r\nsummaryRollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify that the data should be rolled up and included in the summary row\r\n\r\nThis extends: [GsaAttributeToExport](#model-GsaAttributeToExport)\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'simple'", + "description": "\r\n\r\nrollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify how linked data should be rolled up\r\n\r\nsummaryRollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify that the data should be rolled up and included in the summary row\r\n\r\nThis extends: GsaAttributeToExport\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'simple'", "x-discriminator-value": "simple", "x-discriminator-name": "attributeType" }, - "GsaSlimAccessControlInfo": { - "required": [ - "mode", - "userCapabilities" - ], - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/GsaAccessControlMode" - }, - "userCapabilities": { - "$ref": "#/components/schemas/GsaAccessControlUserCapabilities" - } - }, - "additionalProperties": false - }, "GsaSlimAttribute": { "required": [ "displayNames", "guid", "isHiddenFromSearchCriteria", - "isProtected", "name", "table", "type" @@ -121063,10 +83843,6 @@ "type": "boolean", "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches." }, - "isProtected": { - "type": "boolean", - "description": "If true, the attribute is protected from all changes." - }, "table": { "$ref": "#/components/schemas/GsaSlimEntity" }, @@ -121075,8 +83851,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -121088,47 +83863,13 @@ }, "additionalProperties": false }, - "GsaSlimAttributeWithHelpPath": { + "GsaSlimConfiguration": { "required": [ - "displayNames", "guid", - "isHiddenFromSearchCriteria", - "isProtected", - "name", - "table", - "type" + "name" ], "type": "object", "properties": { - "helpPath": { - "type": "string", - "nullable": true - }, - "type": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "aboutAttribute": { - "$ref": "#/components/schemas/GsaSlimTypedAttribute" - }, - "isHiddenFromSearchCriteria": { - "type": "boolean", - "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches." - }, - "isProtected": { - "type": "boolean", - "description": "If true, the attribute is protected from all changes." - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, "name": { "type": "string" }, @@ -121139,7 +83880,7 @@ }, "additionalProperties": false }, - "GsaSlimConfiguration": { + "GsaSlimConstant": { "required": [ "guid", "name" @@ -121154,15 +83895,15 @@ "format": "uuid" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Constant base data (name and guid)\r\nNo extra properties compared to SlimNamedEntity yet, but exists for consistency with other slim entity types" }, "GsaSlimDatabase": { "required": [ "isLocked", "isReadOnly", "key", - "status", - "userCapabilities" + "status" ], "type": "object", "properties": { @@ -121208,27 +83949,6 @@ "schemaVersion": { "type": "string", "nullable": true - }, - "userCapabilities": { - "$ref": "#/components/schemas/GsaDatabaseUserCapabilities" - }, - "configurationDetails": { - "$ref": "#/components/schemas/GsaConfigurationDetails" - }, - "issues": { - "$ref": "#/components/schemas/GsaDatabaseIssues" - } - }, - "additionalProperties": false - }, - "GsaSlimDatabaseAccessControlInfo": { - "required": [ - "userCapabilities" - ], - "type": "object", - "properties": { - "userCapabilities": { - "$ref": "#/components/schemas/GsaAccessControlDatabaseUserCapabilities" } }, "additionalProperties": false @@ -121237,7 +83957,6 @@ "required": [ "guid", "isOrdered", - "isProtected", "name" ], "type": "object", @@ -121245,10 +83964,6 @@ "isOrdered": { "type": "boolean" }, - "isProtected": { - "type": "boolean", - "description": "If true, the discrete type is protected from all changes." - }, "name": { "type": "string" }, @@ -121275,14 +83990,10 @@ "GsaSlimExpression": { "required": [ "guid", - "name", - "table" + "name" ], "type": "object", "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, "name": { "type": "string" }, @@ -121341,8 +84052,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -121365,26 +84075,17 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutSection](#model-GsaLayoutSection)\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'slim'", + "description": "\r\n\r\nThis extends: GsaLayoutSection\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'slim'", "x-discriminator-value": "slim", "x-discriminator-name": "sectionDetailType" }, - "GsaSlimLocalizedEntity": { + "GsaSlimNamedEntity": { "required": [ - "displayNames", "guid", "name" ], "type": "object", "properties": { - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, "name": { "type": "string" }, @@ -121395,16 +84096,24 @@ }, "additionalProperties": false }, - "GsaSlimNamedEntity": { + "GsaSlimNamedUnit": { "required": [ "guid", - "name" + "name", + "symbol" ], "type": "object", "properties": { "name": { "type": "string" }, + "symbol": { + "type": "string" + }, + "relativeSymbol": { + "type": "string", + "nullable": true + }, "guid": { "type": "string", "format": "uuid" @@ -121442,8 +84151,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -121455,30 +84163,30 @@ }, "additionalProperties": false }, - "GsaSlimParameterWithHelpPath": { + "GsaSlimPermission": { "required": [ - "displayNames", "guid", - "name", - "type" + "name" ], "type": "object", "properties": { - "helpPath": { - "type": "string", - "nullable": true - }, - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + "name": { + "type": "string" }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaSlimPermissionCategory": { + "required": [ + "guid", + "name" + ], + "type": "object", + "properties": { "name": { "type": "string" }, @@ -121600,8 +84308,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -121657,52 +84364,6 @@ "additionalProperties": false, "description": "Replacement String base data (name and guid)\r\nNo extra properties compared to SlimNamedEntity yet, but exists for consistency with other slim entity types" }, - "GsaSlimSearchMask": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSlimSearchTemplate": { - "required": [ - "guid", - "name", - "table" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "GsaSlimSubset": { "required": [ "displayNames", @@ -121716,8 +84377,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -121731,7 +84391,6 @@ }, "GsaSlimTable": { "required": [ - "databaseKey", "displayNames", "guid", "isHiddenFromBrowse", @@ -121742,9 +84401,6 @@ ], "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, "isHiddenFromBrowse": { "type": "boolean" }, @@ -121765,8 +84421,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -121780,7 +84435,6 @@ }, "GsaSlimTypedAttribute": { "required": [ - "displayNames", "guid", "name", "type" @@ -121790,14 +84444,6 @@ "type": { "$ref": "#/components/schemas/GsaAttributeType" }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, "name": { "type": "string" }, @@ -121829,220 +84475,66 @@ }, "additionalProperties": false }, - "GsaSmartAttributesErrorDetail": { + "GsaSlimUnitSystem": { "required": [ - "message", - "reason" + "displayNames", + "guid", + "name" ], "type": "object", "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaSmartAttributesErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail](#model-GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail)\r\n * [GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail](#model-GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail)\r\n * [GsaAttributePairTypeMismatchSmartAttributesErrorDetail](#model-GsaAttributePairTypeMismatchSmartAttributesErrorDetail)\r\n * [GsaAttributeTypeNotSupportedSmartAttributesErrorDetail](#model-GsaAttributeTypeNotSupportedSmartAttributesErrorDetail)\r\n * [GsaNoAttributePairsSmartAttributesErrorDetail](#model-GsaNoAttributePairsSmartAttributesErrorDetail)\r\n * [GsaNoSuchAttributeSmartAttributesErrorDetail](#model-GsaNoSuchAttributeSmartAttributesErrorDetail)\r\n * [GsaSourceCannotBeTargetSmartAttributesErrorDetail](#model-GsaSourceCannotBeTargetSmartAttributesErrorDetail)\r\n * [GsaTooManyAttributePairsSmartAttributesErrorDetail](#model-GsaTooManyAttributePairsSmartAttributesErrorDetail)\r\n * [GsaMultiValuedSmartAttributesErrorDetail](#model-GsaMultiValuedSmartAttributesErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "attributeAlreadySpecified": "#/components/schemas/GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "attributePairDiscreteTypeMismatch": "#/components/schemas/GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "attributePairTypeMismatch": "#/components/schemas/GsaAttributePairTypeMismatchSmartAttributesErrorDetail", - "attributeTypeNotSupported": "#/components/schemas/GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", - "noAttributePairs": "#/components/schemas/GsaNoAttributePairsSmartAttributesErrorDetail", - "noSuchAttribute": "#/components/schemas/GsaNoSuchAttributeSmartAttributesErrorDetail", - "sourceCannotBeTarget": "#/components/schemas/GsaSourceCannotBeTargetSmartAttributesErrorDetail", - "tooManyAttributePairs": "#/components/schemas/GsaTooManyAttributePairsSmartAttributesErrorDetail", - "multiValued": "#/components/schemas/GsaMultiValuedSmartAttributesErrorDetail" - } - } - }, - "GsaSmartAttributesErrorReason": { - "enum": [ - "attributeAlreadySpecified", - "attributePairDiscreteTypeMismatch", - "attributePairTypeMismatch", - "attributeTypeNotSupported", - "noAttributePairs", - "noSuchAttribute", - "sourceCannotBeTarget", - "tooManyAttributePairs", - "multiValued" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • attributeAlreadySpecified: Smart record link group source and target attributes cannot contain duplicates.
    • \r\n
  • attributePairDiscreteTypeMismatch: Discrete attributes in attribute pairs must have the same discrete type.
    • \r\n
  • attributePairTypeMismatch: Attributes in attribute pairs must have the same attribute type.
    • \r\n
  • attributeTypeNotSupported: Attribute type is not supported in smart link group attribute pairs. Attribute types supported in attribute pairs: discrete, dateTime, integer, logical, shortText.
    • \r\n
  • noAttributePairs: Smart record link group must have at least one attribute pair set.
    • \r\n
  • noSuchAttribute: Attribute not found.
    • \r\n
  • sourceCannotBeTarget: An attribute is not permitted to link to itself as both a source and target attribute.
    • \r\n
  • tooManyAttributePairs: Smart record link group cannot have more than three attribute pairs set.
    • \r\n
  • multiValued: Multi-valued attributes are not supported in smart link group attribute pairs.
    • \r\n
\r\n" - }, - "GsaSmartAttributesRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "required": [ - "errors" - ], + "displayNames": { "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - } - } + "additionalProperties": { + "type": "string", + "nullable": true } - } - ], - "additionalProperties": false, - "description": "The attributes used as linking attribute pairs for a smart link group are not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'smartAttributes'", - "x-discriminator-value": "smartAttributes", - "x-discriminator-name": "reason" - }, - "GsaSmartLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" }, - { - "required": [ - "attributePairs", - "forbidOrphans", - "referentialIntegrityModel" - ], - "type": "object", - "properties": { - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeLinkPair" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smartLink'", - "x-discriminator-value": "smartLink", - "x-discriminator-name": "type" - }, - "GsaSmartLinkCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" + "name": { + "type": "string" }, - { - "required": [ - "linkGroupGuid" - ], - "type": "object", - "properties": { - "forwards": { - "type": "boolean" - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" - } - } + "guid": { + "type": "string", + "format": "uuid" } - ], + }, "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'smartLink'", - "x-discriminator-value": "smartLink", - "x-discriminator-name": "itemType" + "description": "Unit system stripped down to its basic fields (mappings excluded)." }, - "GsaSmartLinkGroupUsageDataModificationErrorDetail": { + "GsaSmtpProperties": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "properties": { + "hostName": { + "type": "string", + "description": "Gets or sets the name of the host used for SMTP transactions", + "nullable": true }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'smartLinkGroup'", - "x-discriminator-value": "smartLinkGroup", - "x-discriminator-name": "referencedByType" - }, - "GsaSmartRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroup" + "port": { + "type": "integer", + "description": "Gets or sets the port used for SMTP transactions.\r\nIf no value set then it will default to 25", + "format": "int32", + "default": 25 }, - { - "required": [ - "attributePairs", - "forbidOrphans", - "referentialIntegrityModel" - ], - "type": "object", - "properties": { - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeLinkPair" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkGroup](#model-GsaRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "type" - }, - "GsaSmartRecordLinkResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkResult" + "useSsl": { + "type": "boolean", + "description": "Indicates whether the SMTP server uses SSL.\r\nDefaults to False" }, - { - "required": [ - "isLinkToTarget" - ], - "type": "object", - "properties": { - "isLinkToTarget": { - "type": "boolean", - "description": "Smart links have a 'source' and a 'target' determined by the attribute pairs on the link group. If this property is 'true' then the linked record is on the 'target' side of the link, if 'false' the linked record is on the 'source' side.." - } - } + "useAuthentication": { + "type": "boolean", + "description": "Indicates whether authentication is required. If this is set to True\r\nthen Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationUsername and Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationPassword\r\nare required.\r\nDefaults to False" + }, + "authenticationUsername": { + "type": "string", + "description": "Gets or sets the username to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True.", + "nullable": true + }, + "authenticationPassword": { + "type": "string", + "description": "Gets or sets the password to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True.", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkResult](#model-GsaRecordLinkResult)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "recordLinkGroupType" + }, + "additionalProperties": false }, "GsaSortCriterion": { "required": [ @@ -122058,14 +84550,13 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAttributeSortCriterion](#model-GsaAttributeSortCriterion)\r\n * [GsaRecordPropertySortCriterion](#model-GsaRecordPropertySortCriterion)\r\n * [GsaRelevanceSortCriterion](#model-GsaRelevanceSortCriterion)\r\n * [GsaSimilaritySortCriterion](#model-GsaSimilaritySortCriterion)", + "description": "\r\n\r\nThis is one of: \r\n * GsaAttributeSortCriterion\r\n * GsaRecordPropertySortCriterion\r\n * GsaRelevanceSortCriterion", "discriminator": { "propertyName": "type", "mapping": { "attribute": "#/components/schemas/GsaAttributeSortCriterion", "recordProperty": "#/components/schemas/GsaRecordPropertySortCriterion", - "relevance": "#/components/schemas/GsaRelevanceSortCriterion", - "similarity": "#/components/schemas/GsaSimilaritySortCriterion" + "relevance": "#/components/schemas/GsaRelevanceSortCriterion" } } }, @@ -122073,8 +84564,7 @@ "enum": [ "attribute", "recordProperty", - "relevance", - "similarity" + "relevance" ], "type": "string" }, @@ -122104,7 +84594,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDoubleSortingValue](#model-GsaDoubleSortingValue)\r\n * [GsaLongSortingValue](#model-GsaLongSortingValue)\r\n * [GsaStringSortingValue](#model-GsaStringSortingValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDoubleSortingValue\r\n * GsaLongSortingValue\r\n * GsaStringSortingValue", "discriminator": { "propertyName": "type", "mapping": { @@ -122122,21 +84612,6 @@ ], "type": "string" }, - "GsaSourceCannotBeTargetSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "An attribute is not permitted to link to itself as both a source and target attribute.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'sourceCannotBeTarget'", - "x-discriminator-value": "sourceCannotBeTarget", - "x-discriminator-name": "reason" - }, "GsaSourceOfObjectIdentifier": { "required": [ "mappings", @@ -122194,39 +84669,20 @@ } ], "additionalProperties": false, - "description": "Specifies identities or guids to filter on.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'specific'", + "description": "Specifies identities or guids to filter on.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'specific'", "x-discriminator-value": "specific", "x-discriminator-name": "filterOn" }, - "GsaSqlCredentials": { - "required": [ - "password", - "username" - ], - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "The username for the SQL authentication. The password must also be provided." - }, - "password": { - "type": "string", - "description": "The password for the SQL authentication. The username must also be provided." - } - }, - "additionalProperties": false - }, "GsaStandardName": { "required": [ "databaseGuid", "databaseKey", "databaseVersionGuid", "guid", - "isCustom", "mappedAttributes", "mappedCrossDatabaseRecordLinkGroups", "mappedParameters", - "mappedStaticRecordLinkGroups", + "mappedRecordLinkGroups", "name" ], "type": "object", @@ -122243,10 +84699,10 @@ "$ref": "#/components/schemas/GsaSlimNamedEntity" } }, - "mappedStaticRecordLinkGroups": { + "mappedRecordLinkGroups": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaStaticRecordLinkGroupMapping" + "$ref": "#/components/schemas/GsaSlimNamedEntity" } }, "mappedCrossDatabaseRecordLinkGroups": { @@ -122266,9 +84722,6 @@ "type": "string", "format": "uuid" }, - "isCustom": { - "type": "boolean" - }, "name": { "type": "string" }, @@ -122279,178 +84732,6 @@ }, "additionalProperties": false }, - "GsaStandardNameAlreadyExistsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "standardName" - ], - "type": "object", - "properties": { - "standardName": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'standardNameAlreadyExists'", - "x-discriminator-value": "standardNameAlreadyExists", - "x-discriminator-name": "reason" - }, - "GsaStandardNameCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaStandardNameDeletionErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaStandardNameDeletionErrorReason" - }, - "standardName": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaStandardNameDeletionErrorReason": { - "enum": [ - "nonCustomStandardNameCannotBeDeleted" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • nonCustomStandardNameCannotBeDeleted: Cannot delete a non-custom standard name.
    • \r\n
\r\n" - }, - "GsaStandardNameDeletionException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaStandardNameDeletionErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaStandardNameErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaStandardNameErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaStandardNameAlreadyExistsErrorDetail](#model-GsaStandardNameAlreadyExistsErrorDetail)\r\n * [GsaDuplicateMappedAttributeGuidsErrorDetail](#model-GsaDuplicateMappedAttributeGuidsErrorDetail)\r\n * [GsaDuplicateMappedParameterGuidsErrorDetail](#model-GsaDuplicateMappedParameterGuidsErrorDetail)\r\n * [GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail](#model-GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail)\r\n * [GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail](#model-GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail)\r\n * [GsaUnresolvedAttributeGuidsErrorDetail](#model-GsaUnresolvedAttributeGuidsErrorDetail)\r\n * [GsaUnresolvedParameterGuidsErrorDetail](#model-GsaUnresolvedParameterGuidsErrorDetail)\r\n * [GsaUnresolvedRecordLinkGroupGuidsErrorDetail](#model-GsaUnresolvedRecordLinkGroupGuidsErrorDetail)\r\n * [GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail](#model-GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail)\r\n * [GsaNonCustomStandardNameCannotBeChangedErrorDetail](#model-GsaNonCustomStandardNameCannotBeChangedErrorDetail)\r\n * [GsaUnresolvedReverseRecordLinkGroupsErrorDetail](#model-GsaUnresolvedReverseRecordLinkGroupsErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "standardNameAlreadyExists": "#/components/schemas/GsaStandardNameAlreadyExistsErrorDetail", - "duplicateMappedAttributeGuids": "#/components/schemas/GsaDuplicateMappedAttributeGuidsErrorDetail", - "duplicateMappedParameterGuids": "#/components/schemas/GsaDuplicateMappedParameterGuidsErrorDetail", - "duplicateMappedRecordLinkGroupGuids": "#/components/schemas/GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "duplicateMappedCrossDatabaseRecordLinkGroupGuids": "#/components/schemas/GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "unresolvedAttributeGuids": "#/components/schemas/GsaUnresolvedAttributeGuidsErrorDetail", - "unresolvedParameterGuids": "#/components/schemas/GsaUnresolvedParameterGuidsErrorDetail", - "unresolvedRecordLinkGroupGuids": "#/components/schemas/GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "unresolvedCrossDatabaseRecordLinkGroupGuids": "#/components/schemas/GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "nonCustomStandardNameCannotBeChanged": "#/components/schemas/GsaNonCustomStandardNameCannotBeChangedErrorDetail", - "unresolvedReverseRecordLinkGroups": "#/components/schemas/GsaUnresolvedReverseRecordLinkGroupsErrorDetail" - } - } - }, - "GsaStandardNameErrorReason": { - "enum": [ - "standardNameAlreadyExists", - "duplicateMappedAttributeGuids", - "duplicateMappedParameterGuids", - "duplicateMappedRecordLinkGroupGuids", - "duplicateMappedCrossDatabaseRecordLinkGroupGuids", - "unresolvedAttributeGuids", - "unresolvedParameterGuids", - "unresolvedRecordLinkGroupGuids", - "unresolvedCrossDatabaseRecordLinkGroupGuids", - "nonCustomStandardNameCannotBeChanged", - "unresolvedReverseRecordLinkGroups" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • standardNameAlreadyExists: A standard name with this name already exists.
    • \r\n
  • duplicateMappedAttributeGuids: Duplicated attribute GUIDs present.
    • \r\n
  • duplicateMappedParameterGuids: Duplicated parameter GUIDs present.
    • \r\n
  • duplicateMappedRecordLinkGroupGuids: Duplicated record link group GUIDs present.
    • \r\n
  • duplicateMappedCrossDatabaseRecordLinkGroupGuids: Duplicated cross-database record link group GUIDs present.
    • \r\n
  • unresolvedAttributeGuids: Attribute GUIDs did not resolve.
    • \r\n
  • unresolvedParameterGuids: Parameter GUIDs did not resolve.
    • \r\n
  • unresolvedRecordLinkGroupGuids: Record link group GUIDs did not resolve.
    • \r\n
  • unresolvedCrossDatabaseRecordLinkGroupGuids: Cross-database record link group GUIDs did not resolve.
    • \r\n
  • nonCustomStandardNameCannotBeChanged: The name of a 'non-custom' standard name cannot be changed.
    • \r\n
  • unresolvedReverseRecordLinkGroups: Reverse record link group mappings were specified for record link groups that do not have a reverse link group.
    • \r\n
\r\n" - }, - "GsaStandardNameUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "standardNameGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaStandardNamesInfo": { "type": "object", "properties": { @@ -122464,21 +84745,6 @@ }, "additionalProperties": false }, - "GsaStaticRecordLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkBase" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkBase](#model-GsaRecordLinkBase)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'static'", - "x-discriminator-value": "static", - "x-discriminator-name": "recordLinkGroupType" - }, "GsaStaticRecordLinkGroup": { "type": "object", "allOf": [ @@ -122498,47 +84764,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkGroup](#model-GsaRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", + "description": "\r\n\r\nThis extends: GsaRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", "x-discriminator-value": "static", "x-discriminator-name": "type" }, - "GsaStaticRecordLinkGroupMapping": { - "required": [ - "isReverse", - "staticRecordLinkGroup" - ], - "type": "object", - "properties": { - "staticRecordLinkGroup": { - "$ref": "#/components/schemas/GsaSlimRecordLinkGroup" - }, - "isReverse": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaStaticRecordLinkResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkResult" - }, - { - "type": "object", - "properties": { - "notes": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkResult](#model-GsaRecordLinkResult)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'static'", - "x-discriminator-value": "static", - "x-discriminator-name": "recordLinkGroupType" - }, "GsaStringSortingValue": { "type": "object", "allOf": [ @@ -122556,7 +84785,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSortingValue](#model-GsaSortingValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "description": "\r\n\r\nThis extends: GsaSortingValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", "x-discriminator-value": "text", "x-discriminator-name": "type" }, @@ -122576,8 +84805,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -122595,58 +84823,15 @@ "subsets": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSubset" + "$ref": "#/components/schemas/GsaSlimSubset" }, "nullable": true } }, "additionalProperties": false }, - "GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Cannot swap name and reverse name when the source and target table are the same.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'swapNameAndReverseNameCircular'", - "x-discriminator-value": "swapNameAndReverseNameCircular", - "x-discriminator-name": "reason" - }, - "GsaSymbolCannotContainCommaUnitErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - { - "required": [ - "symbol" - ], - "type": "object", - "properties": { - "symbol": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'symbolCannotContainComma'", - "x-discriminator-value": "symbolCannotContainComma", - "x-discriminator-name": "reason" - }, - "GsaTItem": { - "type": "object", - "additionalProperties": false - }, "GsaTable": { "required": [ - "databaseKey", "displayNames", "guid", "isHiddenFromBrowse", @@ -122654,7 +84839,6 @@ "isVersioned", "layouts", "name", - "order", "subsets", "tableTypes", "versionState" @@ -122682,32 +84866,6 @@ "versionState": { "$ref": "#/components/schemas/GsaVersionState" }, - "order": { - "type": "integer", - "format": "int32" - }, - "qualitySystem": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "legalDisclaimer": { - "type": "string", - "nullable": true - }, - "datasheetHeader": { - "type": "string", - "nullable": true - }, - "datasheetFooter": { - "type": "string", - "nullable": true - }, - "shouldShowVersionControlSignatures": { - "type": "boolean", - "description": "Gets or sets whether version control signatures should be shown when data is shown to a user.\r\n'Version control signatures' show when a record was released, who released it and on which revision." - }, - "databaseKey": { - "type": "string" - }, "isHiddenFromBrowse": { "type": "boolean" }, @@ -122728,8 +84886,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -122741,42 +84898,7 @@ }, "additionalProperties": false }, - "GsaTableAccessControlEntity": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlEntity" - }, - { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "latestVersionFilter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaVersionControlMode" - }, - "description": "Optional.\r\nIf set, only include versions of the table that match this filter:\r\n - read: include only the latest version in read mode\r\n - write: include only the latest version in write mode\r\n - read and write: include the latest versions in read or write mode\r\n - empty: include versions that are not the latest in read or write mode\r\nIf not set, include all versions", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlEntity](#model-GsaAccessControlEntity)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'table'", - "x-discriminator-value": "table", - "x-discriminator-name": "entityType" - }, - "GsaTableCreationException": { - "required": [ - "name" - ], + "GsaTableDeletionException": { "type": "object", "properties": { "message": { @@ -122784,115 +84906,18 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaTableErrorDetail" + "$ref": "#/components/schemas/GsaDataModificationErrorDetail" }, "nullable": true } }, "additionalProperties": false }, - "GsaTableDeletionException": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDeletionException" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'table'", - "x-discriminator-value": "table", - "x-discriminator-name": "entityType" - }, - "GsaTableDescendantsAccessControlEntity": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlEntity" - }, - { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "subsetGuid": { - "type": "string", - "description": "Optional.\r\nIf set, only include descendants in this subset", - "format": "uuid", - "nullable": true - }, - "latestVersionFilter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaVersionControlMode" - }, - "description": "Optional.\r\nIf set, only include descendants that match this filter. For each descendant record history:\r\n - read: include only the record version that is the latest version in read mode.\r\n - write: include only the record version that is the latest version in write mode.\r\n - read and write: include the record versions that are the latest versions in read or write mode.\r\n - empty: include record versions that are not the latest version in read or write mode.\r\nIf not set, include all versions of all descendant record histories.", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Include the descendants of a table.\r\nThis will not include the table itself.\r\n\r\nThis extends: [GsaAccessControlEntity](#model-GsaAccessControlEntity)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'tableDescendants'", - "x-discriminator-value": "tableDescendants", - "x-discriminator-name": "entityType" - }, - "GsaTableErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaTableErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityTableErrorDetail](#model-GsaNamedEntityTableErrorDetail)\r\n * [GsaTableTypesErrorDetail](#model-GsaTableTypesErrorDetail)\r\n * [GsaRootRecordNotAvailableToRenameErrorDetail](#model-GsaRootRecordNotAvailableToRenameErrorDetail)\r\n * [GsaDefaultSubsetGuidErrorDetail](#model-GsaDefaultSubsetGuidErrorDetail)\r\n * [GsaDefaultLayoutGuidErrorDetail](#model-GsaDefaultLayoutGuidErrorDetail)\r\n * [GsaQualitySystemGuidErrorDetail](#model-GsaQualitySystemGuidErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityTableErrorDetail", - "tableTypes": "#/components/schemas/GsaTableTypesErrorDetail", - "rootRecordNotAvailableToRename": "#/components/schemas/GsaRootRecordNotAvailableToRenameErrorDetail", - "defaultSubsetGuid": "#/components/schemas/GsaDefaultSubsetGuidErrorDetail", - "defaultLayoutGuid": "#/components/schemas/GsaDefaultLayoutGuidErrorDetail", - "qualitySystemGuid": "#/components/schemas/GsaQualitySystemGuidErrorDetail" - } - } - }, - "GsaTableErrorReason": { - "enum": [ - "namedEntity", - "tableTypes", - "rootRecordNotAvailableToRename", - "defaultSubsetGuid", - "defaultLayoutGuid", - "qualitySystemGuid", - "tableGuids" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • tableTypes: The table types are not valid.
    • \r\n
  • rootRecordNotAvailableToRename: The table cannot be renamed as the root record is not available.
    • \r\n
  • defaultSubsetGuid: The default subset guid does not represent an existing subset in the table.
    • \r\n
  • defaultLayoutGuid: The default layout guid does not represent an existing layout in the table.
    • \r\n
  • qualitySystemGuid: The quality system guid does not represent an existing quality system in the database.
    • \r\n
  • tableGuids: One or more table guids are not valid.
    • \r\n
\r\n" - }, "GsaTableGuidProperty": { "type": "object", "allOf": [ @@ -122910,7 +84935,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableGuid'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableGuid'", "x-discriminator-value": "tableGuid", "x-discriminator-name": "propertyName" }, @@ -122931,7 +84956,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableIdentity'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableIdentity'", "x-discriminator-value": "tableIdentity", "x-discriminator-name": "propertyName" }, @@ -122952,179 +84977,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableName'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableName'", "x-discriminator-value": "tableName", "x-discriminator-name": "propertyName" }, - "GsaTableSearchBehaviour": { - "enum": [ - "OnlyIncludeRecordsFromSearchableTables", - "OnlyIncludeRecordsFromHiddenFromSearchTables", - "IncludeRecordsFromAllTables" - ], - "type": "string", - "description": "Enum to determine the behaviour of records in tables that are marked as searchable or not searchable

Possible values:

\r\n
    \r\n
  • OnlyIncludeRecordsFromSearchableTables: The default behaviour. Records in tables marked as \"hidden from search\" will be excluded from the results set
    • \r\n
  • OnlyIncludeRecordsFromHiddenFromSearchTables: Only records in tables marked as \"hidden from search\" will be included in the results set
    • \r\n
  • IncludeRecordsFromAllTables: Records will be included in the results set regardless of the searchability of the table
    • \r\n
\r\n" - }, - "GsaTableTypeContainsCommaErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableTypeErrorDetail" - }, - { - "required": [ - "tableType" - ], - "type": "object", - "properties": { - "tableType": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableTypeErrorDetail](#model-GsaTableTypeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tableTypeContainsComma'", - "x-discriminator-value": "tableTypeContainsComma", - "x-discriminator-name": "reason" - }, - "GsaTableTypeErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaTableTypeErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaEmptyTableTypeErrorDetail](#model-GsaEmptyTableTypeErrorDetail)\r\n * [GsaTableTypeContainsCommaErrorDetail](#model-GsaTableTypeContainsCommaErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "emptyTableType": "#/components/schemas/GsaEmptyTableTypeErrorDetail", - "tableTypeContainsComma": "#/components/schemas/GsaTableTypeContainsCommaErrorDetail" - } - } - }, - "GsaTableTypeErrorReason": { - "enum": [ - "emptyTableType", - "tableTypeContainsComma" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • emptyTableType: A table type cannot be empty or whitespace.
    • \r\n
  • tableTypeContainsComma: A table type cannot contain a comma.
    • \r\n
\r\n" - }, - "GsaTableTypesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTableTypeErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tableTypes'", - "x-discriminator-value": "tableTypes", - "x-discriminator-name": "reason" - }, - "GsaTableTypesInfo": { - "type": "object", - "properties": { - "tableTypes": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaTableUpdateException": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaTableUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'table'", - "x-discriminator-value": "table", - "x-discriminator-name": "referencedByType" - }, - "GsaTableVersionStateAccessControlCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "tableDiscreteValues can only be set if the table is unreleased or unversioned.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tableVersionState'", - "x-discriminator-value": "tableVersionState", - "x-discriminator-name": "reason" - }, "GsaTablesInfo": { "type": "object", "properties": { @@ -123132,36 +84988,11 @@ "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimTable" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaTablesMissingReorderTablesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReorderTablesErrorDetail" - }, - { - "type": "object", - "properties": { - "missingGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } + }, + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaReorderTablesErrorDetail](#model-GsaReorderTablesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tablesMissing'", - "x-discriminator-value": "tablesMissing", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, "GsaTabularAttribute": { "type": "object", @@ -123200,33 +85031,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, - "GsaTabularAttributeLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" - }, - { - "required": [ - "targetAttribute" - ], - "type": "object", - "properties": { - "targetAttribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabularAttribute'", - "x-discriminator-value": "tabularAttribute", - "x-discriminator-name": "type" - }, "GsaTabularAttributeTarget": { "type": "object", "properties": { @@ -123269,7 +85077,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'tabularAttribute'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'tabularAttribute'", "x-discriminator-value": "tabularAttribute", "x-discriminator-name": "referencedByType" }, @@ -123298,13 +85106,11 @@ "displayNames", "guid", "name", - "order", "rollUpType", "showAsLink", "summaryRowEnabled", "summaryRowRollUpType", - "summaryRowText", - "summaryRowTranslations" + "summaryRowText" ], "type": "object", "properties": { @@ -123320,19 +85126,6 @@ "summaryRowText": { "type": "string" }, - "summaryRowTranslations": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the row text that should be used in that culture for the item" - }, - "order": { - "type": "integer", - "description": "The order that this column appears in the tabular attribute. Columns on an attribute object are returned from the API in the correct sorted order.", - "format": "int32" - }, "rollUpType": { "$ref": "#/components/schemas/GsaTabularColumnRollUpType" }, @@ -123344,8 +85137,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -123356,7 +85148,7 @@ } }, "additionalProperties": false, - "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * [GsaLinkedAttributeTabularColumn](#model-GsaLinkedAttributeTabularColumn)\r\n * [GsaLinkedColumnTabularColumn](#model-GsaLinkedColumnTabularColumn)\r\n * [GsaLinkedRecordTabularColumn](#model-GsaLinkedRecordTabularColumn)\r\n * [GsaLocalPointTabularColumn](#model-GsaLocalPointTabularColumn)\r\n * [GsaLocalRangeTabularColumn](#model-GsaLocalRangeTabularColumn)\r\n * [GsaLocalIntegerTabularColumn](#model-GsaLocalIntegerTabularColumn)\r\n * [GsaLocalLogicalTabularColumn](#model-GsaLocalLogicalTabularColumn)\r\n * [GsaLocalShortTextTabularColumn](#model-GsaLocalShortTextTabularColumn)\r\n * [GsaLocalLongTextTabularColumn](#model-GsaLocalLongTextTabularColumn)\r\n * [GsaLocalDateTimeTabularColumn](#model-GsaLocalDateTimeTabularColumn)\r\n * [GsaLocalDiscreteTabularColumn](#model-GsaLocalDiscreteTabularColumn)\r\n * [GsaLocalHyperlinkTabularColumn](#model-GsaLocalHyperlinkTabularColumn)\r\n * [GsaLocalFileTabularColumn](#model-GsaLocalFileTabularColumn)\r\n * [GsaLocalPictureTabularColumn](#model-GsaLocalPictureTabularColumn)\r\n * [GsaUnavailableTabularColumn](#model-GsaUnavailableTabularColumn)", + "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * GsaLinkedAttributeTabularColumn\r\n * GsaLinkedColumnTabularColumn\r\n * GsaLinkedRecordTabularColumn\r\n * GsaLocalPointTabularColumn\r\n * GsaLocalRangeTabularColumn\r\n * GsaLocalIntegerTabularColumn\r\n * GsaLocalLogicalTabularColumn\r\n * GsaLocalShortTextTabularColumn\r\n * GsaLocalLongTextTabularColumn\r\n * GsaLocalDateTimeTabularColumn\r\n * GsaLocalDiscreteTabularColumn\r\n * GsaLocalHyperlinkTabularColumn\r\n * GsaLocalFileTabularColumn\r\n * GsaLocalPictureTabularColumn\r\n * GsaUnavailableTabularColumn", "discriminator": { "propertyName": "columnType", "mapping": { @@ -123420,7 +85212,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNameNotProvided'", + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNameNotProvided'", "x-discriminator-value": "tabularColumnNameNotProvided", "x-discriminator-name": "reason" }, @@ -123448,30 +85240,6 @@ "type": "string", "description": "The roll up types of a tabular column." }, - "GsaTabularColumnUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTabularAttributeWithColumns" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'tabularColumn'", - "x-discriminator-value": "tabularColumn", - "x-discriminator-name": "referencedByType" - }, "GsaTabularDatum": { "type": "object", "allOf": [ @@ -123497,7 +85265,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'tabular'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'tabular'", "x-discriminator-value": "tabular", "x-discriminator-name": "datumType" }, @@ -123528,7 +85296,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabular'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabular'", "x-discriminator-value": "tabular", "x-discriminator-name": "type" }, @@ -123611,7 +85379,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabularLinkingValue'", + "description": "\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabularLinkingValue'", "x-discriminator-value": "tabularLinkingValue", "x-discriminator-name": "type" }, @@ -123623,31 +85391,6 @@ "type": "string", "description": "

Possible values:

\r\n
    \r\n
  • allRows: Export all rows - including rows with no visible linked records
    • \r\n
  • onlyRowsWithVisibleLinkedRecords: Export only rows with visible linked records
    • \r\n
\r\n" }, - "GsaTargetAttribute": { - "required": [ - "guid", - "targetType" - ], - "type": "object", - "properties": { - "targetType": { - "$ref": "#/components/schemas/GsaTargetAttributeType" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaResolvedTargetAttribute](#model-GsaResolvedTargetAttribute)\r\n * [GsaUnresolvedTargetAttribute](#model-GsaUnresolvedTargetAttribute)", - "discriminator": { - "propertyName": "targetType", - "mapping": { - "resolved": "#/components/schemas/GsaResolvedTargetAttribute", - "unresolved": "#/components/schemas/GsaUnresolvedTargetAttribute" - } - } - }, "GsaTargetAttributeNotInTableAttributeErrorDetail": { "type": "object", "allOf": [ @@ -123669,17 +85412,10 @@ } ], "additionalProperties": false, - "description": "The target attribute is not valid as it does not belong to the target table.\r\nTabular attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeNotInTable'", + "description": "The target attribute is not valid as it does not belong to the target table.\r\nTabular attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeNotInTable'", "x-discriminator-value": "targetAttributeNotInTable", "x-discriminator-name": "reason" }, - "GsaTargetAttributeType": { - "enum": [ - "resolved", - "unresolved" - ], - "type": "string" - }, "GsaTargetAttributeTypeAttributeErrorDetail": { "type": "object", "allOf": [ @@ -123697,36 +85433,10 @@ } ], "additionalProperties": false, - "description": "The target attribute is not valid as the target attribute of a tabular attribute as it is not a short text attribute.\r\nTabular attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeType'", + "description": "The target attribute is not valid as the target attribute of a tabular attribute as it is not a short text attribute.\r\nTabular attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeType'", "x-discriminator-value": "targetAttributeType", "x-discriminator-name": "reason" }, - "GsaTargetNotFullySpecifiedAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "required": [ - "missingProperties" - ], - "type": "object", - "properties": { - "missingProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "additionalProperties": false, - "description": "Target must be fully specified because there is no existing Target to update.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetNotFullySpecified'", - "x-discriminator-value": "targetNotFullySpecified", - "x-discriminator-name": "reason" - }, "GsaTermWithCount": { "type": "object", "properties": { @@ -123776,295 +85486,10 @@ } ], "additionalProperties": false, - "description": "Threshold type is not allowed for this attribute type.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'thresholdType'", + "description": "Threshold type is not allowed for this attribute type.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'thresholdType'", "x-discriminator-value": "thresholdType", "x-discriminator-name": "reason" }, - "GsaThresholdValueNameEmptyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaQualitySystemErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystemErrorDetail](#model-GsaQualitySystemErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'thresholdValueNameEmpty'", - "x-discriminator-value": "thresholdValueNameEmpty", - "x-discriminator-name": "reason" - }, - "GsaThresholdValueNameInvalidErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaQualitySystemErrorDetail" - }, - { - "type": "object", - "properties": { - "thresholdValueName": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystemErrorDetail](#model-GsaQualitySystemErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'thresholdValueNameInvalid'", - "x-discriminator-value": "thresholdValueNameInvalid", - "x-discriminator-name": "reason" - }, - "GsaTooLongCodeCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Currency code cannot be longer than 3 characters.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooLongCode'", - "x-discriminator-value": "tooLongCode", - "x-discriminator-name": "reason" - }, - "GsaTooManyAttributePairsSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "numberOfAttributePairs" - ], - "type": "object", - "properties": { - "numberOfAttributePairs": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "Smart record link group cannot have more than three attribute pairs set.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooManyAttributePairs'", - "x-discriminator-value": "tooManyAttributePairs", - "x-discriminator-name": "reason" - }, - "GsaTooManyPermissionsPermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - { - "required": [ - "maxNumberOfPermissions", - "numberOfNewPermissions" - ], - "type": "object", - "properties": { - "numberOfNewPermissions": { - "type": "integer", - "format": "int32" - }, - "maxNumberOfPermissions": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "The new permissions cannot be added, there are not enough permissions available.\r\nA schema for a database may have up to 128 permissions.\r\nThis is the total number of permissions that have ever existed in the schema\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooManyPermissions'", - "x-discriminator-value": "tooManyPermissions", - "x-discriminator-name": "reason" - }, - "GsaTooManyPermissionsReplacePermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - { - "required": [ - "maxNumberOfPermissions", - "numberOfNewPermissions" - ], - "type": "object", - "properties": { - "numberOfNewPermissions": { - "type": "integer", - "format": "int32" - }, - "maxNumberOfPermissions": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "The new permissions cannot be added, there are not enough permissions available.\r\nA schema for a database may have up to 128 permissions.\r\nThis is the total number of permissions that have ever existed in the schema\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooManyPermissions'", - "x-discriminator-value": "tooManyPermissions", - "x-discriminator-name": "reason" - }, - "GsaTranslateBetweenGuidsAndIdentitiesResponse": { - "required": [ - "databaseKey" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "layouts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "recordVersions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "recordHistories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "units": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "unitSystems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "subsets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "tables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "discreteTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "replacementStrings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "standardNames": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "constants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "recordLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "crossDatabaseLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "tabularColumns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "searchMasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "searchTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaTranslateGuidsToIdentitiesRequest": { "required": [ "databaseKey" @@ -124179,45 +85604,17 @@ }, "nullable": true }, - "crossDatabaseLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "tabularColumns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimEntity" }, "nullable": true - }, - "searchMasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "searchTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true } }, "additionalProperties": false }, - "GsaTranslateIdentitiesToGuidsRequest": { + "GsaTranslateGuidsToIdentitiesResponse": { "required": [ "databaseKey" ], @@ -124229,160 +85626,112 @@ "attributes": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "layouts": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "recordVersions": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "recordHistories": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "units": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "unitSystems": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "parameters": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "subsets": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "tables": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "discreteTypes": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "discreteValues": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "replacementStrings": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "standardNames": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "constants": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "recordLinkGroups": { "type": "array", "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "crossDatabaseLinkGroups": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "tabularColumns": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "data": { "type": "array", "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "searchMasks": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "searchTemplates": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true } @@ -124408,7 +85757,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'unableToConnect'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'unableToConnect'", "x-discriminator-value": "unableToConnect", "x-discriminator-name": "IssueType" }, @@ -124423,7 +85772,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", "x-discriminator-value": "unavailable", "x-discriminator-name": "columnType" }, @@ -124456,21 +85805,6 @@ }, "additionalProperties": false }, - "GsaUnitAsExponentUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unitAsExponent'", - "x-discriminator-value": "unitAsExponent", - "x-discriminator-name": "reason" - }, "GsaUnitConversionSet": { "required": [ "factor", @@ -124505,12 +85839,10 @@ "type": "object", "properties": { "sourceUnitSymbol": { - "type": "string", - "description": "Symbol of the unit to convert from\r\nIf the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code" + "type": "string" }, "targetUnitSymbol": { - "type": "string", - "description": "Symbol of the unit to convert from\r\nIf the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code" + "type": "string" } }, "additionalProperties": false @@ -124532,93 +85864,12 @@ "type": "array", "items": { "$ref": "#/components/schemas/GsaInputValidationErrorDetail" - }, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Represents a set of unit conversions for each source unit.\r\nFailures are included alongside the conversions for any source units that could not be converted." - }, - "GsaUnitCreationException": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnitDeletionException": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaDeletionException" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDeletionException](#model-GsaDeletionException)\r\n\r\nThe value of discriminator property ('entityType') must be equal to 'unit'", - "x-discriminator-value": "unit", - "x-discriminator-name": "entityType" - }, - "GsaUnitEquationErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaUnitEquationErrorReason" + }, + "readOnly": true } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaGeneralUnitEquationErrorDetail](#model-GsaGeneralUnitEquationErrorDetail)\r\n * [GsaUnknownUnitSymbolUnitEquationErrorDetail](#model-GsaUnknownUnitSymbolUnitEquationErrorDetail)\r\n * [GsaBracketMismatchUnitEquationErrorDetail](#model-GsaBracketMismatchUnitEquationErrorDetail)\r\n * [GsaNumberParsingUnitEquationErrorDetail](#model-GsaNumberParsingUnitEquationErrorDetail)\r\n * [GsaUnitAsExponentUnitEquationErrorDetail](#model-GsaUnitAsExponentUnitEquationErrorDetail)\r\n * [GsaDivideByZeroUnitEquationErrorDetail](#model-GsaDivideByZeroUnitEquationErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "general": "#/components/schemas/GsaGeneralUnitEquationErrorDetail", - "unknownUnitSymbol": "#/components/schemas/GsaUnknownUnitSymbolUnitEquationErrorDetail", - "bracketMismatch": "#/components/schemas/GsaBracketMismatchUnitEquationErrorDetail", - "numberParsing": "#/components/schemas/GsaNumberParsingUnitEquationErrorDetail", - "unitAsExponent": "#/components/schemas/GsaUnitAsExponentUnitEquationErrorDetail", - "divideByZero": "#/components/schemas/GsaDivideByZeroUnitEquationErrorDetail" - } - } - }, - "GsaUnitEquationErrorReason": { - "enum": [ - "general", - "unknownUnitSymbol", - "bracketMismatch", - "numberParsing", - "unitAsExponent", - "divideByZero" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • general: The equation is not valid.
    • \r\n
  • unknownUnitSymbol: Unknown unit in equation.
    • \r\n
  • bracketMismatch: Mismatched brackets in unit equation.
    • \r\n
  • numberParsing: Error parsing number in unit equation.
    • \r\n
  • unitAsExponent: Cannot raise to the power of a unit.
    • \r\n
  • divideByZero: Cannot divide by zero.
    • \r\n
\r\n" + "description": "Represents a set of unit conversions for each source unit.\r\nFailures are included alongside the conversions for any source units that could not be converted." }, "GsaUnitEquivalent": { "required": [ @@ -124629,53 +85880,17 @@ "type": "object", "properties": { "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" + "$ref": "#/components/schemas/GsaUnit" }, "unitSystem": { - "$ref": "#/components/schemas/GsaSlimEntity" + "$ref": "#/components/schemas/GsaUnitSystem" }, "equivalentUnit": { - "$ref": "#/components/schemas/GsaSlimUnit" + "$ref": "#/components/schemas/GsaUnit" } }, "additionalProperties": false }, - "GsaUnitEquivalentErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNoSuchUnitUnitEquivalentErrorDetail](#model-GsaNoSuchUnitUnitEquivalentErrorDetail)\r\n * [GsaNoSuchUnitSystemUnitEquivalentErrorDetail](#model-GsaNoSuchUnitSystemUnitEquivalentErrorDetail)\r\n * [GsaIncompatibleUnitsErrorDetail](#model-GsaIncompatibleUnitsErrorDetail)\r\n * [GsaInvalidEquivalenceTargetErrorDetail](#model-GsaInvalidEquivalenceTargetErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "noSuchUnit": "#/components/schemas/GsaNoSuchUnitUnitEquivalentErrorDetail", - "noSuchUnitSystem": "#/components/schemas/GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "incompatibleUnits": "#/components/schemas/GsaIncompatibleUnitsErrorDetail", - "invalidEquivalenceTarget": "#/components/schemas/GsaInvalidEquivalenceTargetErrorDetail" - } - } - }, - "GsaUnitEquivalentErrorReason": { - "enum": [ - "noSuchUnit", - "noSuchUnitSystem", - "incompatibleUnits", - "invalidEquivalenceTarget" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • noSuchUnit: Could not find the unit with the given GUID.
    • \r\n
  • noSuchUnitSystem: Could not find the unit system with the given GUID.
    • \r\n
  • incompatibleUnits: Could not set a unit equivalent as the unit was incompatible with the equivalent unit.
    • \r\n
  • invalidEquivalenceTarget: Could not set a unit equivalent as the equivalent unit is itself equivalent to another unit.
    • \r\n
\r\n" - }, "GsaUnitEquivalentsInfo": { "type": "object", "properties": { @@ -124689,44 +85904,6 @@ }, "additionalProperties": false }, - "GsaUnitErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaUnitErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaEmptySymbolUnitErrorDetail](#model-GsaEmptySymbolUnitErrorDetail)\r\n * [GsaDuplicateSymbolUnitErrorDetail](#model-GsaDuplicateSymbolUnitErrorDetail)\r\n * [GsaSymbolCannotContainCommaUnitErrorDetail](#model-GsaSymbolCannotContainCommaUnitErrorDetail)\r\n * [GsaNamedEntityUnitErrorDetail](#model-GsaNamedEntityUnitErrorDetail)\r\n * [GsaEquationUnitErrorDetail](#model-GsaEquationUnitErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "emptySymbol": "#/components/schemas/GsaEmptySymbolUnitErrorDetail", - "duplicateSymbol": "#/components/schemas/GsaDuplicateSymbolUnitErrorDetail", - "symbolCannotContainComma": "#/components/schemas/GsaSymbolCannotContainCommaUnitErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityUnitErrorDetail", - "equation": "#/components/schemas/GsaEquationUnitErrorDetail" - } - } - }, - "GsaUnitErrorReason": { - "enum": [ - "emptySymbol", - "duplicateSymbol", - "symbolCannotContainComma", - "namedEntity", - "equation" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • emptySymbol: Unit must have a symbol
    • \r\n
  • duplicateSymbol: A unit with the symbol already exists.
    • \r\n
  • symbolCannotContainComma: Unit symbol cannot contain a comma.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • equation: The equation is not valid.
    • \r\n
\r\n" - }, "GsaUnitMapping": { "required": [ "equivalentUnit", @@ -124763,8 +85940,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -124783,128 +85959,53 @@ "unitSystems": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimLocalizedEntity" + "$ref": "#/components/schemas/GsaSlimUnitSystem" }, "nullable": true } }, "additionalProperties": false }, - "GsaUnitUpdateException": { + "GsaUnitUsage": { "required": [ - "guid" + "attributes", + "constants", + "expressions", + "parameters", + "units" ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnitUsage": { "type": "object", "properties": { "attributes": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimAttribute" - }, - "nullable": true + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true + } }, "constants": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true + } }, "expressions": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimExpression" - }, - "nullable": true + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } }, "units": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUnit" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnitUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } + "$ref": "#/components/schemas/GsaSlimUnit" } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'unit'", - "x-discriminator-value": "unit", - "x-discriminator-name": "referencedByType" - }, - "GsaUnitUsageType": { - "enum": [ - "attributes", - "parameters", - "constants", - "expressions", - "units" - ], - "type": "string" - }, - "GsaUnitsGroupingInfo": { - "type": "object", - "properties": { - "unitGroups": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimUnit" - } - }, - "nullable": true - } }, "additionalProperties": false }, @@ -124914,266 +86015,13 @@ "units": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUnit" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnknownUnitSymbolUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "required": [ - "symbol" - ], - "type": "object", - "properties": { - "symbol": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unknownUnitSymbol'", - "x-discriminator-value": "unknownUnitSymbol", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedAttributeGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedAttributeGuids'", - "x-discriminator-value": "unresolvedAttributeGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedBreadcrumb": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaBreadcrumb" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaBreadcrumb](#model-GsaBreadcrumb)\r\n\r\nThe value of discriminator property ('breadcrumbType') must be equal to 'unresolved'", - "x-discriminator-value": "unresolved", - "x-discriminator-name": "breadcrumbType" - }, - "GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedCrossDatabaseRecordLinkGroupGuids'", - "x-discriminator-value": "unresolvedCrossDatabaseRecordLinkGroupGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedParameterGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedParameterGuids'", - "x-discriminator-value": "unresolvedParameterGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedRecordLinkGroupGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedRecordLinkGroupGuids'", - "x-discriminator-value": "unresolvedRecordLinkGroupGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedReverseRecordLinkGroupsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "recordLinkGroupGuidsWithNoReverseLinkGroup" - ], - "type": "object", - "properties": { - "recordLinkGroupGuidsWithNoReverseLinkGroup": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedReverseRecordLinkGroups'", - "x-discriminator-value": "unresolvedReverseRecordLinkGroups", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedTargetAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTargetAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTargetAttribute](#model-GsaTargetAttribute)\r\n\r\nThe value of discriminator property ('targetType') must be equal to 'unresolved'", - "x-discriminator-value": "unresolved", - "x-discriminator-name": "targetType" - }, - "GsaUpdateAccessControl": { - "required": [ - "mode" - ], - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/GsaAccessControlMode" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdatePermissionBasedAccessControl](#model-GsaUpdatePermissionBasedAccessControl)\r\n * [GsaUpdateAttributeBasedAccessControl](#model-GsaUpdateAttributeBasedAccessControl)", - "discriminator": { - "propertyName": "mode", - "mapping": { - "permissionBased": "#/components/schemas/GsaUpdatePermissionBasedAccessControl", - "attributeBased": "#/components/schemas/GsaUpdateAttributeBasedAccessControl" - } - } - }, - "GsaUpdateAccessControlCategory": { - "type": "object", - "properties": { - "tableMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategoryTableMapping" + "$ref": "#/components/schemas/GsaSlimNamedUnit" }, - "description": "Optionally maps an attribute, and values applied to the table, for each table.\r\nReplaces all existing table mappings with the provided list.\r\nThere can be at most one entry for each table.\r\nExisting mappings for tables not included in this list will be deleted.\r\nTo remove an existing mapping, include the table with a null attribute.\r\nTo remove all mappings, set this property to null.\r\nIf this property is omitted, table mappings are not changed.", "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" } }, "additionalProperties": false }, - "GsaUpdateAccessControlCategoryTableMapping": { - "required": [ - "table" - ], - "type": "object", - "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "description": "The discrete values applied to the table for this mapping.\r\nIf omitted and a mapping already exists for this table and attribute, the existing values are kept.\r\nIf omitted and the attribute changed, any existing table discrete values are removed.\r\nSet to null or an empty array to remove all table discrete values.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "\r\n\r\ntable: The table this mapping applies to. Required.\r\n\r\nattribute: The discrete attribute to map for this table. If omitted and a mapping already exists for this table, the existing attribute is kept. Set to null to remove the mapping for this table entirely." - }, "GsaUpdateAllProfilesInfo": { "type": "object", "properties": { @@ -125203,6 +86051,9 @@ "defaultThresholdType": { "$ref": "#/components/schemas/GsaAttributeThresholdType" }, + "axisName": { + "$ref": "#/components/schemas/GsaUpdateAxisName" + }, "helpPath": { "type": "string", "nullable": true @@ -125215,15 +86066,6 @@ "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches.\r\nIf not specified, it will be set to the default value for the attribute type.", "nullable": true }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Set a display name for different languages.\r\nSupported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\".", - "nullable": true - }, "name": { "type": "string" }, @@ -125233,7 +86075,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdatePointAttribute](#model-GsaUpdatePointAttribute)\r\n * [GsaUpdateIntegerAttribute](#model-GsaUpdateIntegerAttribute)\r\n * [GsaUpdateRangeAttribute](#model-GsaUpdateRangeAttribute)\r\n * [GsaUpdateLogicalAttribute](#model-GsaUpdateLogicalAttribute)\r\n * [GsaUpdateShortTextAttribute](#model-GsaUpdateShortTextAttribute)\r\n * [GsaUpdateLongTextAttribute](#model-GsaUpdateLongTextAttribute)\r\n * [GsaUpdateDateTimeAttribute](#model-GsaUpdateDateTimeAttribute)\r\n * [GsaUpdateDiscreteAttribute](#model-GsaUpdateDiscreteAttribute)\r\n * [GsaUpdateHyperlinkAttribute](#model-GsaUpdateHyperlinkAttribute)\r\n * [GsaUpdateFileAttribute](#model-GsaUpdateFileAttribute)\r\n * [GsaUpdatePictureAttribute](#model-GsaUpdatePictureAttribute)\r\n * [GsaUpdateTabularAttribute](#model-GsaUpdateTabularAttribute)\r\n * [GsaUpdateFloatFunctionalAttribute](#model-GsaUpdateFloatFunctionalAttribute)\r\n * [GsaUpdateDiscreteFunctionalAttribute](#model-GsaUpdateDiscreteFunctionalAttribute)\r\n * [GsaUpdateMathsFunctionalAttribute](#model-GsaUpdateMathsFunctionalAttribute)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdatePointAttribute\r\n * GsaUpdateIntegerAttribute\r\n * GsaUpdateRangeAttribute\r\n * GsaUpdateLogicalAttribute\r\n * GsaUpdateShortTextAttribute\r\n * GsaUpdateLongTextAttribute\r\n * GsaUpdateDateTimeAttribute\r\n * GsaUpdateDiscreteAttribute\r\n * GsaUpdateHyperlinkAttribute\r\n * GsaUpdateFileAttribute\r\n * GsaUpdatePictureAttribute\r\n * GsaUpdateTabularAttribute\r\n * GsaUpdateFloatFunctionalAttribute\r\n * GsaUpdateDiscreteFunctionalAttribute\r\n * GsaUpdateMathsFunctionalAttribute", "discriminator": { "propertyName": "type", "mapping": { @@ -125255,29 +86097,6 @@ } } }, - "GsaUpdateAttributeBasedAccessControl": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUpdateAccessControl" - }, - { - "required": [ - "updateCurrentRuleEngine" - ], - "type": "object", - "properties": { - "updateCurrentRuleEngine": { - "$ref": "#/components/schemas/GsaUpdateCurrentRuleEngine" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAccessControl](#model-GsaUpdateAccessControl)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'attributeBased'", - "x-discriminator-value": "attributeBased", - "x-discriminator-name": "mode" - }, "GsaUpdateAxisName": { "required": [ "name" @@ -125364,23 +86183,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateRecordLinkGroup](#model-GsaUpdateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", + "description": "\r\n\r\nThis extends: GsaUpdateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", "x-discriminator-value": "crossDatabase", "x-discriminator-name": "type" }, - "GsaUpdateCurrentRuleEngine": { - "required": [ - "fullyQualifiedTypeName" - ], - "type": "object", - "properties": { - "fullyQualifiedTypeName": { - "type": "string", - "description": "The fully qualified name of the rule engine implementation." - } - }, - "additionalProperties": false - }, "GsaUpdateDataRule": { "type": "object", "properties": { @@ -125420,7 +86226,8 @@ }, "currencyCode": { "type": "string", - "description": "The currency code on the database. Can only be edited by a database data administrator" + "description": "The currency code on the database. Can only be edited by a database data administrator", + "nullable": true }, "versionGuid": { "type": "string", @@ -125436,10 +86243,6 @@ "type": "string", "description": "The name of the database. Can only be edited by a database data administrator" }, - "isImplicitProfileDisabled": { - "type": "boolean", - "description": "Whether the implicit Profile for this database is disabled. Can only be edited by a database data administrator" - }, "isReadOnly": { "type": "boolean", "description": "True if the database should be set to read only. Can only be edited by a system administrator" @@ -125451,15 +86254,12 @@ }, "databaseKey": { "type": "string", - "description": "The unique key of the database. Can only be edited by a system administrator" + "description": "The unique key of the database. Can only be edited by a system administrator", + "nullable": true }, "dataSource": { "type": "string", - "description": "The SQL server data source. Can only be edited by a system administrator" - }, - "useConfigurationDatabaseCredentials": { - "type": "boolean", - "description": "Set to true if the SQL connection to the database should use the same credentials as connection to Configuration Database. Can only be edited by a system administrator", + "description": "The SQL server data source. Can only be edited by a system administrator", "nullable": true }, "useIntegratedSecurity": { @@ -125479,7 +86279,8 @@ }, "initialCatalog": { "type": "string", - "description": "The name of the database in SQL server. Can only be edited by a system administrator" + "description": "The name of the database in SQL server. Can only be edited by a system administrator", + "nullable": true }, "additionalSqlParameters": { "type": "string", @@ -125490,35 +86291,6 @@ "type": "integer", "description": "The MI loading order for the database. Can only be edited by a system administrator", "format": "int32" - }, - "defaultTable": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false - }, - "GsaUpdateDatabaseSecurityGroups": { - "type": "object", - "properties": { - "adminGroup": { - "type": "string", - "nullable": true - }, - "grantGroup": { - "type": "string", - "nullable": true - }, - "powerUserGroup": { - "type": "string", - "nullable": true - }, - "writeGroup": { - "type": "string", - "nullable": true - }, - "readGroup": { - "type": "string", - "nullable": true } }, "additionalProperties": false @@ -125534,46 +86306,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, - "GsaUpdateDefaultDatabase": { - "required": [ - "defaultDatabaseKey" - ], - "type": "object", - "properties": { - "defaultDatabaseKey": { - "type": "string" - } - }, - "additionalProperties": false - }, - "GsaUpdateDefaultFallbackSecurityGroups": { - "type": "object", - "properties": { - "systemGroup": { - "type": "string" - }, - "adminGroup": { - "type": "string" - }, - "grantGroup": { - "type": "string" - }, - "powerUserGroup": { - "type": "string" - }, - "writeGroup": { - "type": "string" - }, - "readGroup": { - "type": "string" - } - }, - "additionalProperties": false - }, "GsaUpdateDefaultProfile": { "required": [ "key" @@ -125603,7 +86339,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -125626,7 +86362,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", "x-discriminator-value": "discreteFunctional", "x-discriminator-name": "type" }, @@ -125646,7 +86382,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaUpdateDiscreteFunctionalAttributeParameter](#model-GsaUpdateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaUpdateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -125669,7 +86405,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateDiscreteFunctionalAttributeParameter](#model-GsaUpdateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -125689,7 +86425,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteFunctionalAttributeDiscreteParameter](#model-GsaUpdateDiscreteFunctionalAttributeDiscreteParameter)\r\n * [GsaUpdateDiscreteFunctionalAttributeNumericParameter](#model-GsaUpdateDiscreteFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaUpdateDiscreteFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -125705,20 +86441,11 @@ "$ref": "#/components/schemas/GsaUpdateParameter" }, { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdateDiscreteParameterValue" - }, - "description": "Update the set of parameter values.\r\nThis can result in adding, modifying, deleting and reordering parameter values.\r\nExisting parameter values will be matched by GUID.\r\nIf an existing parameter value is not included, it will be deleted.\r\nIf a GUID is not provided, or the GUID does not match an existing value, a new value will be created.\r\nNew values must have a name." - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameter](#model-GsaUpdateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -125741,7 +86468,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterContent](#model-GsaUpdateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -125761,7 +86488,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterValue](#model-GsaUpdateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -125786,13 +86513,6 @@ "isOrdered": { "type": "boolean" }, - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutDiscreteValue" - }, - "nullable": true - }, "name": { "type": "string" }, @@ -125803,32 +86523,34 @@ }, "additionalProperties": false }, - "GsaUpdateDisplayNames": { - "type": "object", - "properties": { - "displayNames": { - "$ref": "#/components/schemas/GsaGrid" - } - }, - "additionalProperties": false - }, - "GsaUpdateDisplayNamesResponse": { - "required": [ - "numberDeleted", - "numberUpdated" - ], + "GsaUpdateDynamicRecordLinkGroup": { "type": "object", - "properties": { - "numberUpdated": { - "type": "integer", - "format": "int32" + "allOf": [ + { + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, - "numberDeleted": { - "type": "integer", - "format": "int32" + { + "type": "object", + "properties": { + "forbidOrphans": { + "type": "boolean" + }, + "referentialIntegrityModel": { + "$ref": "#/components/schemas/GsaReferentialIntegrityModel" + }, + "attributePairs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" + } + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaUpdateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamic'", + "x-discriminator-value": "dynamic", + "x-discriminator-name": "type" }, "GsaUpdateExpression": { "type": "object", @@ -125877,7 +86599,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "type" }, @@ -125901,15 +86623,12 @@ }, "isRange": { "type": "boolean" - }, - "axisName": { - "$ref": "#/components/schemas/GsaUpdateAxisName" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", "x-discriminator-value": "floatFunctional", "x-discriminator-name": "type" }, @@ -125929,7 +86648,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaUpdateFloatFunctionalAttributeParameter](#model-GsaUpdateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaUpdateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -125958,7 +86677,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: [GsaUpdateFloatFunctionalAttributeParameter](#model-GsaUpdateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: GsaUpdateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -125978,7 +86697,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateFloatFunctionalAttributeDiscreteParameter](#model-GsaUpdateFloatFunctionalAttributeDiscreteParameter)\r\n * [GsaUpdateFloatFunctionalAttributeNumericParameter](#model-GsaUpdateFloatFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateFloatFunctionalAttributeDiscreteParameter\r\n * GsaUpdateFloatFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -126011,7 +86730,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "type" }, @@ -126027,15 +86746,12 @@ "isUnique": { "type": "boolean", "description": "Whether or not the attribute is constrained to contain a unique value" - }, - "axisName": { - "$ref": "#/components/schemas/GsaUpdateAxisName" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -126082,27 +86798,6 @@ }, "additionalProperties": false }, - "GsaUpdateLayoutSection": { - "type": "object", - "properties": { - "sectionItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutLayoutItem" - }, - "description": "Update the set of items, in order.\r\nIf an existing item is not included, it will be deleted." - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Update dto for Layout Sections" - }, "GsaUpdateLinkedAttributeTabularColumn": { "type": "object", "allOf": [ @@ -126119,7 +86814,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", "x-discriminator-value": "linkedAttribute", "x-discriminator-name": "columnType" }, @@ -126139,7 +86834,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", "x-discriminator-value": "linkedColumn", "x-discriminator-name": "columnType" }, @@ -126154,7 +86849,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", "x-discriminator-value": "linkedRecord", "x-discriminator-name": "columnType" }, @@ -126174,7 +86869,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", "x-discriminator-value": "localDateTime", "x-discriminator-name": "columnType" }, @@ -126197,7 +86892,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", "x-discriminator-value": "localDiscrete", "x-discriminator-name": "columnType" }, @@ -126217,7 +86912,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", "x-discriminator-value": "localFile", "x-discriminator-name": "columnType" }, @@ -126237,7 +86932,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", "x-discriminator-value": "localHyperlink", "x-discriminator-name": "columnType" }, @@ -126257,7 +86952,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", "x-discriminator-value": "localInteger", "x-discriminator-name": "columnType" }, @@ -126277,7 +86972,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", "x-discriminator-value": "localLogical", "x-discriminator-name": "columnType" }, @@ -126297,7 +86992,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", "x-discriminator-value": "localLongText", "x-discriminator-name": "columnType" }, @@ -126317,7 +87012,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", "x-discriminator-value": "localPicture", "x-discriminator-name": "columnType" }, @@ -126340,7 +87035,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", "x-discriminator-value": "localPoint", "x-discriminator-name": "columnType" }, @@ -126363,7 +87058,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", "x-discriminator-value": "localRange", "x-discriminator-name": "columnType" }, @@ -126383,7 +87078,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", "x-discriminator-value": "localShortText", "x-discriminator-name": "columnType" }, @@ -126398,7 +87093,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "type" }, @@ -126413,7 +87108,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "type" }, @@ -126485,15 +87180,12 @@ }, "allowAnonymousExpressions": { "type": "boolean" - }, - "axisName": { - "$ref": "#/components/schemas/GsaUpdateAxisName" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "type" }, @@ -126509,13 +87201,6 @@ "unit": { "$ref": "#/components/schemas/GsaSlimEntity" }, - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdateNumericParameterValue" - }, - "description": "Update the set of parameter values.\r\nThis can result in adding, modifying and deleting parameter values.\r\nNumeric parameter values can not be reordered - they are ordered by numeric value.\r\nExisting parameter values will be matched by GUID.\r\nIf an existing parameter value is not included, it will be deleted.\r\nIf a GUID is not provided, or the GUID does not match an existing value, a new value will be created.\r\nNew values must have a value." - }, "interpolationType": { "$ref": "#/components/schemas/GsaParameterInterpolationType" }, @@ -126526,7 +87211,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameter](#model-GsaUpdateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -126551,7 +87236,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterContent](#model-GsaUpdateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -126576,7 +87261,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterValue](#model-GsaUpdateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -126589,16 +87274,14 @@ "type": { "$ref": "#/components/schemas/GsaParameterType" }, + "helpPath": { + "type": "string", + "nullable": true + }, "defaultParameterValueGuid": { "type": "string", - "description": "Use to set the default value when the parameter value GUID is known.", "format": "uuid" }, - "defaultParameterValueIndex": { - "type": "integer", - "description": "Use to set the default value when also updating parameter values, if the parameter value GUID is not known.\r\nFor example when creating a new parameter value.", - "format": "int32" - }, "name": { "type": "string" }, @@ -126608,7 +87291,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteParameter](#model-GsaUpdateDiscreteParameter)\r\n * [GsaUpdateNumericParameter](#model-GsaUpdateNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteParameter\r\n * GsaUpdateNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -126632,7 +87315,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteParameterContent](#model-GsaUpdateDiscreteParameterContent)\r\n * [GsaUpdateNumericParameterContent](#model-GsaUpdateNumericParameterContent)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteParameterContent\r\n * GsaUpdateNumericParameterContent", "discriminator": { "propertyName": "type", "mapping": { @@ -126656,7 +87339,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteParameterValue](#model-GsaUpdateDiscreteParameterValue)\r\n * [GsaUpdateNumericParameterValue](#model-GsaUpdateNumericParameterValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteParameterValue\r\n * GsaUpdateNumericParameterValue", "discriminator": { "propertyName": "type", "mapping": { @@ -126665,145 +87348,6 @@ } } }, - "GsaUpdatePermission": { - "type": "object", - "properties": { - "role": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionAccessControl": { - "required": [ - "permission" - ], - "type": "object", - "properties": { - "permission": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "canRead": { - "type": "boolean" - }, - "canWrite": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionBasedAccessControl": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUpdateAccessControl" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAccessControl](#model-GsaUpdateAccessControl)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'permissionBased'", - "x-discriminator-value": "permissionBased", - "x-discriminator-name": "mode" - }, - "GsaUpdatePermissionCategory": { - "type": "object", - "properties": { - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutPermission" - }, - "description": "This can result in adding, modifying and deleting permissions.\r\nTo insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission).\r\nTo modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission).\r\nExisting permissions will be matched by GUID.\r\nIf an existing permission is not included, it will be deleted." - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionCategoryAccessControl": { - "required": [ - "category", - "permissionAccessControls" - ], - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "permissionAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdatePermissionAccessControl" - } - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionCategoryAccessControlRequest": { - "required": [ - "categoryAccessControls" - ], - "type": "object", - "properties": { - "categoryAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControl" - } - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionCategoryAccessControlsOperationRequest": { - "required": [ - "categoryAccessControls", - "entities" - ], - "type": "object", - "properties": { - "categoryAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControl" - } - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlEntity" - } - } - }, - "additionalProperties": false - }, "GsaUpdatePictureAttribute": { "type": "object", "allOf": [ @@ -126815,7 +87359,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -126840,15 +87384,12 @@ "$ref": "#/components/schemas/GsaSlimEntity" }, "nullable": true - }, - "axisName": { - "$ref": "#/components/schemas/GsaUpdateAxisName" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -126909,136 +87450,6 @@ "additionalProperties": false, "description": "A table within a profile. Contains display customization." }, - "GsaUpdatePutDiscreteValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutDiscreteValue" - }, - { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutDiscreteValue](#model-GsaPutDiscreteValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'update'", - "x-discriminator-value": "update", - "x-discriminator-name": "type" - }, - "GsaUpdatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutLayoutItem" - }, - { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutLayoutItem](#model-GsaPutLayoutItem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'update'", - "x-discriminator-value": "update", - "x-discriminator-name": "type" - }, - "GsaUpdatePutPermission": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermission" - }, - { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - }, - "description": { - "type": "string", - "description": "The description of the permission.", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Update a Permission.\r\nThe Guid should match the Guid of the existing Permission to update.\r\n\r\nThis extends: [GsaPutPermission](#model-GsaPutPermission)\r\n\r\nThe value of discriminator property ('type') must be equal to 'update'", - "x-discriminator-value": "update", - "x-discriminator-name": "type" - }, - "GsaUpdatePutPermissionCategory": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermissionCategory" - }, - { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutPermission" - }, - "description": "This can result in adding, modifying and deleting permissions.\r\nTo insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission).\r\nTo modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission).\r\nExisting permissions will be matched by GUID.\r\nIf an existing permission is not included, it will be deleted." - } - } - } - ], - "additionalProperties": false, - "description": "Update a Permission Category.\r\nThe Guid should match the Guid of the existing Permission Category to update.\r\n\r\nThis extends: [GsaPutPermissionCategory](#model-GsaPutPermissionCategory)\r\n\r\nThe value of discriminator property ('type') must be equal to 'update'", - "x-discriminator-value": "update", - "x-discriminator-name": "type" - }, "GsaUpdateRangeAttribute": { "type": "object", "allOf": [ @@ -127050,15 +87461,12 @@ "properties": { "unit": { "$ref": "#/components/schemas/GsaSlimEntity" - }, - "axisName": { - "$ref": "#/components/schemas/GsaUpdateAxisName" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, @@ -127083,12 +87491,12 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateStaticRecordLinkGroup](#model-GsaUpdateStaticRecordLinkGroup)\r\n * [GsaUpdateSmartRecordLinkGroup](#model-GsaUpdateSmartRecordLinkGroup)\r\n * [GsaUpdateCrossDatabaseRecordLinkGroup](#model-GsaUpdateCrossDatabaseRecordLinkGroup)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateStaticRecordLinkGroup\r\n * GsaUpdateDynamicRecordLinkGroup\r\n * GsaUpdateCrossDatabaseRecordLinkGroup", "discriminator": { "propertyName": "type", "mapping": { "static": "#/components/schemas/GsaUpdateStaticRecordLinkGroup", - "smart": "#/components/schemas/GsaUpdateSmartRecordLinkGroup", + "dynamic": "#/components/schemas/GsaUpdateDynamicRecordLinkGroup", "crossDatabase": "#/components/schemas/GsaUpdateCrossDatabaseRecordLinkGroup" } } @@ -127164,43 +87572,6 @@ }, "additionalProperties": false }, - "GsaUpdateRootFolderErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "You cannot update the root folder.\r\n\r\nThis extends: [GsaFolderErrorDetail](#model-GsaFolderErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'updateRoot'", - "x-discriminator-value": "updateRoot", - "x-discriminator-name": "reason" - }, - "GsaUpdateRunStatus": { - "enum": [ - "Registered", - "UploadInProgress", - "Uploaded", - "UploadFailed", - "DryRunPending", - "DryRunCancelling", - "DryRunCancelled", - "DryRunInProgress", - "DryRunComplete", - "DryRunFailed", - "ApplyPending", - "ApplyInProgress", - "ApplyCancelling", - "ApplyCancelled", - "ApplyComplete", - "ApplyFailed" - ], - "type": "string", - "description": "Represents the possible states of an update.

Possible values:

\r\n
    \r\n
  • Registered: The update token has been registered with the service.
    • \r\n
  • UploadInProgress: The update file has been partially uploaded.
    • \r\n
  • Uploaded: The update file has been completely uploaded.
    • \r\n
  • UploadFailed: The upload failed.
    • \r\n
  • DryRunPending: A dry run for this update has been queued, but it not yet in progress.
    • \r\n
  • DryRunCancelling: A request to cancel the dry run for this update has been issued but the dry run has not yet been cancelled.
    • \r\n
  • DryRunCancelled: The dry run for this update was cancelled.
    • \r\n
  • DryRunInProgress: The dry run for this update is in progress.
    • \r\n
  • DryRunComplete: The dry run for this update is complete.
    • \r\n
  • DryRunFailed: The dry run for this update failed.
    • \r\n
  • ApplyPending: An apply operation for this update has been queued, but is not yet in progress.
    • \r\n
  • ApplyInProgress: The update is being applied to the target database.
    • \r\n
  • ApplyCancelling: A request to cancel the apply process has been issued but the apply process has not yet been cancelled.
    • \r\n
  • ApplyCancelled: The update was cancelled during the apply process.
    • \r\n
  • ApplyComplete: The update was successfully applied to the target database.
    • \r\n
  • ApplyFailed: The update was not successfully applied to the target database.
    • \r\n
\r\n" - }, "GsaUpdateShortTextAttribute": { "type": "object", "allOf": [ @@ -127221,40 +87592,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, - "GsaUpdateSmartRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" - }, - { - "type": "object", - "properties": { - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" - }, - "description": "The attribute pairs cannot be updated other than by creating a new set.\r\nThere must be at least one and not more than three attribute pairs." - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateRecordLinkGroup](#model-GsaUpdateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "type" - }, "GsaUpdateStandardName": { "type": "object", "properties": { @@ -127275,7 +87616,7 @@ "mappedRecordLinkGroups": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUpdateStaticRecordLinkGroupMapping" + "$ref": "#/components/schemas/GsaSlimEntity" }, "nullable": true }, @@ -127312,26 +87653,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateRecordLinkGroup](#model-GsaUpdateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", + "description": "\r\n\r\nThis extends: GsaUpdateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", "x-discriminator-value": "static", "x-discriminator-name": "type" }, - "GsaUpdateStaticRecordLinkGroupMapping": { - "required": [ - "isReverse", - "staticRecordLinkGroup" - ], - "type": "object", - "properties": { - "staticRecordLinkGroup": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "isReverse": { - "type": "boolean" - } - }, - "additionalProperties": false - }, "GsaUpdateSubset": { "type": "object", "properties": { @@ -127367,34 +87692,6 @@ "format": "uuid", "nullable": true }, - "qualitySystemGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "legalDisclaimer": { - "type": "string", - "nullable": true - }, - "datasheetHeader": { - "type": "string", - "nullable": true - }, - "datasheetFooter": { - "type": "string", - "nullable": true - }, - "tableTypes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If specified any existing table types are replaced.", - "nullable": true - }, - "shouldShowVersionControlSignatures": { - "type": "boolean" - }, "name": { "type": "string" }, @@ -127437,7 +87734,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ntarget: Changing an existing target may cause some columns to become unavailable.\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "\r\n\r\ntarget: Changing an existing target may cause some columns to become unavailable.\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, @@ -127497,7 +87794,7 @@ } }, "additionalProperties": false, - "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * [GsaUpdateLinkedAttributeTabularColumn](#model-GsaUpdateLinkedAttributeTabularColumn)\r\n * [GsaUpdateLinkedColumnTabularColumn](#model-GsaUpdateLinkedColumnTabularColumn)\r\n * [GsaUpdateLinkedRecordTabularColumn](#model-GsaUpdateLinkedRecordTabularColumn)\r\n * [GsaUpdateLocalPointTabularColumn](#model-GsaUpdateLocalPointTabularColumn)\r\n * [GsaUpdateLocalRangeTabularColumn](#model-GsaUpdateLocalRangeTabularColumn)\r\n * [GsaUpdateLocalIntegerTabularColumn](#model-GsaUpdateLocalIntegerTabularColumn)\r\n * [GsaUpdateLocalLogicalTabularColumn](#model-GsaUpdateLocalLogicalTabularColumn)\r\n * [GsaUpdateLocalShortTextTabularColumn](#model-GsaUpdateLocalShortTextTabularColumn)\r\n * [GsaUpdateLocalLongTextTabularColumn](#model-GsaUpdateLocalLongTextTabularColumn)\r\n * [GsaUpdateLocalDateTimeTabularColumn](#model-GsaUpdateLocalDateTimeTabularColumn)\r\n * [GsaUpdateLocalDiscreteTabularColumn](#model-GsaUpdateLocalDiscreteTabularColumn)\r\n * [GsaUpdateLocalHyperlinkTabularColumn](#model-GsaUpdateLocalHyperlinkTabularColumn)\r\n * [GsaUpdateLocalFileTabularColumn](#model-GsaUpdateLocalFileTabularColumn)\r\n * [GsaUpdateLocalPictureTabularColumn](#model-GsaUpdateLocalPictureTabularColumn)\r\n * [GsaUpdateUnavailableTabularColumn](#model-GsaUpdateUnavailableTabularColumn)", + "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * GsaUpdateLinkedAttributeTabularColumn\r\n * GsaUpdateLinkedColumnTabularColumn\r\n * GsaUpdateLinkedRecordTabularColumn\r\n * GsaUpdateLocalPointTabularColumn\r\n * GsaUpdateLocalRangeTabularColumn\r\n * GsaUpdateLocalIntegerTabularColumn\r\n * GsaUpdateLocalLogicalTabularColumn\r\n * GsaUpdateLocalShortTextTabularColumn\r\n * GsaUpdateLocalLongTextTabularColumn\r\n * GsaUpdateLocalDateTimeTabularColumn\r\n * GsaUpdateLocalDiscreteTabularColumn\r\n * GsaUpdateLocalHyperlinkTabularColumn\r\n * GsaUpdateLocalFileTabularColumn\r\n * GsaUpdateLocalPictureTabularColumn\r\n * GsaUpdateUnavailableTabularColumn", "discriminator": { "propertyName": "columnType", "mapping": { @@ -127519,51 +87816,6 @@ } } }, - "GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object", - "properties": { - "missingPropertyName": { - "type": "string", - "nullable": true - }, - "columnType": { - "$ref": "#/components/schemas/GsaTabularColumnDtoType" - } - } - } - ], - "additionalProperties": false, - "description": "A required property was not provided when creating a Tabular Column in an update.\r\nRequired properties are:\r\n - UpdateLinkedAttributeTabularColumn: LinkedAttribute\r\n - UpdateLinkedColumnTabularColumn: LinkedColumn\r\n - UpdateLocalDiscreteTabularColumn: DiscreteType\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'updateTabularColumnPropertyNotProvided'", - "x-discriminator-value": "updateTabularColumnPropertyNotProvided", - "x-discriminator-name": "reason" - }, - "GsaUpdateTabularColumnTypeAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object", - "properties": { - "columnGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Tabular Column to update is not of the same type as the existing Tabular Column with the same GUID.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'updateTabularColumnType'", - "x-discriminator-value": "updateTabularColumnType", - "x-discriminator-name": "reason" - }, "GsaUpdateUnavailableTabularColumn": { "type": "object", "allOf": [ @@ -127575,7 +87827,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", "x-discriminator-value": "unavailable", "x-discriminator-name": "columnType" }, @@ -127646,47 +87898,6 @@ }, "additionalProperties": false }, - "GsaUpgradeDatabaseException": { - "required": [ - "upgradeDatabaseFailureReason" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "upgradeDatabaseFailureReason": { - "$ref": "#/components/schemas/GsaUpgradeDatabaseFailureReason" - }, - "additionalInformation": { - "type": "string", - "nullable": true - }, - "statusCode": { - "$ref": "#/components/schemas/SystemNetHttpStatusCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaErrorDetailOfUpgradeDatabaseFailureReason" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUpgradeDatabaseFailureReason": { - "enum": [ - "unableToConnect", - "insufficientPermissions", - "unknownError" - ], - "type": "string" - }, "GsaUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -127708,45 +87919,37 @@ "mapping": { "expression": "#/components/schemas/GsaExpressionUsageDataModificationErrorDetail", "versionControlledData": "#/components/schemas/GsaVersionControlledDataUsageDataModificationErrorDetail", - "smartLinkGroup": "#/components/schemas/GsaSmartLinkGroupUsageDataModificationErrorDetail", + "dynamicLinkGroup": "#/components/schemas/GsaDynamicLinkGroupUsageDataModificationErrorDetail", "tabularAttribute": "#/components/schemas/GsaTabularAttributeUsageDataModificationErrorDetail", "xyChartTemplate": "#/components/schemas/GsaXYChartTemplateUsageDataModificationErrorDetail", "searchMask": "#/components/schemas/GsaSearchMaskUsageDataModificationErrorDetail", "securityAttribute": "#/components/schemas/GsaSecurityAttributeUsageDataModificationErrorDetail", "attribute": "#/components/schemas/GsaAttributeUsageDataModificationErrorDetail", "data": "#/components/schemas/GsaDataUsageDataModificationErrorDetail", - "defaultParameterValue": "#/components/schemas/GsaDefaultParameterValueUsageDataModificationErrorDetail", - "functionalDataDefault": "#/components/schemas/GsaFunctionalDataDefaultUsageDataModificationErrorDetail", - "multiValuedPointData": "#/components/schemas/GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "tabularColumn": "#/components/schemas/GsaTabularColumnUsageDataModificationErrorDetail", - "databaseCurrencyUnit": "#/components/schemas/GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "unit": "#/components/schemas/GsaUnitUsageDataModificationErrorDetail", - "parameter": "#/components/schemas/GsaParameterUsageDataModificationErrorDetail", - "constant": "#/components/schemas/GsaConstantUsageDataModificationErrorDetail", - "table": "#/components/schemas/GsaTableUsageDataModificationErrorDetail" + "defaultParameterValue": "#/components/schemas/GsaDefaultParameterValueUsageDataModificationErrorDetail" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataModificationErrorDetail](#model-GsaDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'usage'\r\n\r\nThis is one of: \r\n * [GsaExpressionUsageDataModificationErrorDetail](#model-GsaExpressionUsageDataModificationErrorDetail)\r\n * [GsaVersionControlledDataUsageDataModificationErrorDetail](#model-GsaVersionControlledDataUsageDataModificationErrorDetail)\r\n * [GsaSmartLinkGroupUsageDataModificationErrorDetail](#model-GsaSmartLinkGroupUsageDataModificationErrorDetail)\r\n * [GsaTabularAttributeUsageDataModificationErrorDetail](#model-GsaTabularAttributeUsageDataModificationErrorDetail)\r\n * [GsaXYChartTemplateUsageDataModificationErrorDetail](#model-GsaXYChartTemplateUsageDataModificationErrorDetail)\r\n * [GsaSearchMaskUsageDataModificationErrorDetail](#model-GsaSearchMaskUsageDataModificationErrorDetail)\r\n * [GsaSecurityAttributeUsageDataModificationErrorDetail](#model-GsaSecurityAttributeUsageDataModificationErrorDetail)\r\n * [GsaAttributeUsageDataModificationErrorDetail](#model-GsaAttributeUsageDataModificationErrorDetail)\r\n * [GsaDataUsageDataModificationErrorDetail](#model-GsaDataUsageDataModificationErrorDetail)\r\n * [GsaDefaultParameterValueUsageDataModificationErrorDetail](#model-GsaDefaultParameterValueUsageDataModificationErrorDetail)\r\n * [GsaFunctionalDataDefaultUsageDataModificationErrorDetail](#model-GsaFunctionalDataDefaultUsageDataModificationErrorDetail)\r\n * [GsaMultiValuedPointDataUsageDataModificationErrorDetail](#model-GsaMultiValuedPointDataUsageDataModificationErrorDetail)\r\n * [GsaTabularColumnUsageDataModificationErrorDetail](#model-GsaTabularColumnUsageDataModificationErrorDetail)\r\n * [GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail](#model-GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail)\r\n * [GsaUnitUsageDataModificationErrorDetail](#model-GsaUnitUsageDataModificationErrorDetail)\r\n * [GsaParameterUsageDataModificationErrorDetail](#model-GsaParameterUsageDataModificationErrorDetail)\r\n * [GsaConstantUsageDataModificationErrorDetail](#model-GsaConstantUsageDataModificationErrorDetail)\r\n * [GsaTableUsageDataModificationErrorDetail](#model-GsaTableUsageDataModificationErrorDetail)", + "description": "\r\n\r\nThis extends: GsaDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'usage'\r\n\r\nThis is one of: \r\n * GsaExpressionUsageDataModificationErrorDetail\r\n * GsaVersionControlledDataUsageDataModificationErrorDetail\r\n * GsaDynamicLinkGroupUsageDataModificationErrorDetail\r\n * GsaTabularAttributeUsageDataModificationErrorDetail\r\n * GsaXYChartTemplateUsageDataModificationErrorDetail\r\n * GsaSearchMaskUsageDataModificationErrorDetail\r\n * GsaSecurityAttributeUsageDataModificationErrorDetail\r\n * GsaAttributeUsageDataModificationErrorDetail\r\n * GsaDataUsageDataModificationErrorDetail\r\n * GsaDefaultParameterValueUsageDataModificationErrorDetail", "x-discriminator-value": "usage", "x-discriminator-name": "reason" }, - "GsaUserCapabilities": { - "required": [ - "canRead", - "canWrite" - ], + "GsaUserOrGroup": { "type": "object", "properties": { - "canRead": { - "type": "boolean", - "description": "Specifies whether the current user can read." + "identifier": { + "type": "string", + "format": "uuid" }, - "canWrite": { - "type": "boolean", - "description": "Specifies whether the current user can write." + "displayName": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true } }, "additionalProperties": false @@ -127819,64 +88022,6 @@ }, "additionalProperties": false }, - "GsaValidateUnitEquationRequest": { - "required": [ - "equation" - ], - "type": "object", - "properties": { - "equation": { - "type": "string", - "description": "The equation to check" - } - }, - "additionalProperties": false - }, - "GsaValidateUnitEquationResponse": { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "isValid": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - "description": "Details of any errors found in the equation." - } - }, - "additionalProperties": false - }, - "GsaValueNotProvidedParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Numeric parameter values must have a value.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'valueNotProvided'", - "x-discriminator-value": "valueNotProvided", - "x-discriminator-name": "reason" - }, "GsaValueSpecifier": { "required": [ "filterOn" @@ -127888,7 +88033,7 @@ } }, "additionalProperties": false, - "description": "Base class for ValueSpecifier\r\nUsed as a parameter in requests to specify filters like whether we want all identities, some guids, exclude some identities, etc.\r\n\r\nThis is one of: \r\n * [GsaAllValuesSpecifier](#model-GsaAllValuesSpecifier)\r\n * [GsaExcludeValuesSpecifier](#model-GsaExcludeValuesSpecifier)\r\n * [GsaSpecificValuesSpecifier](#model-GsaSpecificValuesSpecifier)\r\n * [GsaNoValuesSpecifier](#model-GsaNoValuesSpecifier)", + "description": "Base class for ValueSpecifier\r\nUsed as a parameter in requests to specify filters like whether we want all identities, some guids, exclude some identities, etc.\r\n\r\nThis is one of: \r\n * GsaAllValuesSpecifier\r\n * GsaExcludeValuesSpecifier\r\n * GsaSpecificValuesSpecifier\r\n * GsaNoValuesSpecifier", "discriminator": { "propertyName": "filterOn", "mapping": { @@ -127964,11 +88109,11 @@ "type": "string" }, "reason": { - "$ref": "#/components/schemas/GsaVersionControlErrorReason" + "type": "string" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaInvalidVersionStateErrorDetail](#model-GsaInvalidVersionStateErrorDetail)\r\n * [GsaNotTheLatestVersionErrorDetail](#model-GsaNotTheLatestVersionErrorDetail)\r\n * [GsaInvalidParentStateErrorDetail](#model-GsaInvalidParentStateErrorDetail)\r\n * [GsaNotVersionedErrorDetail](#model-GsaNotVersionedErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaInvalidVersionStateErrorDetail\r\n * GsaNotTheLatestVersionErrorDetail\r\n * GsaInvalidParentStateErrorDetail\r\n * GsaNotVersionedErrorDetail", "discriminator": { "propertyName": "reason", "mapping": { @@ -127979,24 +88124,6 @@ } } }, - "GsaVersionControlErrorReason": { - "enum": [ - "invalidVersionState", - "notVersioned", - "invalidParentState", - "notTheLatestVersion" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • invalidVersionState: Invalid version state.
    • \r\n
  • notVersioned: Table is not version controlled.
    • \r\n
  • invalidParentState: Tree parent is not in a valid state to perform this operation.
    • \r\n
  • notTheLatestVersion: There is a newer version.
    • \r\n
\r\n" - }, - "GsaVersionControlMode": { - "enum": [ - "read", - "write" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • read: Uses the latest version of records and tables available in read mode.
    • \r\n
  • write: Uses the latest version of records and tables available in write mode. Will error if the user does not have write access to the database.
    • \r\n
\r\n" - }, "GsaVersionControlledDataUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -128008,7 +88135,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'versionControlledData'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'versionControlledData'", "x-discriminator-value": "versionControlledData", "x-discriminator-name": "referencedByType" }, @@ -128029,7 +88156,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionNumber'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionNumber'", "x-discriminator-value": "versionNumber", "x-discriminator-name": "propertyName" }, @@ -128060,19 +88187,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionState'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionState'", "x-discriminator-value": "versionState", "x-discriminator-name": "propertyName" }, - "GsaWeightingType": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "format": "int32" - }, "GsaWithdrawRecordVersionControlException": { "type": "object", "properties": { @@ -128081,11 +88199,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "recordVersionGuid": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -128097,60 +88211,6 @@ }, "additionalProperties": false }, - "GsaXYChartTemplate": { - "required": [ - "displayNames", - "guid", - "name" - ], - "type": "object", - "properties": { - "chartTitle": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "xAxis": { - "$ref": "#/components/schemas/GsaXYTemplateAxis" - }, - "yAxis": { - "$ref": "#/components/schemas/GsaXYTemplateAxis" - }, - "useTemplateParameters": { - "type": "boolean" - }, - "parameterValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterValue" - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "GsaXYChartTemplateUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -128171,66 +88231,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'xyChartTemplate'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'xyChartTemplate'", "x-discriminator-value": "xyChartTemplate", "x-discriminator-name": "referencedByType" }, - "GsaXYChartTemplatesInfo": { - "required": [ - "entries", - "itemType", - "links" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaPaginatedItemType" - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaXYChartTemplate" - } - }, - "links": { - "$ref": "#/components/schemas/GsaPaginationLinks" - } - }, - "additionalProperties": false - }, - "GsaXYTemplateAxis": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "logarithmic": { - "type": "boolean" - }, - "bounds": { - "$ref": "#/components/schemas/GsaDataExportRange" - }, - "attributeUnit": { - "$ref": "#/components/schemas/GsaUnit" - }, - "autoScale": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "JsonPatchDocument": { "type": "object", "properties": { From 5a6d06d6b400643f7e9b1bb86b412db673780327 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot Date: Sat, 29 Aug 2026 08:51:58 +0000 Subject: [PATCH 2/2] Generate Client Library code - Automated --- .../pyproject.toml | 2 +- .../grantami/serverapi_openapi/__init__.py | 2 +- .../serverapi_openapi/v2027r1/__init__.py | 1497 +--------------- .../serverapi_openapi/v2027r1/api/__init__.py | 45 +- ...ontrol___attribute_based_categories_api.py | 552 ------ .../access_control___permission_based_api.py | 648 ------- ...s_control___permission_based_schema_api.py | 1252 ------------- .../v2027r1/api/access_control_api.py | 337 ---- .../v2027r1/api/activity_log_api.py | 149 -- .../v2027r1/api/aggregation_api.py | 16 +- .../v2027r1/api/blob_infos_api.py | 213 --- .../v2027r1/api/blobs_api.py | 336 ---- .../serverapi_openapi/v2027r1/api/data_api.py | 159 +- .../v2027r1/api/data_export_api.py | 5 +- .../v2027r1/api/data_updater_api.py | 1580 ----------------- .../v2027r1/api/database_api.py | 2 +- .../v2027r1/api/find_similar_api.py | 667 ------- .../v2027r1/api/graph_api.py | 52 +- .../v2027r1/api/help_location_api.py | 1 - .../v2027r1/api/identities_api.py | 110 +- .../v2027r1/api/integration_api.py | 1 - .../v2027r1/api/license_api.py | 137 -- .../v2027r1/api/metrics_api.py | 1 - ...=> permission_based_access_control_api.py} | 175 +- .../v2027r1/api/record_links_api.py | 663 ------- .../api/records___record_histories_api.py | 30 +- .../api/records___record_versions_api.py | 282 +-- .../v2027r1/api/schema___attributes_api.py | 871 +-------- .../api/schema___configurations_api.py | 226 +-- .../v2027r1/api/schema___constants_api.py | 13 +- .../v2027r1/api/schema___data_rules_api.py | 5 - .../v2027r1/api/schema___databases_api.py | 1020 +---------- ...___discrete_types___discrete_values_api.py | 33 +- .../api/schema___discrete_types_api.py | 43 +- .../v2027r1/api/schema___display_names_api.py | 236 --- .../v2027r1/api/schema___exporters_api.py | 255 +-- .../v2027r1/api/schema___expressions_api.py | 247 +-- .../v2027r1/api/schema___help_files_api.py | 338 +--- .../v2027r1/api/schema___home_pages_api.py | 254 +-- .../api/schema___layout_sections_api.py | 559 +----- .../v2027r1/api/schema___layouts_api.py | 291 +-- .../v2027r1/api/schema___parameters_api.py | 34 +- .../api/schema___record_link_groups_api.py | 34 +- .../v2027r1/api/schema___search_masks_api.py | 262 --- .../api/schema___search_templates_api.py | 291 --- .../api/schema___standard_names_api.py | 53 +- .../v2027r1/api/schema___subsets_api.py | 22 +- .../v2027r1/api/schema___tables_api.py | 344 +--- .../api/schema___unit_equivalents_api.py | 247 --- .../v2027r1/api/schema___units_api.py | 321 ++-- .../api/schema___xy_chart_templates_api.py | 309 ---- .../v2027r1/api/schema_api.py | 82 +- .../v2027r1/api/search_api.py | 16 +- ...roups_api.py => selection_searches_api.py} | 247 ++- ...urrencies_api.py => server_manager_api.py} | 69 +- .../v2027r1/api/status_api.py | 152 -- .../v2027r1/models/__init__.py | 1376 +------------- .../granta_mi_search_free_text_identifiers.py | 171 -- .../gsa_access_control_categories_info.py | 149 -- .../models/gsa_access_control_category.py | 251 --- ...ess_control_category_creation_exception.py | 242 --- ...sa_access_control_category_error_detail.py | 203 --- ...sa_access_control_category_error_reason.py | 54 - .../gsa_access_control_category_include.py | 45 - ...ss_control_category_no_such_entity_type.py | 48 - ...a_access_control_category_table_mapping.py | 218 --- ...ccess_control_category_update_exception.py | 242 --- ...cess_control_database_user_capabilities.py | 225 --- ...ntrol_entities_aggregation_error_detail.py | 167 -- ...sa_access_control_entities_error_detail.py | 195 -- ...entities_update_operations_error_detail.py | 167 -- .../models/gsa_access_control_entity.py | 166 -- .../models/gsa_access_control_entity_type.py | 51 - .../v2027r1/models/gsa_access_control_info.py | 161 -- .../gsa_access_control_user_capabilities.py | 186 -- ...sa_activity_log_application_name_filter.py | 181 -- ...log_application_names_collection_filter.py | 183 -- .../gsa_activity_log_collection_match_type.py | 46 - .../gsa_activity_log_database_key_filter.py | 178 -- .../models/gsa_activity_log_date_filter.py | 235 --- .../models/gsa_activity_log_entries_filter.py | 327 ---- .../models/gsa_activity_log_entries_info.py | 219 --- .../v2027r1/models/gsa_activity_log_entry.py | 280 --- .../models/gsa_activity_log_match_type.py | 46 - .../models/gsa_activity_log_usage_mode.py | 46 - .../gsa_activity_log_usage_mode_filter.py | 149 -- .../gsa_activity_log_username_filter.py | 181 -- .../v2027r1/models/gsa_add_database.py | 46 +- .../gsa_add_database_security_groups.py | 268 --- .../models/gsa_additional_sql_parameters.py | 142 -- ...gate_permission_access_controls_request.py | 149 -- .../models/gsa_aggregations_request.py | 35 - .../v2027r1/models/gsa_apply_options.py | 217 --- ...ssociation_chain_create_put_layout_item.py | 202 --- .../v2027r1/models/gsa_attribute.py | 38 - .../gsa_attribute_access_control_entity.py | 225 --- ...specified_smart_attributes_error_detail.py | 197 -- ...gsa_attribute_based_access_control_info.py | 161 -- .../gsa_attribute_create_put_layout_item.py | 290 --- .../gsa_attribute_creation_exception.py | 79 +- .../gsa_attribute_deletion_exception.py | 114 +- ...ute_discrete_type_mismatch_error_detail.py | 231 --- .../models/gsa_attribute_error_detail.py | 11 - .../models/gsa_attribute_error_reason.py | 11 - .../v2027r1/models/gsa_attribute_info.py | 76 +- .../v2027r1/models/gsa_attribute_link_pair.py | 48 +- .../gsa_attribute_no_such_entity_type.py | 1 - ...gsa_attribute_not_on_table_error_detail.py | 197 -- ..._mismatch_smart_attributes_error_detail.py | 197 -- ..._mismatch_smart_attributes_error_detail.py | 197 -- ...a_attribute_type_attribute_error_detail.py | 198 --- ...supported_smart_attributes_error_detail.py | 199 --- .../models/gsa_attribute_update_exception.py | 270 --- .../v2027r1/models/gsa_blob_info_dto.py | 257 --- ...ket_mismatch_unit_equation_error_detail.py | 128 -- .../v2027r1/models/gsa_breadcrumb.py | 161 -- .../v2027r1/models/gsa_breadcrumb_type.py | 46 - .../models/gsa_breadcrumbs_property.py | 157 -- ...ge_discrete_type_attribute_error_detail.py | 161 -- ...e_tabular_column_attribute_error_detail.py | 128 -- ...e_tabular_column_attribute_error_detail.py | 161 -- ...parameter_in_use_attribute_error_detail.py | 161 -- ...eplace_permission_category_error_detail.py | 223 --- .../v2027r1/models/gsa_chart_data.py | 231 --- .../v2027r1/models/gsa_chart_data_type.py | 49 - ...ular_reference_folder_move_error_detail.py | 128 -- .../gsa_code_missing_currency_error_detail.py | 128 -- ...a_code_whitespace_currency_error_detail.py | 158 -- ...a_config_invalid_json_file_error_detail.py | 126 -- .../models/gsa_configuration_details.py | 183 -- .../v2027r1/models/gsa_connection_details.py | 154 +- .../models/gsa_constant_creation_exception.py | 235 --- .../models/gsa_constant_deletion_exception.py | 114 +- .../models/gsa_constant_error_detail.py | 195 -- .../models/gsa_constant_error_reason.py | 46 - .../models/gsa_constant_update_exception.py | 238 --- ...nt_usage_data_modification_error_detail.py | 167 -- .../v2027r1/models/gsa_constants_info.py | 18 +- .../models/gsa_continuous_quality_system.py | 205 --- .../gsa_create_access_control_category.py | 253 --- ...e_access_control_category_table_mapping.py | 218 --- .../v2027r1/models/gsa_create_attribute.py | 63 - .../gsa_create_continuous_quality_system.py | 203 --- .../gsa_create_cross_database_link_target.py | 178 -- ...create_cross_database_record_link_group.py | 44 +- ...a_create_data_update_server_api_request.py | 212 --- .../models/gsa_create_date_time_attribute.py | 10 - .../models/gsa_create_discrete_attribute.py | 10 - ...sa_create_discrete_functional_attribute.py | 10 - .../models/gsa_create_discrete_parameter.py | 5 + .../gsa_create_discrete_quality_system.py | 200 --- .../models/gsa_create_discrete_type.py | 37 +- ...> gsa_create_dynamic_record_link_group.py} | 75 +- .../models/gsa_create_file_attribute.py | 10 - .../gsa_create_float_functional_attribute.py | 10 - .../models/gsa_create_hyperlink_attribute.py | 10 - .../models/gsa_create_integer_attribute.py | 10 - .../v2027r1/models/gsa_create_layout.py | 33 +- .../models/gsa_create_layout_section.py | 33 +- .../models/gsa_create_logical_attribute.py | 10 - .../models/gsa_create_long_text_attribute.py | 10 - .../gsa_create_maths_functional_attribute.py | 10 - .../models/gsa_create_numeric_parameter.py | 7 +- .../v2027r1/models/gsa_create_parameter.py | 29 + .../v2027r1/models/gsa_create_permission.py | 306 ---- .../models/gsa_create_permission_category.py | 215 --- .../models/gsa_create_picture_attribute.py | 10 - .../models/gsa_create_point_attribute.py | 10 - .../models/gsa_create_put_layout_item.py | 174 -- .../models/gsa_create_put_permission.py | 284 --- .../gsa_create_put_permission_category.py | 193 -- .../models/gsa_create_quality_system.py | 227 --- .../models/gsa_create_range_attribute.py | 10 - .../models/gsa_create_record_link_group.py | 37 +- ...filter.py => gsa_create_search_request.py} | 82 +- .../models/gsa_create_short_text_attribute.py | 10 - .../models/gsa_create_smart_link_target.py | 147 -- .../models/gsa_create_standard_name.py | 45 +- .../models/gsa_create_static_link_target.py | 147 -- .../gsa_create_static_record_link_group.py | 44 +- ...create_static_record_link_group_mapping.py | 183 -- .../v2027r1/models/gsa_create_table.py | 188 +- .../models/gsa_create_tabular_attribute.py | 10 - .../v2027r1/models/gsa_create_unit_mapping.py | 184 -- .../v2027r1/models/gsa_create_unit_system.py | 37 +- .../v2027r1/models/gsa_cross_database_link.py | 189 -- ...ss_database_link_create_put_layout_item.py | 232 --- .../models/gsa_cross_database_record_link.py | 176 -- .../gsa_cross_database_record_link_result.py | 192 -- .../v2027r1/models/gsa_currencies_info.py | 149 -- .../v2027r1/models/gsa_currency.py | 221 --- .../models/gsa_currency_error_detail.py | 201 --- .../models/gsa_currency_error_reason.py | 52 - .../v2027r1/models/gsa_data_export_range.py | 143 +- .../v2027r1/models/gsa_data_update.py | 217 --- .../gsa_data_update_deletion_exception.py | 146 -- .../v2027r1/models/gsa_data_update_header.py | 622 ------- .../models/gsa_data_update_run_info.py | 373 ---- .../v2027r1/models/gsa_data_update_token.py | 181 -- .../v2027r1/models/gsa_data_updater_job.py | 480 ----- .../models/gsa_data_updater_job_status.py | 52 - .../models/gsa_data_updater_job_type.py | 49 - .../models/gsa_data_updater_project.py | 602 ------- .../v2027r1/models/gsa_database.py | 169 -- .../gsa_database_access_control_entity.py | 124 -- ...it_usage_data_modification_error_detail.py | 135 -- .../v2027r1/models/gsa_database_issues.py | 189 -- .../models/gsa_database_security_groups.py | 317 ---- .../gsa_database_security_groups_info.py | 151 -- .../v2027r1/models/gsa_database_status.py | 2 +- .../models/gsa_database_user_capabilities.py | 185 -- .../v2027r1/models/gsa_databases_info.py | 18 +- .../v2027r1/models/gsa_date_time_attribute.py | 5 - .../v2027r1/models/gsa_datum_criterion.py | 2 +- .../models/gsa_datum_criterion_type.py | 2 +- .../gsa_default_fallback_security_groups.py | 317 ---- .../gsa_default_layout_guid_error_detail.py | 193 -- ...meter_value_guid_parameter_error_detail.py | 163 -- ...e_index_and_guid_parameter_error_detail.py | 128 -- ...eter_value_index_parameter_error_detail.py | 197 -- ...x_without_values_parameter_error_detail.py | 128 -- .../gsa_default_subset_guid_error_detail.py | 193 -- .../models/gsa_deletion_entity_type.py | 54 - .../v2027r1/models/gsa_deletion_exception.py | 295 --- ...sa_description_length_file_error_detail.py | 163 -- .../v2027r1/models/gsa_discrete_attribute.py | 5 - .../gsa_discrete_functional_attribute.py | 5 - .../v2027r1/models/gsa_discrete_parameter.py | 5 + .../models/gsa_discrete_parameter_value.py | 6 +- .../models/gsa_discrete_quality_system.py | 206 --- .../v2027r1/models/gsa_discrete_type.py | 36 - .../gsa_discrete_type_creation_exception.py | 240 --- .../gsa_discrete_type_deletion_exception.py | 114 +- .../models/gsa_discrete_type_error_detail.py | 195 -- .../models/gsa_discrete_type_error_reason.py | 47 - .../gsa_discrete_type_update_exception.py | 240 --- .../v2027r1/models/gsa_discrete_type_usage.py | 48 +- .../models/gsa_discrete_type_usage_type.py | 46 - ..._discrete_value_aggregate_error_reason.py} | 8 +- ...gsa_discrete_value_aggregate_exception.py} | 121 +- .../gsa_discrete_value_creation_exception.py | 240 --- .../gsa_discrete_value_deletion_exception.py | 240 --- .../models/gsa_discrete_value_error_detail.py | 196 -- .../models/gsa_discrete_value_error_reason.py | 47 - ...value_not_in_discrete_type_error_detail.py | 197 -- .../gsa_discrete_value_update_exception.py | 240 --- ...iscrete_value_used_in_data_error_detail.py | 165 -- .../gsa_discrete_values_discrete_value.py | 36 - .../gsa_discrete_values_error_detail.py | 165 -- ...ete_values_replace_discrete_values_info.py | 20 +- .../gsa_display_name_empty_error_detail.py | 162 -- ...name_language_not_provided_error_detail.py | 162 -- ...ame_language_not_supported_error_detail.py | 162 -- .../gsa_display_names_import_error_detail.py | 299 ---- .../gsa_display_names_import_error_reason.py | 53 - .../gsa_display_names_import_exception.py | 206 --- .../v2027r1/models/gsa_display_names_info.py | 147 -- ...vide_by_zero_unit_equation_error_detail.py | 128 -- ...eplace_permission_category_error_detail.py | 199 --- ...egory_guids_access_control_error_detail.py | 165 -- ...sa_duplicate_code_currency_error_detail.py | 158 -- ...a_duplicate_discrete_value_error_detail.py | 163 -- ...ate_mapped_attribute_guids_error_detail.py | 128 -- ...se_record_link_group_guids_error_detail.py | 128 -- ...ate_mapped_parameter_guids_error_detail.py | 128 -- ...ed_record_link_group_guids_error_detail.py | 128 -- ...sa_duplicate_name_currency_error_detail.py | 158 -- ...ssion_guids_access_control_error_detail.py | 199 --- ...ssions_permission_category_error_detail.py | 197 -- .../gsa_duplicate_symbol_unit_error_detail.py | 161 -- .../gsa_duplicate_table_error_detail.py | 163 -- ...cate_tables_reorder_tables_error_detail.py | 163 -- ...p_usage_data_modification_error_detail.py} | 16 +- ...up.py => gsa_dynamic_record_link_group.py} | 32 +- .../gsa_empty_symbol_unit_error_detail.py | 126 -- .../gsa_empty_table_type_error_detail.py | 128 -- .../models/gsa_enabled_licenses_info.py | 60 +- .../gsa_entity_already_exists_error_detail.py | 10 +- ...entifier_already_specified_error_detail.py | 10 +- .../v2027r1/models/gsa_entity_type.py | 63 - .../models/gsa_equation_unit_error_detail.py | 158 -- .../v2027r1/models/gsa_error_code.py | 129 -- ...on_error_detail.py => gsa_error_detail.py} | 42 +- ...r_detail_of_record_history_error_reason.py | 183 -- .../models/gsa_exception_information.py | 293 --- .../v2027r1/models/gsa_expression.py | 35 - .../gsa_expression_access_control_entity.py | 193 -- .../gsa_expression_deletion_exception.py | 146 -- ...on_usage_data_modification_error_detail.py | 18 +- ...e_already_exists_file_move_error_detail.py | 190 -- .../v2027r1/models/gsa_file_attribute.py | 5 - .../models/gsa_file_creation_exception.py | 268 --- .../v2027r1/models/gsa_file_error_detail.py | 199 --- .../v2027r1/models/gsa_file_error_reason.py | 50 - .../v2027r1/models/gsa_file_header_info.py | 149 -- .../models/gsa_file_move_error_detail.py | 196 -- .../models/gsa_file_move_error_reason.py | 47 - .../v2027r1/models/gsa_file_move_exception.py | 271 --- .../models/gsa_file_name_file_error_detail.py | 156 -- .../gsa_file_name_folder_error_detail.py | 158 -- .../models/gsa_file_update_exception.py | 271 --- ...a_source.py => gsa_find_search_request.py} | 40 +- .../models/gsa_find_similar_request.py | 182 -- .../models/gsa_find_similar_response.py | 181 -- .../v2027r1/models/gsa_find_similar_result.py | 178 -- .../gsa_find_similar_search_criterion.py | 182 -- .../models/gsa_float_functional_attribute.py | 5 - .../v2027r1/models/gsa_folder.py | 64 - .../models/gsa_folder_creation_exception.py | 268 --- .../gsa_folder_deletion_error_reason.py | 45 - .../models/gsa_folder_deletion_exception.py | 271 --- .../v2027r1/models/gsa_folder_error_detail.py | 196 -- .../v2027r1/models/gsa_folder_error_reason.py | 47 - .../models/gsa_folder_move_error_detail.py | 198 --- .../models/gsa_folder_move_error_reason.py | 49 - .../models/gsa_folder_move_exception.py | 271 --- .../v2027r1/models/gsa_folder_type.py | 48 - .../models/gsa_folder_update_exception.py | 271 --- ..._orphans_record_link_group_error_detail.py | 128 -- ...lt_usage_data_modification_error_detail.py | 135 -- .../gsa_general_unit_equation_error_detail.py | 128 -- .../gsa_get_find_similar_results_response.py | 247 --- ...fiable_record_version_control_exception.py | 50 +- .../gsa_get_unit_conversions_request.py | 42 +- .../gsa_get_unit_equivalents_exception.py | 206 --- .../v2027r1/models/gsa_grid.py | 181 -- ...integration_schema_of_object_identifier.py | 32 - .../gsa_help_paths_validation_response.py | 184 -- .../v2027r1/models/gsa_hyperlink_attribute.py | 5 - ...gsa_in_use_parameter_value_error_detail.py | 195 -- .../v2027r1/models/gsa_inclusiveness.py | 46 - .../gsa_incompatible_units_error_detail.py | 193 -- .../models/gsa_input_connection_details.py | 324 ---- .../gsa_input_validation_error_detail.py | 20 +- .../gsa_input_validation_error_reason.py | 46 - .../v2027r1/models/gsa_integer_attribute.py | 5 - .../v2027r1/models/gsa_integer_chart_data.py | 165 -- ...egration_schema_generation_error_detail.py | 20 +- ...integration_schema_of_object_identifier.py | 32 - ...invalid_equivalence_target_error_detail.py | 261 --- ...lid_exchange_rate_currency_error_detail.py | 128 -- .../gsa_invalid_parent_state_error_detail.py | 9 +- .../gsa_invalid_version_state_error_detail.py | 9 +- .../v2027r1/models/gsa_layout.py | 2 - .../models/gsa_layout_attribute_item.py | 10 +- .../v2027r1/models/gsa_layout_item.py | 36 - .../v2027r1/models/gsa_layout_link_item.py | 10 +- .../v2027r1/models/gsa_layout_section.py | 2 - .../v2027r1/models/gsa_link_attribute_type.py | 2 +- .../v2027r1/models/gsa_link_target.py | 31 +- .../gsa_linked_attribute_tabular_column.py | 10 - .../gsa_linked_column_tabular_column.py | 10 - .../gsa_linked_record_tabular_column.py | 10 - ...sa_linking_value_exists_datum_criterion.py | 2 +- .../v2027r1/models/gsa_links_info.py | 18 +- .../gsa_local_date_time_tabular_column.py | 10 - .../gsa_local_discrete_tabular_column.py | 10 - .../models/gsa_local_file_tabular_column.py | 10 - .../gsa_local_hyperlink_tabular_column.py | 10 - .../gsa_local_integer_tabular_column.py | 10 - .../gsa_local_logical_tabular_column.py | 10 - .../gsa_local_long_text_tabular_column.py | 10 - .../gsa_local_picture_tabular_column.py | 10 - .../models/gsa_local_point_tabular_column.py | 10 - .../models/gsa_local_range_tabular_column.py | 10 - .../gsa_local_short_text_tabular_column.py | 10 - ...e_negative_parameter_value_error_detail.py | 128 -- .../v2027r1/models/gsa_logical_attribute.py | 5 - .../v2027r1/models/gsa_logical_chart_data.py | 165 -- .../models/gsa_long_running_operation.py | 309 ---- .../gsa_long_running_operation_include.py | 45 - ...ning_operation_invalid_status_exception.py | 211 --- .../v2027r1/models/gsa_long_running_status.py | 50 - .../v2027r1/models/gsa_long_text_attribute.py | 5 - ..._orphans_record_link_group_error_detail.py | 128 -- .../v2027r1/models/gsa_match_mode.py | 47 - .../models/gsa_maths_functional_attribute.py | 5 - ...issions_reached_permission_error_detail.py | 163 -- ...cannot_have_meta_attribute_error_detail.py | 128 -- .../models/gsa_mfa_expression_error_detail.py | 20 +- ...gsa_multi_valued_attribute_error_detail.py | 162 -- ...ta_usage_data_modification_error_detail.py | 135 -- .../v2027r1/models/gsa_multi_valued_reason.py | 49 - ...ti_valued_smart_attributes_error_detail.py | 163 -- ..._in_single_valued_discrete_error_detail.py | 195 -- ..._reverse_record_link_group_error_detail.py | 163 -- .../gsa_name_already_exists_error_detail.py | 46 +- ...gsa_name_already_specified_error_detail.py | 162 -- .../gsa_name_missing_currency_error_detail.py | 128 -- .../gsa_name_not_provided_error_detail.py | 10 +- ...rse_name_record_link_group_error_detail.py | 128 -- ...a_name_whitespace_currency_error_detail.py | 158 -- ...whitespace_parameter_value_error_detail.py | 158 -- ...ty_access_control_category_error_detail.py | 165 -- .../gsa_named_entity_constant_error_detail.py | 160 -- ...named_entity_discrete_type_error_detail.py | 165 -- ...amed_entity_discrete_value_error_detail.py | 165 -- .../models/gsa_named_entity_error_detail.py | 48 +- .../models/gsa_named_entity_error_reason.py | 4 - .../gsa_named_entity_file_error_detail.py | 158 -- .../gsa_named_entity_folder_error_detail.py | 160 -- ...gsa_named_entity_parameter_error_detail.py | 160 -- ...med_entity_parameter_value_error_detail.py | 160 -- ...entity_permission_category_error_detail.py | 165 -- ...sa_named_entity_permission_error_detail.py | 165 -- ...ity_quality_discrete_value_error_detail.py | 165 -- ...amed_entity_quality_system_error_detail.py | 165 -- ...d_entity_record_link_group_error_detail.py | 165 -- .../gsa_named_entity_table_error_detail.py | 165 -- .../gsa_named_entity_unit_error_detail.py | 158 -- ...ute_pairs_smart_attributes_error_detail.py | 128 -- .../models/gsa_no_data_file_error_detail.py | 159 -- .../models/gsa_no_file_file_error_detail.py | 126 -- ...parameter_values_parameter_error_detail.py | 128 -- ...ssions_permission_category_error_detail.py | 128 -- ...no_quality_discrete_values_error_detail.py | 128 -- ...attribute_smart_attributes_error_detail.py | 231 --- ...eplace_permission_category_error_detail.py | 160 -- ...ch_category_access_control_error_detail.py | 163 -- ...ete_value_in_discrete_type_error_detail.py | 190 -- ...es_access_control_entities_error_detail.py | 165 -- ...ty_access_control_category_error_detail.py | 199 --- ...such_entity_tabular_column_error_detail.py | 67 +- ..._such_new_parent_file_move_error_detail.py | 224 --- ...uch_new_parent_folder_move_error_detail.py | 224 --- ..._permission_access_control_error_detail.py | 197 -- ...ssions_permission_category_error_detail.py | 158 -- ...et_access_control_entities_error_detail.py | 165 -- .../gsa_no_such_table_mapping_error_detail.py | 163 -- ...such_tables_reorder_tables_error_detail.py | 158 -- ...h_tabular_column_attribute_error_detail.py | 254 --- ...et_table_record_link_group_error_detail.py | 197 -- .../gsa_no_such_unit_constant_error_detail.py | 161 -- ...gsa_no_such_unit_parameter_error_detail.py | 161 -- ...nit_system_unit_equivalent_error_detail.py | 161 -- ..._such_unit_unit_equivalent_error_detail.py | 161 -- ...ard_name_cannot_be_changed_error_detail.py | 163 -- ...gsa_not_the_latest_version_error_detail.py | 9 +- .../models/gsa_not_versioned_error_detail.py | 9 +- ...mber_parsing_unit_equation_error_detail.py | 163 -- .../v2027r1/models/gsa_numeric_parameter.py | 5 + .../models/gsa_numeric_parameter_value.py | 6 +- ...ed_interpolation_parameter_error_detail.py | 128 -- .../v2027r1/models/gsa_paginated_item_type.py | 46 - .../models/gsa_paginated_response_of.py | 231 --- .../v2027r1/models/gsa_pagination_links.py | 142 -- .../v2027r1/models/gsa_parameter.py | 31 +- .../gsa_parameter_creation_exception.py | 235 --- .../gsa_parameter_deletion_exception.py | 114 +- .../models/gsa_parameter_error_detail.py | 203 --- .../models/gsa_parameter_error_reason.py | 54 - ...a_parameter_type_parameter_error_detail.py | 163 -- .../models/gsa_parameter_update_exception.py | 238 --- .../v2027r1/models/gsa_parameter_value.py | 32 - .../gsa_parameter_value_creation_exception.py | 267 --- .../gsa_parameter_value_deletion_exception.py | 114 +- .../gsa_parameter_value_error_detail.py | 199 --- .../gsa_parameter_value_error_reason.py | 50 - ..._parameter_value_parameter_error_detail.py | 160 -- ...value_type_parameter_value_error_detail.py | 163 -- .../gsa_parameter_value_update_exception.py | 270 --- .../gsa_parameter_value_used_by_type.py | 46 - .../v2027r1/models/gsa_permission.py | 27 +- .../models/gsa_permission_access_control.py | 217 --- ...gsa_permission_access_control_aggregate.py | 217 --- ...access_control_aggregation_error_detail.py | 194 -- ...access_control_aggregation_error_reason.py | 45 - ...ed_access_control_aggregation_exception.py | 213 --- ...ed_access_control_entities_error_reason.py | 46 - ...sa_permission_based_access_control_info.py | 124 -- ...cess_control_update_operation_exception.py | 213 --- ..._control_update_operations_error_detail.py | 195 -- ..._control_update_operations_error_reason.py | 46 - ..._categories_access_control_error_detail.py | 197 -- ..._categories_access_control_error_reason.py | 48 - ...egories_access_control_update_exception.py | 210 --- .../models/gsa_permission_categories_info.py | 18 +- ...tegories_update_operations_error_detail.py | 167 -- .../v2027r1/models/gsa_permission_category.py | 18 +- .../gsa_permission_category_access_control.py | 186 -- ...ssion_category_access_control_aggregate.py | 186 -- ..._category_access_control_aggregate_info.py | 183 -- ...permission_category_access_control_info.py | 151 -- ..._permission_category_creation_exception.py | 240 --- .../gsa_permission_category_error_detail.py | 199 --- .../gsa_permission_category_error_reason.py | 50 - ...a_permission_category_replace_exception.py | 208 --- .../gsa_permission_creation_exception.py | 240 --- .../gsa_permission_deletion_error_detail.py | 183 -- .../gsa_permission_deletion_error_reason.py | 45 - .../gsa_permission_deletion_exception.py | 240 --- .../models/gsa_permission_error_detail.py | 196 -- .../models/gsa_permission_error_reason.py | 47 - ...ission_permission_category_error_detail.py | 223 --- .../models/gsa_permission_update_exception.py | 240 --- .../models/gsa_permissions_in_use_info.py | 219 --- .../v2027r1/models/gsa_permissions_info.py | 18 +- .../v2027r1/models/gsa_picture_attribute.py | 5 - .../v2027r1/models/gsa_point_attribute.py | 5 - .../v2027r1/models/gsa_point_chart_data.py | 226 --- .../v2027r1/models/gsa_property.py | 1 - .../v2027r1/models/gsa_put_discrete_value.py | 161 -- .../v2027r1/models/gsa_put_layout_item.py | 161 -- .../v2027r1/models/gsa_put_permission.py | 161 -- .../models/gsa_put_permission_category.py | 161 -- .../v2027r1/models/gsa_put_type.py | 46 - .../models/gsa_quality_discrete_value.py | 215 --- ...gsa_quality_discrete_value_error_detail.py | 194 -- ...gsa_quality_discrete_value_error_reason.py | 45 - ...sa_quality_discrete_values_error_detail.py | 165 -- .../v2027r1/models/gsa_quality_system.py | 229 --- .../gsa_quality_system_creation_exception.py | 240 --- .../gsa_quality_system_deletion_exception.py | 146 -- .../models/gsa_quality_system_error_detail.py | 198 --- .../models/gsa_quality_system_error_reason.py | 49 - .../gsa_quality_system_guid_error_detail.py | 190 -- .../v2027r1/models/gsa_quality_system_type.py | 46 - .../models/gsa_quality_systems_info.py | 146 -- .../v2027r1/models/gsa_query_attribute.py | 109 +- .../models/gsa_query_attribute_filter.py | 33 - .../models/gsa_query_attribute_properties.py | 109 +- .../v2027r1/models/gsa_query_discrete_type.py | 29 - .../gsa_query_discrete_type_properties.py | 29 - .../v2027r1/models/gsa_query_layout.py | 231 --- .../v2027r1/models/gsa_query_layout_filter.py | 147 -- .../v2027r1/models/gsa_query_layout_item.py | 234 --- .../models/gsa_query_layout_item_filter.py | 325 ---- .../gsa_query_layout_item_properties.py | 229 --- .../models/gsa_query_layout_properties.py | 234 --- .../models/gsa_query_layout_section.py | 231 --- .../gsa_query_layout_section_properties.py | 234 --- .../models/gsa_query_layout_sections_info.py | 149 -- .../gsa_query_layout_sections_request.py | 182 -- .../v2027r1/models/gsa_query_layouts_info.py | 149 -- .../models/gsa_query_layouts_request.py | 182 -- .../v2027r1/models/gsa_query_slim_entity.py | 142 -- .../gsa_query_slim_entity_properties.py | 142 -- .../gsa_query_slim_named_entity_filter.py | 175 -- .../models/gsa_query_tabular_column.py | 233 --- .../gsa_query_tabular_column_properties.py | 231 --- .../v2027r1/models/gsa_range_attribute.py | 5 - .../v2027r1/models/gsa_range_chart_data.py | 229 --- .../v2027r1/models/gsa_range_datum.py | 154 +- .../v2027r1/models/gsa_range_endpoint.py | 183 -- ...gsa_record_and_attribute_selection_type.py | 47 - ...bilities.py => gsa_record_capabilities.py} | 54 +- .../gsa_record_history_copy_exception.py | 70 +- ...story_descendants_access_control_entity.py | 259 --- .../models/gsa_record_history_error_reason.py | 52 - .../gsa_record_history_move_exception.py | 70 +- .../v2027r1/models/gsa_record_link.py | 189 -- .../v2027r1/models/gsa_record_link_base.py | 292 --- .../gsa_record_link_create_put_layout_item.py | 193 -- .../v2027r1/models/gsa_record_link_group.py | 4 +- ...sa_record_link_group_creation_exception.py | 235 --- .../gsa_record_link_group_error_detail.py | 205 --- .../gsa_record_link_group_error_reason.py | 56 - .../models/gsa_record_link_group_type.py | 2 +- .../gsa_record_link_group_update_exception.py | 240 --- .../models/gsa_record_link_groups_info.py | 18 +- .../v2027r1/models/gsa_record_link_result.py | 197 -- .../v2027r1/models/gsa_record_link_results.py | 184 -- .../v2027r1/models/gsa_record_property.py | 1 - .../models/gsa_record_reference_criterion.py | 88 +- .../models/gsa_record_type_criterion.py | 144 -- .../v2027r1/models/gsa_record_version.py | 44 +- ...sa_record_version_access_control_entity.py | 227 --- .../v2027r1/models/gsa_referenced_by_type.py | 10 +- ...ty_model_record_link_group_error_detail.py | 128 -- .../models/gsa_register_update_request.py | 184 -- ...elease_record_version_control_exception.py | 50 +- ...release_table_version_control_exception.py | 50 +- .../models/gsa_reorder_tables_error_detail.py | 196 -- .../models/gsa_reorder_tables_error_reason.py | 47 - .../models/gsa_reorder_tables_exception.py | 235 --- .../models/gsa_reorder_tables_request.py | 149 -- .../gsa_replace_discrete_values_exception.py | 240 --- ...a_replace_permission_categories_request.py | 151 -- ...eplace_permission_category_error_detail.py | 197 -- ...eplace_permission_category_error_reason.py | 48 - .../models/gsa_resolve_link_targets_info.py | 149 -- .../gsa_resolve_link_targets_request.py | 149 -- .../v2027r1/models/gsa_resolved_breadcrumb.py | 225 --- .../{gsa_link.py => gsa_resolved_link.py} | 141 +- ...re_reason.py => gsa_resolved_link_info.py} | 93 +- .../models/gsa_resolved_link_target.py | 123 +- .../models/gsa_resolved_target_attribute.py | 266 --- .../models/gsa_retarget_potential_request.py | 149 -- .../v2027r1/models/gsa_retarget_request.py | 187 -- .../v2027r1/models/gsa_retarget_result.py | 319 ---- .../models/gsa_retarget_result_type.py | 49 - .../models/gsa_retarget_results_info.py | 149 -- ..._as_name_record_link_group_error_detail.py | 197 -- ...y_exists_record_link_group_error_detail.py | 197 -- ...provided_record_link_group_error_detail.py | 128 -- ...le_not_provided_permission_error_detail.py | 128 -- .../gsa_root_folder_move_error_detail.py | 128 -- ...rd_not_available_to_rename_error_detail.py | 163 -- .../v2027r1/models/gsa_rule_engine.py | 185 -- .../gsa_same_parent_file_move_error_detail.py | 161 -- ...sa_same_parent_folder_move_error_detail.py | 161 -- ...response.py => gsa_save_search_request.py} | 86 +- .../gsa_schema_generation_warning_reason.py | 57 - ...im_search_mask.py => gsa_search_detail.py} | 125 +- .../v2027r1/models/gsa_search_mask.py | 273 --- .../v2027r1/models/gsa_search_mask_info.py | 144 -- .../v2027r1/models/gsa_search_request.py | 66 - .../v2027r1/models/gsa_search_result.py | 29 - .../models/gsa_search_service_status.py | 147 -- .../v2027r1/models/gsa_search_template.py | 278 --- .../gsa_search_template_attribute_item.py | 128 -- .../models/gsa_search_template_info.py | 146 -- .../models/gsa_search_template_item.py | 197 -- .../models/gsa_search_template_item_type.py | 47 - .../models/gsa_search_template_link_item.py | 267 --- ...gsa_search_template_tabular_column_item.py | 165 -- ....py => gsa_security_attribute_grouping.py} | 107 +- .../v2027r1/models/gsa_selection.py | 643 ------- .../v2027r1/models/gsa_selection_search.py | 454 +++++ .../v2027r1/models/gsa_set_range_datum.py | 157 +- .../v2027r1/models/gsa_set_unit_equivalent.py | 215 --- .../gsa_set_unit_equivalents_exception.py | 206 --- .../models/gsa_set_unit_equivalents_info.py | 146 -- .../models/gsa_short_text_attribute.py | 5 - .../v2027r1/models/gsa_similarity_setting.py | 218 --- .../v2027r1/models/gsa_similarity_settings.py | 276 --- .../models/gsa_similarity_sort_criterion.py | 128 -- .../models/gsa_slim_access_control_info.py | 184 -- .../v2027r1/models/gsa_slim_attribute.py | 38 - .../gsa_slim_attribute_with_help_path.py | 426 ----- ...discrete_value.py => gsa_slim_constant.py} | 46 +- .../v2027r1/models/gsa_slim_database.py | 103 -- .../gsa_slim_database_access_control_info.py | 151 -- .../v2027r1/models/gsa_slim_discrete_type.py | 36 - .../v2027r1/models/gsa_slim_expression.py | 38 +- .../v2027r1/models/gsa_slim_layout.py | 2 - ...rch_template.py => gsa_slim_named_unit.py} | 130 +- .../v2027r1/models/gsa_slim_parameter.py | 2 - .../gsa_slim_parameter_with_help_path.py | 282 --- ...screte_value.py => gsa_slim_permission.py} | 56 +- ...lue.py => gsa_slim_permission_category.py} | 82 +- .../models/gsa_slim_record_link_group.py | 2 - .../v2027r1/models/gsa_slim_subset.py | 2 - .../v2027r1/models/gsa_slim_table.py | 36 - .../models/gsa_slim_typed_attribute.py | 36 - ...ized_entity.py => gsa_slim_unit_system.py} | 32 +- .../gsa_smart_attributes_error_detail.py | 202 --- .../gsa_smart_attributes_error_reason.py | 53 - ...tributes_record_link_group_error_detail.py | 165 -- .../v2027r1/models/gsa_smart_link.py | 262 --- .../gsa_smart_link_create_put_layout_item.py | 196 -- ...up_usage_data_modification_error_detail.py | 167 -- .../models/gsa_smart_record_link_result.py | 165 -- .../v2027r1/models/gsa_smtp_properties.py | 308 ++++ .../v2027r1/models/gsa_sort_criterion.py | 1 - .../v2027r1/models/gsa_sort_criterion_type.py | 1 - ...be_target_smart_attributes_error_detail.py | 128 -- .../v2027r1/models/gsa_sql_credentials.py | 185 -- .../v2027r1/models/gsa_standard_name.py | 84 +- ...andard_name_already_exists_error_detail.py | 163 -- .../gsa_standard_name_creation_exception.py | 235 --- ...gsa_standard_name_deletion_error_detail.py | 212 --- ...gsa_standard_name_deletion_error_reason.py | 45 - .../gsa_standard_name_deletion_exception.py | 237 --- .../models/gsa_standard_name_error_detail.py | 204 --- .../models/gsa_standard_name_error_reason.py | 57 - .../gsa_standard_name_update_exception.py | 238 --- .../v2027r1/models/gsa_static_record_link.py | 146 -- .../gsa_static_record_link_group_mapping.py | 183 -- .../models/gsa_static_record_link_result.py | 158 -- .../v2027r1/models/gsa_subset.py | 2 - .../v2027r1/models/gsa_subsets_info.py | 18 +- ...circular_record_link_group_error_detail.py | 128 -- ..._cannot_contain_comma_unit_error_detail.py | 161 -- .../v2027r1/models/gsa_t_item.py | 105 -- .../v2027r1/models/gsa_table.py | 228 --- .../models/gsa_table_access_control_entity.py | 194 -- .../models/gsa_table_creation_exception.py | 240 --- .../models/gsa_table_deletion_exception.py | 114 +- ...table_descendants_access_control_entity.py | 225 --- .../v2027r1/models/gsa_table_error_detail.py | 199 --- .../v2027r1/models/gsa_table_error_reason.py | 51 - .../models/gsa_table_search_behaviour.py | 47 - ..._table_type_contains_comma_error_detail.py | 163 -- .../models/gsa_table_type_error_detail.py | 195 -- .../models/gsa_table_type_error_reason.py | 46 - .../models/gsa_table_types_error_detail.py | 165 -- .../v2027r1/models/gsa_table_types_info.py | 142 -- .../models/gsa_table_update_exception.py | 240 --- ...le_usage_data_modification_error_detail.py | 167 -- ...te_access_control_category_error_detail.py | 128 -- ...les_missing_reorder_tables_error_detail.py | 158 -- .../v2027r1/models/gsa_tabular_attribute.py | 5 - .../models/gsa_tabular_attribute_link.py | 191 -- .../v2027r1/models/gsa_tabular_column.py | 74 - ...mn_usage_data_modification_error_detail.py | 169 -- .../v2027r1/models/gsa_target_attribute.py | 195 -- .../models/gsa_target_attribute_type.py | 46 - ..._fully_specified_attribute_error_detail.py | 163 -- ...threshold_value_name_empty_error_detail.py | 128 -- ...reshold_value_name_invalid_error_detail.py | 158 -- ...gsa_too_long_code_currency_error_detail.py | 128 -- ...ute_pairs_smart_attributes_error_detail.py | 163 -- ...ssions_permission_category_error_detail.py | 197 -- ...eplace_permission_category_error_detail.py | 199 --- ...a_translate_guids_to_identities_request.py | 122 -- ...translate_guids_to_identities_response.py} | 270 +-- ...a_translate_identities_to_guids_request.py | 729 -------- .../models/gsa_unavailable_tabular_column.py | 10 - ..._as_exponent_unit_equation_error_detail.py | 128 -- .../models/gsa_unit_conversion_set_request.py | 4 - .../models/gsa_unit_creation_exception.py | 240 --- .../models/gsa_unit_deletion_exception.py | 146 -- .../models/gsa_unit_equation_error_detail.py | 199 --- .../models/gsa_unit_equation_error_reason.py | 50 - .../v2027r1/models/gsa_unit_equivalent.py | 54 +- .../gsa_unit_equivalent_error_detail.py | 197 -- .../gsa_unit_equivalent_error_reason.py | 48 - .../v2027r1/models/gsa_unit_error_detail.py | 198 --- .../v2027r1/models/gsa_unit_error_reason.py | 49 - .../v2027r1/models/gsa_unit_system.py | 2 - .../v2027r1/models/gsa_unit_systems_info.py | 20 +- .../models/gsa_unit_update_exception.py | 240 --- .../v2027r1/models/gsa_unit_usage.py | 129 +- ...it_usage_data_modification_error_detail.py | 167 -- .../v2027r1/models/gsa_unit_usage_type.py | 49 - .../v2027r1/models/gsa_units_grouping_info.py | 142 -- .../v2027r1/models/gsa_units_info.py | 18 +- ..._unit_symbol_unit_equation_error_detail.py | 163 -- ...unresolved_attribute_guids_error_detail.py | 163 -- .../models/gsa_unresolved_breadcrumb.py | 122 -- ...se_record_link_group_guids_error_detail.py | 163 -- ...unresolved_parameter_guids_error_detail.py | 163 -- ...ed_record_link_group_guids_error_detail.py | 163 -- ...reverse_record_link_groups_error_detail.py | 173 -- .../models/gsa_unresolved_target_attribute.py | 128 -- .../models/gsa_update_access_control.py | 161 -- .../gsa_update_access_control_category.py | 216 --- ...e_access_control_category_table_mapping.py | 216 --- .../v2027r1/models/gsa_update_attribute.py | 64 +- ...a_update_attribute_based_access_control.py | 163 -- .../models/gsa_update_current_rule_engine.py | 149 -- .../v2027r1/models/gsa_update_database.py | 173 +- .../gsa_update_database_security_groups.py | 258 --- .../models/gsa_update_date_time_attribute.py | 10 +- .../models/gsa_update_default_database.py | 147 -- ...update_default_fallback_security_groups.py | 305 ---- .../models/gsa_update_discrete_attribute.py | 10 +- ...sa_update_discrete_functional_attribute.py | 10 +- .../models/gsa_update_discrete_parameter.py | 49 +- .../models/gsa_update_discrete_type.py | 35 +- .../models/gsa_update_display_names.py | 147 -- .../gsa_update_display_names_response.py | 181 -- ...> gsa_update_dynamic_record_link_group.py} | 34 +- .../models/gsa_update_file_attribute.py | 10 +- .../gsa_update_float_functional_attribute.py | 35 +- .../models/gsa_update_hyperlink_attribute.py | 10 +- .../models/gsa_update_integer_attribute.py | 38 +- .../models/gsa_update_layout_section.py | 213 --- .../models/gsa_update_logical_attribute.py | 10 +- .../models/gsa_update_long_text_attribute.py | 10 +- .../gsa_update_maths_functional_attribute.py | 35 +- .../models/gsa_update_numeric_parameter.py | 45 +- .../v2027r1/models/gsa_update_parameter.py | 69 +- .../v2027r1/models/gsa_update_permission.py | 300 ---- .../gsa_update_permission_access_control.py | 213 --- ..._update_permission_based_access_control.py | 124 -- .../models/gsa_update_permission_category.py | 213 --- ...date_permission_category_access_control.py | 186 -- ...mission_category_access_control_request.py | 151 -- ...egory_access_controls_operation_request.py | 186 -- .../models/gsa_update_picture_attribute.py | 10 +- .../models/gsa_update_point_attribute.py | 35 +- .../models/gsa_update_put_layout_item.py | 157 -- .../models/gsa_update_put_permission.py | 314 ---- .../gsa_update_put_permission_category.py | 225 --- .../models/gsa_update_range_attribute.py | 35 +- .../models/gsa_update_record_link_group.py | 2 +- .../gsa_update_root_folder_error_detail.py | 128 -- .../v2027r1/models/gsa_update_run_status.py | 60 - .../models/gsa_update_short_text_attribute.py | 10 +- .../models/gsa_update_standard_name.py | 23 +- ...update_static_record_link_group_mapping.py | 183 -- .../v2027r1/models/gsa_update_table.py | 183 -- .../models/gsa_update_tabular_attribute.py | 10 +- ...rty_not_provided_attribute_error_detail.py | 192 -- ...ular_column_type_attribute_error_detail.py | 161 -- .../models/gsa_upgrade_database_exception.py | 311 ---- .../gsa_upgrade_database_failure_reason.py | 47 - ...sa_usage_data_modification_error_detail.py | 10 +- .../v2027r1/models/gsa_user_capabilities.py | 185 -- ...ete_chart_data.py => gsa_user_or_group.py} | 103 +- .../gsa_validate_unit_equation_request.py | 149 -- .../gsa_validate_unit_equation_response.py | 183 -- ...t_provided_parameter_value_error_detail.py | 187 -- .../gsa_version_control_error_detail.py | 20 +- .../gsa_version_control_error_reason.py | 48 - .../models/gsa_version_control_mode.py | 46 - .../v2027r1/models/gsa_weighting_type.py | 47 - ...thdraw_record_version_control_exception.py | 50 +- .../v2027r1/models/gsa_xy_chart_template.py | 438 ----- .../models/gsa_xy_chart_templates_info.py | 219 --- .../v2027r1/models/gsa_xy_template_axis.py | 344 ---- ansys-grantami-serverapi-openapi/uv.lock | 2 +- 804 files changed, 4534 insertions(+), 113997 deletions(-) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___attribute_based_categories_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_schema_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/activity_log_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blob_infos_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blobs_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_updater_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/find_similar_api.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/{schema___quality_systems_api.py => permission_based_access_control_api.py} (67%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/record_links_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___display_names_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_masks_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_templates_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___unit_equivalents_api.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___xy_chart_templates_api.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/{schema___security_groups_api.py => selection_searches_api.py} (64%) rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/{currencies_api.py => server_manager_api.py} (71%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/granta_mi_search_free_text_identifiers.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_categories_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_include.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_no_such_entity_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_table_mapping.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_database_user_capabilities.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_aggregation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_update_operations_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_user_capabilities.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_name_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_names_collection_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_collection_match_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_database_key_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_date_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entry.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_match_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_username_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database_security_groups.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_additional_sql_parameters.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregate_permission_access_controls_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_apply_options.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_association_chain_create_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_already_specified_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_based_access_control_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_create_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_discrete_type_mismatch_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_not_on_table_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_type_mismatch_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_not_supported_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_blob_info_dto.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_bracket_mismatch_unit_equation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumbs_property.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_change_discrete_type_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_create_unavailable_tabular_column_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_delete_tabular_column_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_remove_parameter_in_use_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_category_replace_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_circular_reference_folder_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_missing_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_whitespace_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_config_invalid_json_file_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_configuration_details.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_continuous_quality_system.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category_table_mapping.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_continuous_quality_system.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_link_target.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_data_update_server_api_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_quality_system.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_create_smart_record_link_group.py => gsa_create_dynamic_record_link_group.py} (75%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_quality_system.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_query_layout_section_filter.py => gsa_create_search_request.py} (63%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_smart_link_target.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_link_target.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group_mapping.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_mapping.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link_create_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link_result.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currencies_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_header.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_run_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_token.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_status.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_project.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_currency_unit_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_issues.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_user_capabilities.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_fallback_security_groups.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_layout_guid_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_guid_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_and_guid_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_without_values_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_subset_guid_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_entity_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_description_length_file_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_quality_system.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage_type.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_access_control_mode.py => gsa_discrete_value_aggregate_error_reason.py} (83%) rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_permission_category_update_exception.py => gsa_discrete_value_aggregate_exception.py} (60%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_not_in_discrete_type_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_used_in_data_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_empty_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_provided_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_supported_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_divide_by_zero_unit_equation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_categories_replace_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_category_guids_access_control_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_code_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_discrete_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_attribute_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_parameter_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_record_link_group_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_name_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permission_guids_access_control_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permissions_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_symbol_unit_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_table_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_tables_reorder_tables_error_detail.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_parameter_usage_data_modification_error_detail.py => gsa_dynamic_link_group_usage_data_modification_error_detail.py} (88%) rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_smart_record_link_group.py => gsa_dynamic_record_link_group.py} (89%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_symbol_unit_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_table_type_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_equation_unit_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_code.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_folder_deletion_error_detail.py => gsa_error_detail.py} (79%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail_of_record_history_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_exception_information.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_already_exists_file_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_header_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_file_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_folder_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_update_exception.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_data_source.py => gsa_find_search_request.py} (77%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_response.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_result.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_search_criterion.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_forbid_orphans_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_functional_data_default_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_general_unit_equation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_find_similar_results_response.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_equivalents_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_grid.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_help_paths_validation_response.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_in_use_parameter_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_inclusiveness.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_incompatible_units_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_connection_details.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_chart_data.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_equivalence_target_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_exchange_rate_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_log_scale_negative_parameter_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_chart_data.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_include.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_invalid_status_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_status.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_many_to_many_forbid_orphans_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_match_mode.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_max_permissions_reached_permission_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_meta_attribute_cannot_have_meta_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_point_data_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_as_reverse_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_specified_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_missing_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_same_as_reverse_name_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_parameter_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_access_control_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_constant_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_type_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_file_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_folder_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_discrete_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_system_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_table_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_unit_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_attribute_pairs_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_data_file_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_file_file_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_parameter_values_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_permissions_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_quality_discrete_values_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_attribute_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_categories_replace_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_category_access_control_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_discrete_value_in_discrete_type_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entities_access_control_entities_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_access_control_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_file_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_folder_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permission_access_control_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permissions_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_subset_access_control_entities_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_table_mapping_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tables_reorder_tables_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tabular_column_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_target_table_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_constant_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_system_unit_equivalent_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_unit_equivalent_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_non_custom_standard_name_cannot_be_changed_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_number_parsing_unit_equation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_restricted_interpolation_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_item_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_response_of.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_pagination_links.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_type_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_parameter_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_type_parameter_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_used_by_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control_aggregate.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_entities_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_update_operations_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_replace_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_in_use_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_chart_data.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_discrete_value.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_values_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_guid_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_systems_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_properties.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_properties.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section_properties.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity_properties.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_named_entity_filter.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column_properties.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_chart_data.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_endpoint.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_and_attribute_selection_type.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_record_user_capabilities.py => gsa_record_capabilities.py} (86%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_descendants_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_base.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_create_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_result.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_results.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_type_criterion.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referential_integrity_model_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_register_update_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_discrete_values_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_categories_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_breadcrumb.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_link.py => gsa_resolved_link.py} (73%) rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_error_detail_of_upgrade_database_failure_reason.py => gsa_resolved_link_info.py} (60%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_target_attribute.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_potential_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_results_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_as_name_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_not_provided_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_role_not_provided_permission_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_folder_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_record_not_available_to_rename_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_rule_engine.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_file_move_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_folder_move_error_detail.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_error_response.py => gsa_save_search_request.py} (65%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_schema_generation_warning_reason.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_slim_search_mask.py => gsa_search_detail.py} (63%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_service_status.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_attribute_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_link_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_tabular_column_item.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_folder_already_exists_folder_move_error_detail.py => gsa_security_attribute_grouping.py} (58%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection.py create mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection_search.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalent.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_setting.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_settings.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_sort_criterion.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_access_control_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute_with_help_path.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_create_quality_discrete_value.py => gsa_slim_constant.py} (81%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database_access_control_info.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_slim_search_template.py => gsa_slim_named_unit.py} (68%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter_with_help_path.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_create_put_discrete_value.py => gsa_slim_permission.py} (76%) rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_update_put_discrete_value.py => gsa_slim_permission_category.py} (76%) rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_slim_localized_entity.py => gsa_slim_unit_system.py} (84%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_create_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_group_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_record_link_result.py create mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smtp_properties.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_source_cannot_be_target_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sql_credentials.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_already_exists_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_group_mapping.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_result.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_symbol_cannot_contain_comma_unit_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_t_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_descendants_access_control_entity.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_search_behaviour.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_contains_comma_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_version_state_access_control_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tables_missing_reorder_tables_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute_link.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_not_fully_specified_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_empty_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_invalid_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_long_code_currency_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_attribute_pairs_smart_attributes_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_permission_category_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_replace_permission_category_error_detail.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_translate_between_guids_and_identities_response.py => gsa_translate_guids_to_identities_response.py} (64%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_identities_to_guids_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_as_exponent_unit_equation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_creation_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_deletion_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_update_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_data_modification_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_grouping_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unknown_unit_symbol_unit_equation_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_attribute_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_breadcrumb.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_cross_database_record_link_group_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_parameter_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_record_link_group_guids_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_reverse_record_link_groups_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_target_attribute.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category_table_mapping.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute_based_access_control.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_current_rule_engine.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database_security_groups.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_database.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_fallback_security_groups.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names_response.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_update_smart_record_link_group.py => gsa_update_dynamic_record_link_group.py} (85%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_layout_section.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_access_control.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_based_access_control.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_controls_operation_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_layout_item.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission_category.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_root_folder_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_run_status.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_static_record_link_group_mapping.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_property_not_provided_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_type_attribute_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_exception.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_failure_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_user_capabilities.py rename ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/{gsa_discrete_chart_data.py => gsa_user_or_group.py} (65%) delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_request.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_response.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_value_not_provided_parameter_value_error_detail.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_reason.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_mode.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_weighting_type.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_template.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_templates_info.py delete mode 100644 ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_template_axis.py diff --git a/ansys-grantami-serverapi-openapi/pyproject.toml b/ansys-grantami-serverapi-openapi/pyproject.toml index db2b95cc..9f3ce1c7 100644 --- a/ansys-grantami-serverapi-openapi/pyproject.toml +++ b/ansys-grantami-serverapi-openapi/pyproject.toml @@ -8,7 +8,7 @@ module-name = "ansys.grantami.serverapi_openapi" [project] name = "ansys-grantami-serverapi-openapi" description = "Autogenerated client library for the Granta MI Server API." -version = "6.0.0.dev1333" +version = "6.0.0.dev1338" license = "MIT" requires-python = ">=3.12" authors = [ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py index 7893ed90..af193776 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py @@ -20,4 +20,4 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. -__version__ = "6.0.0.dev1333" +__version__ = "6.0.0.dev1338" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/__init__.py index c1b47d8c..2a51a328 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/__init__.py @@ -32,25 +32,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git """ -from .api.access_control___attribute_based_categories_api import ( - AccessControlAttributeBasedCategoriesApi, -) -from .api.access_control___permission_based_api import AccessControlPermissionBasedApi -from .api.access_control___permission_based_schema_api import AccessControlPermissionBasedSchemaApi - # import apis into sdk package -from .api.access_control_api import AccessControlApi -from .api.activity_log_api import ActivityLogApi from .api.aggregation_api import AggregationApi -from .api.blob_infos_api import BlobInfosApi -from .api.blobs_api import BlobsApi from .api.bulk_api import BulkApi -from .api.currencies_api import CurrenciesApi from .api.data_api import DataApi from .api.data_export_api import DataExportApi -from .api.data_updater_api import DataUpdaterApi from .api.database_api import DatabaseApi -from .api.find_similar_api import FindSimilarApi from .api.graph_api import GraphApi from .api.help_location_api import HelpLocationApi from .api.identities_api import IdentitiesApi @@ -62,7 +49,7 @@ from .api.list_management_api import ListManagementApi from .api.list_permissions_api import ListPermissionsApi from .api.metrics_api import MetricsApi -from .api.record_links_api import RecordLinksApi +from .api.permission_based_access_control_api import PermissionBasedAccessControlApi from .api.records___record_histories_api import RecordsRecordHistoriesApi from .api.records___record_versions_api import RecordsRecordVersionsApi from .api.schema___attributes_api import SchemaAttributesApi @@ -72,7 +59,6 @@ from .api.schema___databases_api import SchemaDatabasesApi from .api.schema___discrete_types___discrete_values_api import SchemaDiscreteTypesDiscreteValuesApi from .api.schema___discrete_types_api import SchemaDiscreteTypesApi -from .api.schema___display_names_api import SchemaDisplayNamesApi from .api.schema___exporters_api import SchemaExportersApi from .api.schema___expressions_api import SchemaExpressionsApi from .api.schema___global_standard_names_api import SchemaGlobalStandardNamesApi @@ -83,20 +69,16 @@ from .api.schema___parameters_api import SchemaParametersApi from .api.schema___profile_tables_api import SchemaProfileTablesApi from .api.schema___profiles_api import SchemaProfilesApi -from .api.schema___quality_systems_api import SchemaQualitySystemsApi from .api.schema___record_link_groups_api import SchemaRecordLinkGroupsApi from .api.schema___replacement_strings_api import SchemaReplacementStringsApi -from .api.schema___search_masks_api import SchemaSearchMasksApi -from .api.schema___search_templates_api import SchemaSearchTemplatesApi -from .api.schema___security_groups_api import SchemaSecurityGroupsApi from .api.schema___standard_names_api import SchemaStandardNamesApi from .api.schema___subsets_api import SchemaSubsetsApi from .api.schema___tables_api import SchemaTablesApi -from .api.schema___unit_equivalents_api import SchemaUnitEquivalentsApi from .api.schema___units_api import SchemaUnitsApi -from .api.schema___xy_chart_templates_api import SchemaXYChartTemplatesApi from .api.schema_api import SchemaApi from .api.search_api import SearchApi +from .api.selection_searches_api import SelectionSearchesApi +from .api.server_manager_api import ServerManagerApi from .api.status_api import StatusApi from .models.attributes_attributeguidimportfile_body1 import AttributesAttributeguidimportfileBody1 @@ -118,64 +100,14 @@ from .models.granta_mi_record_property_fake_attribute_identities import ( GrantaMIRecordPropertyFakeAttributeIdentities, ) -from .models.granta_mi_search_free_text_identifiers import GrantaMISearchFreeTextIdentifiers from .models.gsa_about_attribute_cannot_be_meta_attribute_error_detail import ( GsaAboutAttributeCannotBeMetaAttributeErrorDetail, ) -from .models.gsa_access_control_categories_info import GsaAccessControlCategoriesInfo -from .models.gsa_access_control_category import GsaAccessControlCategory -from .models.gsa_access_control_category_creation_exception import ( - GsaAccessControlCategoryCreationException, -) -from .models.gsa_access_control_category_error_detail import GsaAccessControlCategoryErrorDetail -from .models.gsa_access_control_category_error_reason import GsaAccessControlCategoryErrorReason -from .models.gsa_access_control_category_include import GsaAccessControlCategoryInclude -from .models.gsa_access_control_category_no_such_entity_type import ( - GsaAccessControlCategoryNoSuchEntityType, -) -from .models.gsa_access_control_category_table_mapping import GsaAccessControlCategoryTableMapping -from .models.gsa_access_control_category_update_exception import ( - GsaAccessControlCategoryUpdateException, -) -from .models.gsa_access_control_database_user_capabilities import ( - GsaAccessControlDatabaseUserCapabilities, -) -from .models.gsa_access_control_entities_aggregation_error_detail import ( - GsaAccessControlEntitiesAggregationErrorDetail, -) -from .models.gsa_access_control_entities_error_detail import GsaAccessControlEntitiesErrorDetail -from .models.gsa_access_control_entities_update_operations_error_detail import ( - GsaAccessControlEntitiesUpdateOperationsErrorDetail, -) -from .models.gsa_access_control_entity import GsaAccessControlEntity -from .models.gsa_access_control_entity_type import GsaAccessControlEntityType -from .models.gsa_access_control_info import GsaAccessControlInfo -from .models.gsa_access_control_mode import GsaAccessControlMode -from .models.gsa_access_control_user_capabilities import GsaAccessControlUserCapabilities -from .models.gsa_activity_log_application_name_filter import GsaActivityLogApplicationNameFilter -from .models.gsa_activity_log_application_names_collection_filter import ( - GsaActivityLogApplicationNamesCollectionFilter, -) -from .models.gsa_activity_log_collection_match_type import GsaActivityLogCollectionMatchType -from .models.gsa_activity_log_database_key_filter import GsaActivityLogDatabaseKeyFilter -from .models.gsa_activity_log_date_filter import GsaActivityLogDateFilter -from .models.gsa_activity_log_entries_filter import GsaActivityLogEntriesFilter -from .models.gsa_activity_log_entries_info import GsaActivityLogEntriesInfo -from .models.gsa_activity_log_entry import GsaActivityLogEntry -from .models.gsa_activity_log_match_type import GsaActivityLogMatchType -from .models.gsa_activity_log_usage_mode import GsaActivityLogUsageMode -from .models.gsa_activity_log_usage_mode_filter import GsaActivityLogUsageModeFilter -from .models.gsa_activity_log_username_filter import GsaActivityLogUsernameFilter from .models.gsa_add_database import GsaAddDatabase from .models.gsa_add_database_issue_type import GsaAddDatabaseIssueType -from .models.gsa_add_database_security_groups import GsaAddDatabaseSecurityGroups from .models.gsa_add_database_validation_issue import GsaAddDatabaseValidationIssue from .models.gsa_add_database_validation_result import GsaAddDatabaseValidationResult from .models.gsa_add_record_history_to_subset import GsaAddRecordHistoryToSubset -from .models.gsa_additional_sql_parameters import GsaAdditionalSqlParameters -from .models.gsa_aggregate_permission_access_controls_request import ( - GsaAggregatePermissionAccessControlsRequest, -) from .models.gsa_aggregation import GsaAggregation from .models.gsa_aggregation_criterion import GsaAggregationCriterion from .models.gsa_aggregation_datum import GsaAggregationDatum @@ -198,12 +130,7 @@ from .models.gsa_append_point_values import GsaAppendPointValues from .models.gsa_applicable_datum import GsaApplicableDatum from .models.gsa_applications_info import GsaApplicationsInfo -from .models.gsa_apply_options import GsaApplyOptions -from .models.gsa_association_chain_create_put_layout_item import ( - GsaAssociationChainCreatePutLayoutItem, -) from .models.gsa_attribute import GsaAttribute -from .models.gsa_attribute_access_control_entity import GsaAttributeAccessControlEntity from .models.gsa_attribute_aggregation import GsaAttributeAggregation from .models.gsa_attribute_aggregation_criterion import GsaAttributeAggregationCriterion from .models.gsa_attribute_aggregation_exists_criterion import ( @@ -211,18 +138,10 @@ ) from .models.gsa_attribute_aggregation_type import GsaAttributeAggregationType from .models.gsa_attribute_aggregation_value_criterion import GsaAttributeAggregationValueCriterion -from .models.gsa_attribute_already_specified_smart_attributes_error_detail import ( - GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail, -) -from .models.gsa_attribute_based_access_control_info import GsaAttributeBasedAccessControlInfo -from .models.gsa_attribute_create_put_layout_item import GsaAttributeCreatePutLayoutItem from .models.gsa_attribute_creation_exception import GsaAttributeCreationException from .models.gsa_attribute_criterion import GsaAttributeCriterion from .models.gsa_attribute_criterion_type import GsaAttributeCriterionType from .models.gsa_attribute_deletion_exception import GsaAttributeDeletionException -from .models.gsa_attribute_discrete_type_mismatch_error_detail import ( - GsaAttributeDiscreteTypeMismatchErrorDetail, -) from .models.gsa_attribute_error_detail import GsaAttributeErrorDetail from .models.gsa_attribute_error_reason import GsaAttributeErrorReason from .models.gsa_attribute_exists_aggregation import GsaAttributeExistsAggregation @@ -234,24 +153,12 @@ from .models.gsa_attribute_matches_criterion import GsaAttributeMatchesCriterion from .models.gsa_attribute_no_such_entity_type import GsaAttributeNoSuchEntityType from .models.gsa_attribute_not_applicable_criterion import GsaAttributeNotApplicableCriterion -from .models.gsa_attribute_not_on_table_error_detail import GsaAttributeNotOnTableErrorDetail -from .models.gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail, -) -from .models.gsa_attribute_pair_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairTypeMismatchSmartAttributesErrorDetail, -) from .models.gsa_attribute_reference import GsaAttributeReference from .models.gsa_attribute_scale_type import GsaAttributeScaleType from .models.gsa_attribute_sort_criterion import GsaAttributeSortCriterion from .models.gsa_attribute_threshold_type import GsaAttributeThresholdType from .models.gsa_attribute_to_export import GsaAttributeToExport from .models.gsa_attribute_type import GsaAttributeType -from .models.gsa_attribute_type_attribute_error_detail import GsaAttributeTypeAttributeErrorDetail -from .models.gsa_attribute_type_not_supported_smart_attributes_error_detail import ( - GsaAttributeTypeNotSupportedSmartAttributesErrorDetail, -) -from .models.gsa_attribute_update_exception import GsaAttributeUpdateException from .models.gsa_attribute_usage_data_modification_error_detail import ( GsaAttributeUsageDataModificationErrorDetail, ) @@ -259,79 +166,33 @@ from .models.gsa_attribute_value_aggregation import GsaAttributeValueAggregation from .models.gsa_attributes_info import GsaAttributesInfo from .models.gsa_axis_name import GsaAxisName -from .models.gsa_blob_info_dto import GsaBlobInfoDto from .models.gsa_boolean_criterion import GsaBooleanCriterion from .models.gsa_boost_by_guid import GsaBoostByGuid from .models.gsa_boost_by_identity import GsaBoostByIdentity -from .models.gsa_bracket_mismatch_unit_equation_error_detail import ( - GsaBracketMismatchUnitEquationErrorDetail, -) -from .models.gsa_breadcrumb import GsaBreadcrumb -from .models.gsa_breadcrumb_type import GsaBreadcrumbType -from .models.gsa_breadcrumbs_property import GsaBreadcrumbsProperty from .models.gsa_bulk_info import GsaBulkInfo from .models.gsa_bulk_request import GsaBulkRequest from .models.gsa_bulk_request_http_method import GsaBulkRequestHttpMethod from .models.gsa_bulk_request_item import GsaBulkRequestItem from .models.gsa_bulk_response_item import GsaBulkResponseItem from .models.gsa_calendar_interval import GsaCalendarInterval -from .models.gsa_cannot_change_discrete_type_attribute_error_detail import ( - GsaCannotChangeDiscreteTypeAttributeErrorDetail, -) -from .models.gsa_cannot_create_unavailable_tabular_column_attribute_error_detail import ( - GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail, -) -from .models.gsa_cannot_delete_tabular_column_attribute_error_detail import ( - GsaCannotDeleteTabularColumnAttributeErrorDetail, -) -from .models.gsa_cannot_remove_parameter_in_use_attribute_error_detail import ( - GsaCannotRemoveParameterInUseAttributeErrorDetail, -) -from .models.gsa_category_replace_permission_category_error_detail import ( - GsaCategoryReplacePermissionCategoryErrorDetail, -) -from .models.gsa_chart_data import GsaChartData -from .models.gsa_chart_data_type import GsaChartDataType -from .models.gsa_circular_reference_folder_move_error_detail import ( - GsaCircularReferenceFolderMoveErrorDetail, -) -from .models.gsa_code_missing_currency_error_detail import GsaCodeMissingCurrencyErrorDetail -from .models.gsa_code_whitespace_currency_error_detail import GsaCodeWhitespaceCurrencyErrorDetail -from .models.gsa_config_invalid_json_file_error_detail import GsaConfigInvalidJsonFileErrorDetail from .models.gsa_configuration import GsaConfiguration -from .models.gsa_configuration_details import GsaConfigurationDetails from .models.gsa_configurations_info import GsaConfigurationsInfo from .models.gsa_connection_details import GsaConnectionDetails from .models.gsa_constant import GsaConstant -from .models.gsa_constant_creation_exception import GsaConstantCreationException from .models.gsa_constant_deletion_exception import GsaConstantDeletionException -from .models.gsa_constant_error_detail import GsaConstantErrorDetail -from .models.gsa_constant_error_reason import GsaConstantErrorReason -from .models.gsa_constant_update_exception import GsaConstantUpdateException -from .models.gsa_constant_usage_data_modification_error_detail import ( - GsaConstantUsageDataModificationErrorDetail, -) from .models.gsa_constants_info import GsaConstantsInfo -from .models.gsa_continuous_quality_system import GsaContinuousQualitySystem from .models.gsa_continuous_range import GsaContinuousRange from .models.gsa_copy_record_history import GsaCopyRecordHistory -from .models.gsa_create_access_control_category import GsaCreateAccessControlCategory -from .models.gsa_create_access_control_category_table_mapping import ( - GsaCreateAccessControlCategoryTableMapping, -) from .models.gsa_create_attribute import GsaCreateAttribute from .models.gsa_create_attribute_link_pair import GsaCreateAttributeLinkPair from .models.gsa_create_axis_name import GsaCreateAxisName from .models.gsa_create_configuration import GsaCreateConfiguration from .models.gsa_create_constant import GsaCreateConstant -from .models.gsa_create_continuous_quality_system import GsaCreateContinuousQualitySystem from .models.gsa_create_continuous_range import GsaCreateContinuousRange -from .models.gsa_create_cross_database_link_target import GsaCreateCrossDatabaseLinkTarget from .models.gsa_create_cross_database_record_link_group import ( GsaCreateCrossDatabaseRecordLinkGroup, ) from .models.gsa_create_data_rule import GsaCreateDataRule -from .models.gsa_create_data_update_server_api_request import GsaCreateDataUpdateServerApiRequest from .models.gsa_create_date_time_attribute import GsaCreateDateTimeAttribute from .models.gsa_create_discrete_attribute import GsaCreateDiscreteAttribute from .models.gsa_create_discrete_functional_attribute import GsaCreateDiscreteFunctionalAttribute @@ -347,9 +208,9 @@ from .models.gsa_create_discrete_parameter import GsaCreateDiscreteParameter from .models.gsa_create_discrete_parameter_content import GsaCreateDiscreteParameterContent from .models.gsa_create_discrete_parameter_value import GsaCreateDiscreteParameterValue -from .models.gsa_create_discrete_quality_system import GsaCreateDiscreteQualitySystem from .models.gsa_create_discrete_range import GsaCreateDiscreteRange from .models.gsa_create_discrete_type import GsaCreateDiscreteType +from .models.gsa_create_dynamic_record_link_group import GsaCreateDynamicRecordLinkGroup from .models.gsa_create_expression import GsaCreateExpression from .models.gsa_create_file_attribute import GsaCreateFileAttribute from .models.gsa_create_float_functional_attribute import GsaCreateFloatFunctionalAttribute @@ -393,55 +254,31 @@ from .models.gsa_create_parameter import GsaCreateParameter from .models.gsa_create_parameter_content import GsaCreateParameterContent from .models.gsa_create_parameter_value import GsaCreateParameterValue -from .models.gsa_create_permission import GsaCreatePermission -from .models.gsa_create_permission_category import GsaCreatePermissionCategory from .models.gsa_create_picture_attribute import GsaCreatePictureAttribute from .models.gsa_create_point_attribute import GsaCreatePointAttribute from .models.gsa_create_profile import GsaCreateProfile from .models.gsa_create_profile_table import GsaCreateProfileTable -from .models.gsa_create_put_discrete_value import GsaCreatePutDiscreteValue -from .models.gsa_create_put_layout_item import GsaCreatePutLayoutItem -from .models.gsa_create_put_permission import GsaCreatePutPermission -from .models.gsa_create_put_permission_category import GsaCreatePutPermissionCategory -from .models.gsa_create_quality_discrete_value import GsaCreateQualityDiscreteValue -from .models.gsa_create_quality_system import GsaCreateQualitySystem from .models.gsa_create_range_attribute import GsaCreateRangeAttribute from .models.gsa_create_record_history import GsaCreateRecordHistory from .models.gsa_create_record_link_group import GsaCreateRecordLinkGroup from .models.gsa_create_record_list import GsaCreateRecordList from .models.gsa_create_record_list_items_info import GsaCreateRecordListItemsInfo from .models.gsa_create_replacement_string import GsaCreateReplacementString +from .models.gsa_create_search_request import GsaCreateSearchRequest from .models.gsa_create_short_text_attribute import GsaCreateShortTextAttribute -from .models.gsa_create_smart_link_target import GsaCreateSmartLinkTarget -from .models.gsa_create_smart_record_link_group import GsaCreateSmartRecordLinkGroup from .models.gsa_create_standard_name import GsaCreateStandardName -from .models.gsa_create_static_link_target import GsaCreateStaticLinkTarget from .models.gsa_create_static_record_link_group import GsaCreateStaticRecordLinkGroup -from .models.gsa_create_static_record_link_group_mapping import ( - GsaCreateStaticRecordLinkGroupMapping, -) from .models.gsa_create_subset import GsaCreateSubset from .models.gsa_create_table import GsaCreateTable from .models.gsa_create_tabular_attribute import GsaCreateTabularAttribute from .models.gsa_create_tabular_column import GsaCreateTabularColumn from .models.gsa_create_unit import GsaCreateUnit -from .models.gsa_create_unit_mapping import GsaCreateUnitMapping from .models.gsa_create_unit_system import GsaCreateUnitSystem from .models.gsa_created_by_user_property import GsaCreatedByUserProperty from .models.gsa_created_date_property import GsaCreatedDateProperty from .models.gsa_criterion import GsaCriterion from .models.gsa_criterion_type import GsaCriterionType -from .models.gsa_cross_database_link import GsaCrossDatabaseLink -from .models.gsa_cross_database_link_create_put_layout_item import ( - GsaCrossDatabaseLinkCreatePutLayoutItem, -) -from .models.gsa_cross_database_record_link import GsaCrossDatabaseRecordLink from .models.gsa_cross_database_record_link_group import GsaCrossDatabaseRecordLinkGroup -from .models.gsa_cross_database_record_link_result import GsaCrossDatabaseRecordLinkResult -from .models.gsa_currencies_info import GsaCurrenciesInfo -from .models.gsa_currency import GsaCurrency -from .models.gsa_currency_error_detail import GsaCurrencyErrorDetail -from .models.gsa_currency_error_reason import GsaCurrencyErrorReason from .models.gsa_current_user import GsaCurrentUser from .models.gsa_data_export_applicable_datum import GsaDataExportApplicableDatum from .models.gsa_data_export_binary_data import GsaDataExportBinaryData @@ -495,31 +332,13 @@ from .models.gsa_data_modification_error_reason import GsaDataModificationErrorReason from .models.gsa_data_rule import GsaDataRule from .models.gsa_data_rules_info import GsaDataRulesInfo -from .models.gsa_data_source import GsaDataSource -from .models.gsa_data_update import GsaDataUpdate -from .models.gsa_data_update_deletion_exception import GsaDataUpdateDeletionException -from .models.gsa_data_update_header import GsaDataUpdateHeader -from .models.gsa_data_update_run_info import GsaDataUpdateRunInfo -from .models.gsa_data_update_token import GsaDataUpdateToken -from .models.gsa_data_updater_job import GsaDataUpdaterJob -from .models.gsa_data_updater_job_status import GsaDataUpdaterJobStatus -from .models.gsa_data_updater_job_type import GsaDataUpdaterJobType -from .models.gsa_data_updater_project import GsaDataUpdaterProject from .models.gsa_data_usage_data_modification_error_detail import ( GsaDataUsageDataModificationErrorDetail, ) from .models.gsa_database import GsaDatabase -from .models.gsa_database_access_control_entity import GsaDatabaseAccessControlEntity -from .models.gsa_database_currency_unit_usage_data_modification_error_detail import ( - GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail, -) -from .models.gsa_database_issues import GsaDatabaseIssues from .models.gsa_database_key_property import GsaDatabaseKeyProperty -from .models.gsa_database_security_groups import GsaDatabaseSecurityGroups -from .models.gsa_database_security_groups_info import GsaDatabaseSecurityGroupsInfo from .models.gsa_database_status import GsaDatabaseStatus from .models.gsa_database_status_information import GsaDatabaseStatusInformation -from .models.gsa_database_user_capabilities import GsaDatabaseUserCapabilities from .models.gsa_databases_info import GsaDatabasesInfo from .models.gsa_date_time_aggregation import GsaDateTimeAggregation from .models.gsa_date_time_aggregation_datum_criterion import GsaDateTimeAggregationDatumCriterion @@ -555,34 +374,15 @@ from .models.gsa_default_expression_not_found_maths_functional_error_detail import ( GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail, ) -from .models.gsa_default_fallback_security_groups import GsaDefaultFallbackSecurityGroups from .models.gsa_default_free_parameter_not_found_maths_functional_error_detail import ( GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail, ) -from .models.gsa_default_layout_guid_error_detail import GsaDefaultLayoutGuidErrorDetail -from .models.gsa_default_parameter_value_guid_parameter_error_detail import ( - GsaDefaultParameterValueGuidParameterErrorDetail, -) -from .models.gsa_default_parameter_value_index_and_guid_parameter_error_detail import ( - GsaDefaultParameterValueIndexAndGuidParameterErrorDetail, -) -from .models.gsa_default_parameter_value_index_parameter_error_detail import ( - GsaDefaultParameterValueIndexParameterErrorDetail, -) -from .models.gsa_default_parameter_value_index_without_values_parameter_error_detail import ( - GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail, -) from .models.gsa_default_parameter_value_usage_data_modification_error_detail import ( GsaDefaultParameterValueUsageDataModificationErrorDetail, ) -from .models.gsa_default_subset_guid_error_detail import GsaDefaultSubsetGuidErrorDetail from .models.gsa_delete_record_list_item import GsaDeleteRecordListItem from .models.gsa_delete_record_list_items import GsaDeleteRecordListItems -from .models.gsa_deletion_entity_type import GsaDeletionEntityType -from .models.gsa_deletion_exception import GsaDeletionException -from .models.gsa_description_length_file_error_detail import GsaDescriptionLengthFileErrorDetail from .models.gsa_discrete_attribute import GsaDiscreteAttribute -from .models.gsa_discrete_chart_data import GsaDiscreteChartData from .models.gsa_discrete_datum import GsaDiscreteDatum from .models.gsa_discrete_datum_exists_criterion import GsaDiscreteDatumExistsCriterion from .models.gsa_discrete_functional_attribute import GsaDiscreteFunctionalAttribute @@ -623,7 +423,6 @@ from .models.gsa_discrete_parameter_name_constraint import GsaDiscreteParameterNameConstraint from .models.gsa_discrete_parameter_value import GsaDiscreteParameterValue from .models.gsa_discrete_parameter_value_constraint import GsaDiscreteParameterValueConstraint -from .models.gsa_discrete_quality_system import GsaDiscreteQualitySystem from .models.gsa_discrete_range import GsaDiscreteRange from .models.gsa_discrete_range_datum_criterion import GsaDiscreteRangeDatumCriterion from .models.gsa_discrete_series import GsaDiscreteSeries @@ -637,61 +436,24 @@ from .models.gsa_discrete_text_prefix_datum_criterion import GsaDiscreteTextPrefixDatumCriterion from .models.gsa_discrete_text_values_datum_criterion import GsaDiscreteTextValuesDatumCriterion from .models.gsa_discrete_type import GsaDiscreteType -from .models.gsa_discrete_type_creation_exception import GsaDiscreteTypeCreationException from .models.gsa_discrete_type_deletion_exception import GsaDiscreteTypeDeletionException -from .models.gsa_discrete_type_error_detail import GsaDiscreteTypeErrorDetail -from .models.gsa_discrete_type_error_reason import GsaDiscreteTypeErrorReason -from .models.gsa_discrete_type_update_exception import GsaDiscreteTypeUpdateException from .models.gsa_discrete_type_usage import GsaDiscreteTypeUsage -from .models.gsa_discrete_type_usage_type import GsaDiscreteTypeUsageType from .models.gsa_discrete_types_info import GsaDiscreteTypesInfo from .models.gsa_discrete_value import GsaDiscreteValue -from .models.gsa_discrete_value_creation_exception import GsaDiscreteValueCreationException -from .models.gsa_discrete_value_deletion_exception import GsaDiscreteValueDeletionException -from .models.gsa_discrete_value_error_detail import GsaDiscreteValueErrorDetail -from .models.gsa_discrete_value_error_reason import GsaDiscreteValueErrorReason -from .models.gsa_discrete_value_not_in_discrete_type_error_detail import ( - GsaDiscreteValueNotInDiscreteTypeErrorDetail, -) -from .models.gsa_discrete_value_update_exception import GsaDiscreteValueUpdateException -from .models.gsa_discrete_value_used_in_data_error_detail import ( - GsaDiscreteValueUsedInDataErrorDetail, -) +from .models.gsa_discrete_value_aggregate_error_reason import GsaDiscreteValueAggregateErrorReason +from .models.gsa_discrete_value_aggregate_exception import GsaDiscreteValueAggregateException from .models.gsa_discrete_values_create_discrete_value import GsaDiscreteValuesCreateDiscreteValue from .models.gsa_discrete_values_discrete_value import GsaDiscreteValuesDiscreteValue from .models.gsa_discrete_values_discrete_values_info import GsaDiscreteValuesDiscreteValuesInfo -from .models.gsa_discrete_values_error_detail import GsaDiscreteValuesErrorDetail from .models.gsa_discrete_values_replace_discrete_values_info import ( GsaDiscreteValuesReplaceDiscreteValuesInfo, ) from .models.gsa_discrete_values_update_discrete_value import GsaDiscreteValuesUpdateDiscreteValue from .models.gsa_disk_status import GsaDiskStatus -from .models.gsa_display_name_empty_error_detail import GsaDisplayNameEmptyErrorDetail -from .models.gsa_display_name_language_not_provided_error_detail import ( - GsaDisplayNameLanguageNotProvidedErrorDetail, -) -from .models.gsa_display_name_language_not_supported_error_detail import ( - GsaDisplayNameLanguageNotSupportedErrorDetail, -) -from .models.gsa_display_names_import_error_detail import GsaDisplayNamesImportErrorDetail -from .models.gsa_display_names_import_error_reason import GsaDisplayNamesImportErrorReason -from .models.gsa_display_names_import_exception import GsaDisplayNamesImportException -from .models.gsa_display_names_info import GsaDisplayNamesInfo -from .models.gsa_divide_by_zero_unit_equation_error_detail import ( - GsaDivideByZeroUnitEquationErrorDetail, -) from .models.gsa_double_sorting_value import GsaDoubleSortingValue -from .models.gsa_duplicate_categories_replace_permission_category_error_detail import ( - GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail, -) -from .models.gsa_duplicate_category_guids_access_control_error_detail import ( - GsaDuplicateCategoryGuidsAccessControlErrorDetail, -) -from .models.gsa_duplicate_code_currency_error_detail import GsaDuplicateCodeCurrencyErrorDetail from .models.gsa_duplicate_database_add_database_validation_issue import ( GsaDuplicateDatabaseAddDatabaseValidationIssue, ) -from .models.gsa_duplicate_discrete_value_error_detail import GsaDuplicateDiscreteValueErrorDetail from .models.gsa_duplicate_expression_guids_maths_functional_error_detail import ( GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail, ) @@ -701,33 +463,9 @@ from .models.gsa_duplicate_key_add_database_validation_issue import ( GsaDuplicateKeyAddDatabaseValidationIssue, ) -from .models.gsa_duplicate_mapped_attribute_guids_error_detail import ( - GsaDuplicateMappedAttributeGuidsErrorDetail, -) -from .models.gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail import ( - GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_duplicate_mapped_parameter_guids_error_detail import ( - GsaDuplicateMappedParameterGuidsErrorDetail, -) -from .models.gsa_duplicate_mapped_record_link_group_guids_error_detail import ( - GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_duplicate_name_currency_error_detail import GsaDuplicateNameCurrencyErrorDetail from .models.gsa_duplicate_parameter_guids_attribute_error_detail import ( GsaDuplicateParameterGuidsAttributeErrorDetail, ) -from .models.gsa_duplicate_permission_guids_access_control_error_detail import ( - GsaDuplicatePermissionGuidsAccessControlErrorDetail, -) -from .models.gsa_duplicate_permissions_permission_category_error_detail import ( - GsaDuplicatePermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_duplicate_symbol_unit_error_detail import GsaDuplicateSymbolUnitErrorDetail -from .models.gsa_duplicate_table_error_detail import GsaDuplicateTableErrorDetail -from .models.gsa_duplicate_tables_reorder_tables_error_detail import ( - GsaDuplicateTablesReorderTablesErrorDetail, -) from .models.gsa_duplicate_tabular_column_guids_error_detail import ( GsaDuplicateTabularColumnGuidsErrorDetail, ) @@ -737,25 +475,17 @@ from .models.gsa_duplicate_version_guid_add_database_validation_issue import ( GsaDuplicateVersionGuidAddDatabaseValidationIssue, ) +from .models.gsa_dynamic_link_group_usage_data_modification_error_detail import ( + GsaDynamicLinkGroupUsageDataModificationErrorDetail, +) +from .models.gsa_dynamic_record_link_group import GsaDynamicRecordLinkGroup from .models.gsa_empty_axis_name_attribute_error_detail import GsaEmptyAxisNameAttributeErrorDetail -from .models.gsa_empty_symbol_unit_error_detail import GsaEmptySymbolUnitErrorDetail -from .models.gsa_empty_table_type_error_detail import GsaEmptyTableTypeErrorDetail from .models.gsa_enabled_licenses_info import GsaEnabledLicensesInfo from .models.gsa_entity_already_exists_error_detail import GsaEntityAlreadyExistsErrorDetail from .models.gsa_entity_identifier_already_specified_error_detail import ( GsaEntityIdentifierAlreadySpecifiedErrorDetail, ) -from .models.gsa_entity_type import GsaEntityType -from .models.gsa_equation_unit_error_detail import GsaEquationUnitErrorDetail -from .models.gsa_error_code import GsaErrorCode -from .models.gsa_error_detail_of_record_history_error_reason import ( - GsaErrorDetailOfRecordHistoryErrorReason, -) -from .models.gsa_error_detail_of_upgrade_database_failure_reason import ( - GsaErrorDetailOfUpgradeDatabaseFailureReason, -) -from .models.gsa_error_response import GsaErrorResponse -from .models.gsa_exception_information import GsaExceptionInformation +from .models.gsa_error_detail import GsaErrorDetail from .models.gsa_exclude_values_specifier import GsaExcludeValuesSpecifier from .models.gsa_existing_tabular_column_guid_error_detail import ( GsaExistingTabularColumnGuidErrorDetail, @@ -764,8 +494,6 @@ from .models.gsa_export_failure_type import GsaExportFailureType from .models.gsa_exporter_refetch_info import GsaExporterRefetchInfo from .models.gsa_expression import GsaExpression -from .models.gsa_expression_access_control_entity import GsaExpressionAccessControlEntity -from .models.gsa_expression_deletion_exception import GsaExpressionDeletionException from .models.gsa_expression_maths_functional_error_detail import ( GsaExpressionMathsFunctionalErrorDetail, ) @@ -776,30 +504,14 @@ GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail, ) from .models.gsa_expressions_info import GsaExpressionsInfo -from .models.gsa_file_already_exists_file_move_error_detail import ( - GsaFileAlreadyExistsFileMoveErrorDetail, -) from .models.gsa_file_attribute import GsaFileAttribute -from .models.gsa_file_creation_exception import GsaFileCreationException from .models.gsa_file_datum import GsaFileDatum from .models.gsa_file_datum_criterion import GsaFileDatumCriterion from .models.gsa_file_datum_exists_criterion import GsaFileDatumExistsCriterion -from .models.gsa_file_error_detail import GsaFileErrorDetail -from .models.gsa_file_error_reason import GsaFileErrorReason from .models.gsa_file_header import GsaFileHeader -from .models.gsa_file_header_info import GsaFileHeaderInfo -from .models.gsa_file_move_error_detail import GsaFileMoveErrorDetail -from .models.gsa_file_move_error_reason import GsaFileMoveErrorReason -from .models.gsa_file_move_exception import GsaFileMoveException -from .models.gsa_file_name_file_error_detail import GsaFileNameFileErrorDetail -from .models.gsa_file_name_folder_error_detail import GsaFileNameFolderErrorDetail from .models.gsa_file_prefix_datum_criterion import GsaFilePrefixDatumCriterion -from .models.gsa_file_update_exception import GsaFileUpdateException from .models.gsa_files_info import GsaFilesInfo -from .models.gsa_find_similar_request import GsaFindSimilarRequest -from .models.gsa_find_similar_response import GsaFindSimilarResponse -from .models.gsa_find_similar_result import GsaFindSimilarResult -from .models.gsa_find_similar_search_criterion import GsaFindSimilarSearchCriterion +from .models.gsa_find_search_request import GsaFindSearchRequest from .models.gsa_find_standard_names import GsaFindStandardNames from .models.gsa_float_functional_aggregation import GsaFloatFunctionalAggregation from .models.gsa_float_functional_aggregation_datum_criterion import ( @@ -833,24 +545,7 @@ from .models.gsa_float_series_graph import GsaFloatSeriesGraph from .models.gsa_float_series_point import GsaFloatSeriesPoint from .models.gsa_folder import GsaFolder -from .models.gsa_folder_already_exists_folder_move_error_detail import ( - GsaFolderAlreadyExistsFolderMoveErrorDetail, -) -from .models.gsa_folder_creation_exception import GsaFolderCreationException -from .models.gsa_folder_deletion_error_detail import GsaFolderDeletionErrorDetail -from .models.gsa_folder_deletion_error_reason import GsaFolderDeletionErrorReason -from .models.gsa_folder_deletion_exception import GsaFolderDeletionException -from .models.gsa_folder_error_detail import GsaFolderErrorDetail -from .models.gsa_folder_error_reason import GsaFolderErrorReason -from .models.gsa_folder_move_error_detail import GsaFolderMoveErrorDetail -from .models.gsa_folder_move_error_reason import GsaFolderMoveErrorReason -from .models.gsa_folder_move_exception import GsaFolderMoveException -from .models.gsa_folder_type import GsaFolderType -from .models.gsa_folder_update_exception import GsaFolderUpdateException from .models.gsa_folders_info import GsaFoldersInfo -from .models.gsa_forbid_orphans_record_link_group_error_detail import ( - GsaForbidOrphansRecordLinkGroupErrorDetail, -) from .models.gsa_free_text_aggregation import GsaFreeTextAggregation from .models.gsa_free_text_aggregation_criterion import GsaFreeTextAggregationCriterion from .models.gsa_free_text_criterion import GsaFreeTextCriterion @@ -858,24 +553,18 @@ from .models.gsa_full_layout_section import GsaFullLayoutSection from .models.gsa_full_name_property import GsaFullNameProperty from .models.gsa_func_no_params_attribute_error_detail import GsaFuncNoParamsAttributeErrorDetail -from .models.gsa_functional_data_default_usage_data_modification_error_detail import ( - GsaFunctionalDataDefaultUsageDataModificationErrorDetail, -) from .models.gsa_functional_datum_parameter_info import GsaFunctionalDatumParameterInfo from .models.gsa_functional_parameter_setting import GsaFunctionalParameterSetting from .models.gsa_functional_type import GsaFunctionalType -from .models.gsa_general_unit_equation_error_detail import GsaGeneralUnitEquationErrorDetail from .models.gsa_generated_integration_schema_of_object_identifier import ( GsaGeneratedIntegrationSchemaOfObjectIdentifier, ) -from .models.gsa_get_find_similar_results_response import GsaGetFindSimilarResultsResponse from .models.gsa_get_jobs_response import GsaGetJobsResponse from .models.gsa_get_jobs_summary_response import GsaGetJobsSummaryResponse from .models.gsa_get_modifiable_record_version_control_exception import ( GsaGetModifiableRecordVersionControlException, ) from .models.gsa_get_unit_conversions_request import GsaGetUnitConversionsRequest -from .models.gsa_get_unit_equivalents_exception import GsaGetUnitEquivalentsException from .models.gsa_graph import GsaGraph from .models.gsa_graph_decoration_type import GsaGraphDecorationType from .models.gsa_graph_evaluation_settings import GsaGraphEvaluationSettings @@ -884,7 +573,6 @@ from .models.gsa_graph_type import GsaGraphType from .models.gsa_graph_value import GsaGraphValue from .models.gsa_graph_value_type import GsaGraphValueType -from .models.gsa_grid import GsaGrid from .models.gsa_grid_graph import GsaGridGraph from .models.gsa_guid_only_attribute import GsaGuidOnlyAttribute from .models.gsa_guid_only_discrete_type import GsaGuidOnlyDiscreteType @@ -895,7 +583,6 @@ from .models.gsa_guid_only_layout import GsaGuidOnlyLayout from .models.gsa_guid_only_mapping_of_object_identifier import GsaGuidOnlyMappingOfObjectIdentifier from .models.gsa_guid_only_source_of_object_identifier import GsaGuidOnlySourceOfObjectIdentifier -from .models.gsa_help_paths_validation_response import GsaHelpPathsValidationResponse from .models.gsa_histogram import GsaHistogram from .models.gsa_histogram_bucket import GsaHistogramBucket from .models.gsa_hyperlink_attribute import GsaHyperlinkAttribute @@ -904,18 +591,12 @@ from .models.gsa_hyperlink_datum_exists_criterion import GsaHyperlinkDatumExistsCriterion from .models.gsa_hyperlink_prefix_datum_criterion import GsaHyperlinkPrefixDatumCriterion from .models.gsa_hyperlink_target import GsaHyperlinkTarget -from .models.gsa_in_use_parameter_value_error_detail import GsaInUseParameterValueErrorDetail -from .models.gsa_inclusiveness import GsaInclusiveness -from .models.gsa_incompatible_units_error_detail import GsaIncompatibleUnitsErrorDetail from .models.gsa_index_record_failure import GsaIndexRecordFailure from .models.gsa_indirect_links import GsaIndirectLinks -from .models.gsa_input_connection_details import GsaInputConnectionDetails from .models.gsa_input_validation_error_detail import GsaInputValidationErrorDetail -from .models.gsa_input_validation_error_reason import GsaInputValidationErrorReason from .models.gsa_integer_aggregation import GsaIntegerAggregation from .models.gsa_integer_aggregation_datum_criterion import GsaIntegerAggregationDatumCriterion from .models.gsa_integer_attribute import GsaIntegerAttribute -from .models.gsa_integer_chart_data import GsaIntegerChartData from .models.gsa_integer_datum import GsaIntegerDatum from .models.gsa_integer_datum_criterion import GsaIntegerDatumCriterion from .models.gsa_integer_datum_exists_criterion import GsaIntegerDatumExistsCriterion @@ -938,12 +619,6 @@ GsaIntegrationSchemaOfObjectIdentifier, ) from .models.gsa_integration_schema_status import GsaIntegrationSchemaStatus -from .models.gsa_invalid_equivalence_target_error_detail import ( - GsaInvalidEquivalenceTargetErrorDetail, -) -from .models.gsa_invalid_exchange_rate_currency_error_detail import ( - GsaInvalidExchangeRateCurrencyErrorDetail, -) from .models.gsa_invalid_key_add_database_validation_issue import ( GsaInvalidKeyAddDatabaseValidationIssue, ) @@ -965,7 +640,6 @@ from .models.gsa_layout_sections_info import GsaLayoutSectionsInfo from .models.gsa_layout_tabular_column import GsaLayoutTabularColumn from .models.gsa_layouts_info import GsaLayoutsInfo -from .models.gsa_link import GsaLink from .models.gsa_link_aggregation import GsaLinkAggregation from .models.gsa_link_aggregation_datum_criterion import GsaLinkAggregationDatumCriterion from .models.gsa_link_attribute_to_export import GsaLinkAttributeToExport @@ -1022,33 +696,19 @@ from .models.gsa_local_range_tabular_column import GsaLocalRangeTabularColumn from .models.gsa_local_rows_behavior import GsaLocalRowsBehavior from .models.gsa_local_short_text_tabular_column import GsaLocalShortTextTabularColumn -from .models.gsa_log_scale_negative_parameter_value_error_detail import ( - GsaLogScaleNegativeParameterValueErrorDetail, -) from .models.gsa_logical_aggregation import GsaLogicalAggregation from .models.gsa_logical_aggregation_datum_criterion import GsaLogicalAggregationDatumCriterion from .models.gsa_logical_attribute import GsaLogicalAttribute -from .models.gsa_logical_chart_data import GsaLogicalChartData from .models.gsa_logical_datum import GsaLogicalDatum from .models.gsa_logical_datum_criterion import GsaLogicalDatumCriterion from .models.gsa_logical_datum_exists_criterion import GsaLogicalDatumExistsCriterion -from .models.gsa_long_running_operation import GsaLongRunningOperation -from .models.gsa_long_running_operation_include import GsaLongRunningOperationInclude -from .models.gsa_long_running_operation_invalid_status_exception import ( - GsaLongRunningOperationInvalidStatusException, -) -from .models.gsa_long_running_status import GsaLongRunningStatus from .models.gsa_long_sorting_value import GsaLongSortingValue from .models.gsa_long_text_attribute import GsaLongTextAttribute from .models.gsa_long_text_datum import GsaLongTextDatum from .models.gsa_long_text_datum_criterion import GsaLongTextDatumCriterion from .models.gsa_long_text_datum_exists_criterion import GsaLongTextDatumExistsCriterion from .models.gsa_long_text_prefix_datum_criterion import GsaLongTextPrefixDatumCriterion -from .models.gsa_many_to_many_forbid_orphans_record_link_group_error_detail import ( - GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail, -) from .models.gsa_mapping_of_object_identifier import GsaMappingOfObjectIdentifier -from .models.gsa_match_mode import GsaMatchMode from .models.gsa_maths_content import GsaMathsContent from .models.gsa_maths_functional_attribute import GsaMathsFunctionalAttribute from .models.gsa_maths_functional_attribute_error_detail import ( @@ -1060,12 +720,6 @@ ) from .models.gsa_maths_functional_error_detail import GsaMathsFunctionalErrorDetail from .models.gsa_maths_functional_error_reason import GsaMathsFunctionalErrorReason -from .models.gsa_max_permissions_reached_permission_error_detail import ( - GsaMaxPermissionsReachedPermissionErrorDetail, -) -from .models.gsa_meta_attribute_cannot_have_meta_attribute_error_detail import ( - GsaMetaAttributeCannotHaveMetaAttributeErrorDetail, -) from .models.gsa_mfa_expression_error_detail import GsaMfaExpressionErrorDetail from .models.gsa_mfa_expression_error_reason import GsaMfaExpressionErrorReason from .models.gsa_mi_version import GsaMiVersion @@ -1078,66 +732,12 @@ from .models.gsa_move_file import GsaMoveFile from .models.gsa_move_folder import GsaMoveFolder from .models.gsa_move_record_history import GsaMoveRecordHistory -from .models.gsa_multi_valued_attribute_error_detail import GsaMultiValuedAttributeErrorDetail -from .models.gsa_multi_valued_point_data_usage_data_modification_error_detail import ( - GsaMultiValuedPointDataUsageDataModificationErrorDetail, -) -from .models.gsa_multi_valued_reason import GsaMultiValuedReason -from .models.gsa_multi_valued_smart_attributes_error_detail import ( - GsaMultiValuedSmartAttributesErrorDetail, -) -from .models.gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail import ( - GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail, -) -from .models.gsa_name_already_exists_as_reverse_record_link_group_error_detail import ( - GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail, -) from .models.gsa_name_already_exists_error_detail import GsaNameAlreadyExistsErrorDetail -from .models.gsa_name_already_specified_error_detail import GsaNameAlreadySpecifiedErrorDetail -from .models.gsa_name_missing_currency_error_detail import GsaNameMissingCurrencyErrorDetail from .models.gsa_name_not_provided_error_detail import GsaNameNotProvidedErrorDetail -from .models.gsa_name_same_as_reverse_name_record_link_group_error_detail import ( - GsaNameSameAsReverseNameRecordLinkGroupErrorDetail, -) -from .models.gsa_name_whitespace_currency_error_detail import GsaNameWhitespaceCurrencyErrorDetail -from .models.gsa_name_whitespace_parameter_value_error_detail import ( - GsaNameWhitespaceParameterValueErrorDetail, -) from .models.gsa_named_criterion import GsaNamedCriterion -from .models.gsa_named_entity_access_control_category_error_detail import ( - GsaNamedEntityAccessControlCategoryErrorDetail, -) from .models.gsa_named_entity_attribute_error_detail import GsaNamedEntityAttributeErrorDetail -from .models.gsa_named_entity_constant_error_detail import GsaNamedEntityConstantErrorDetail -from .models.gsa_named_entity_discrete_type_error_detail import ( - GsaNamedEntityDiscreteTypeErrorDetail, -) -from .models.gsa_named_entity_discrete_value_error_detail import ( - GsaNamedEntityDiscreteValueErrorDetail, -) from .models.gsa_named_entity_error_detail import GsaNamedEntityErrorDetail from .models.gsa_named_entity_error_reason import GsaNamedEntityErrorReason -from .models.gsa_named_entity_file_error_detail import GsaNamedEntityFileErrorDetail -from .models.gsa_named_entity_folder_error_detail import GsaNamedEntityFolderErrorDetail -from .models.gsa_named_entity_parameter_error_detail import GsaNamedEntityParameterErrorDetail -from .models.gsa_named_entity_parameter_value_error_detail import ( - GsaNamedEntityParameterValueErrorDetail, -) -from .models.gsa_named_entity_permission_category_error_detail import ( - GsaNamedEntityPermissionCategoryErrorDetail, -) -from .models.gsa_named_entity_permission_error_detail import GsaNamedEntityPermissionErrorDetail -from .models.gsa_named_entity_quality_discrete_value_error_detail import ( - GsaNamedEntityQualityDiscreteValueErrorDetail, -) -from .models.gsa_named_entity_quality_system_error_detail import ( - GsaNamedEntityQualitySystemErrorDetail, -) -from .models.gsa_named_entity_record_link_group_error_detail import ( - GsaNamedEntityRecordLinkGroupErrorDetail, -) -from .models.gsa_named_entity_table_error_detail import GsaNamedEntityTableErrorDetail -from .models.gsa_named_entity_unit_error_detail import GsaNamedEntityUnitErrorDetail from .models.gsa_new_layout_association_chain_item import GsaNewLayoutAssociationChainItem from .models.gsa_new_layout_association_chain_link import GsaNewLayoutAssociationChainLink from .models.gsa_new_layout_attribute_item import GsaNewLayoutAttributeItem @@ -1146,41 +746,9 @@ from .models.gsa_new_layout_item_type import GsaNewLayoutItemType from .models.gsa_new_layout_record_link_item import GsaNewLayoutRecordLinkItem from .models.gsa_new_layout_smart_link_item import GsaNewLayoutSmartLinkItem -from .models.gsa_no_attribute_pairs_smart_attributes_error_detail import ( - GsaNoAttributePairsSmartAttributesErrorDetail, -) -from .models.gsa_no_data_file_error_detail import GsaNoDataFileErrorDetail from .models.gsa_no_expressions_maths_functional_error_detail import ( GsaNoExpressionsMathsFunctionalErrorDetail, ) -from .models.gsa_no_file_file_error_detail import GsaNoFileFileErrorDetail -from .models.gsa_no_parameter_values_parameter_error_detail import ( - GsaNoParameterValuesParameterErrorDetail, -) -from .models.gsa_no_permissions_permission_category_error_detail import ( - GsaNoPermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_no_quality_discrete_values_error_detail import ( - GsaNoQualityDiscreteValuesErrorDetail, -) -from .models.gsa_no_such_attribute_smart_attributes_error_detail import ( - GsaNoSuchAttributeSmartAttributesErrorDetail, -) -from .models.gsa_no_such_categories_replace_permission_category_error_detail import ( - GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail, -) -from .models.gsa_no_such_category_access_control_error_detail import ( - GsaNoSuchCategoryAccessControlErrorDetail, -) -from .models.gsa_no_such_discrete_value_in_discrete_type_error_detail import ( - GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail, -) -from .models.gsa_no_such_entities_access_control_entities_error_detail import ( - GsaNoSuchEntitiesAccessControlEntitiesErrorDetail, -) -from .models.gsa_no_such_entity_access_control_category_error_detail import ( - GsaNoSuchEntityAccessControlCategoryErrorDetail, -) from .models.gsa_no_such_entity_attribute_error_detail import GsaNoSuchEntityAttributeErrorDetail from .models.gsa_no_such_entity_tabular_column_error_detail import ( GsaNoSuchEntityTabularColumnErrorDetail, @@ -1188,66 +756,21 @@ from .models.gsa_no_such_expressions_maths_functional_error_detail import ( GsaNoSuchExpressionsMathsFunctionalErrorDetail, ) -from .models.gsa_no_such_new_parent_file_move_error_detail import ( - GsaNoSuchNewParentFileMoveErrorDetail, -) -from .models.gsa_no_such_new_parent_folder_move_error_detail import ( - GsaNoSuchNewParentFolderMoveErrorDetail, -) from .models.gsa_no_such_parameter_value_parameter_content_error_detail import ( GsaNoSuchParameterValueParameterContentErrorDetail, ) -from .models.gsa_no_such_permission_access_control_error_detail import ( - GsaNoSuchPermissionAccessControlErrorDetail, -) -from .models.gsa_no_such_permissions_permission_category_error_detail import ( - GsaNoSuchPermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_no_such_subset_access_control_entities_error_detail import ( - GsaNoSuchSubsetAccessControlEntitiesErrorDetail, -) -from .models.gsa_no_such_table_mapping_error_detail import GsaNoSuchTableMappingErrorDetail -from .models.gsa_no_such_tables_reorder_tables_error_detail import ( - GsaNoSuchTablesReorderTablesErrorDetail, -) -from .models.gsa_no_such_tabular_column_attribute_error_detail import ( - GsaNoSuchTabularColumnAttributeErrorDetail, -) -from .models.gsa_no_such_target_table_record_link_group_error_detail import ( - GsaNoSuchTargetTableRecordLinkGroupErrorDetail, -) -from .models.gsa_no_such_unit_constant_error_detail import GsaNoSuchUnitConstantErrorDetail -from .models.gsa_no_such_unit_parameter_error_detail import GsaNoSuchUnitParameterErrorDetail -from .models.gsa_no_such_unit_system_unit_equivalent_error_detail import ( - GsaNoSuchUnitSystemUnitEquivalentErrorDetail, -) -from .models.gsa_no_such_unit_unit_equivalent_error_detail import ( - GsaNoSuchUnitUnitEquivalentErrorDetail, -) from .models.gsa_no_value_exists_graph_value import GsaNoValueExistsGraphValue from .models.gsa_no_values_specifier import GsaNoValuesSpecifier -from .models.gsa_non_custom_standard_name_cannot_be_changed_error_detail import ( - GsaNonCustomStandardNameCannotBeChangedErrorDetail, -) from .models.gsa_not_applicable_datum import GsaNotApplicableDatum from .models.gsa_not_the_latest_version_error_detail import GsaNotTheLatestVersionErrorDetail from .models.gsa_not_versioned_error_detail import GsaNotVersionedErrorDetail -from .models.gsa_number_parsing_unit_equation_error_detail import ( - GsaNumberParsingUnitEquationErrorDetail, -) from .models.gsa_numeric_graph_parameter_value import GsaNumericGraphParameterValue from .models.gsa_numeric_parameter import GsaNumericParameter from .models.gsa_numeric_parameter_constraint import GsaNumericParameterConstraint from .models.gsa_numeric_parameter_content import GsaNumericParameterContent from .models.gsa_numeric_parameter_data_value import GsaNumericParameterDataValue from .models.gsa_numeric_parameter_value import GsaNumericParameterValue -from .models.gsa_numeric_restricted_interpolation_parameter_error_detail import ( - GsaNumericRestrictedInterpolationParameterErrorDetail, -) from .models.gsa_object_identifier import GsaObjectIdentifier -from .models.gsa_paginated_item_type import GsaPaginatedItemType -from .models.gsa_paginated_response_of import GsaPaginatedResponseOf -from .models.gsa_pagination_links import GsaPaginationLinks from .models.gsa_paging_options import GsaPagingOptions from .models.gsa_parameter import GsaParameter from .models.gsa_parameter_constraint import GsaParameterConstraint @@ -1265,11 +788,8 @@ from .models.gsa_parameter_content_unknown_parameters_maths_functional_error_detail import ( GsaParameterContentUnknownParametersMathsFunctionalErrorDetail, ) -from .models.gsa_parameter_creation_exception import GsaParameterCreationException from .models.gsa_parameter_data_value import GsaParameterDataValue from .models.gsa_parameter_deletion_exception import GsaParameterDeletionException -from .models.gsa_parameter_error_detail import GsaParameterErrorDetail -from .models.gsa_parameter_error_reason import GsaParameterErrorReason from .models.gsa_parameter_info import GsaParameterInfo from .models.gsa_parameter_info_interpolation_type import GsaParameterInfoInterpolationType from .models.gsa_parameter_info_parameter_type import GsaParameterInfoParameterType @@ -1281,92 +801,14 @@ from .models.gsa_parameter_type_parameter_content_error_detail import ( GsaParameterTypeParameterContentErrorDetail, ) -from .models.gsa_parameter_type_parameter_error_detail import GsaParameterTypeParameterErrorDetail -from .models.gsa_parameter_update_exception import GsaParameterUpdateException -from .models.gsa_parameter_usage_data_modification_error_detail import ( - GsaParameterUsageDataModificationErrorDetail, -) from .models.gsa_parameter_value import GsaParameterValue -from .models.gsa_parameter_value_creation_exception import GsaParameterValueCreationException from .models.gsa_parameter_value_deletion_exception import GsaParameterValueDeletionException -from .models.gsa_parameter_value_error_detail import GsaParameterValueErrorDetail -from .models.gsa_parameter_value_error_reason import GsaParameterValueErrorReason -from .models.gsa_parameter_value_parameter_error_detail import GsaParameterValueParameterErrorDetail from .models.gsa_parameter_value_type import GsaParameterValueType -from .models.gsa_parameter_value_type_parameter_value_error_detail import ( - GsaParameterValueTypeParameterValueErrorDetail, -) -from .models.gsa_parameter_value_update_exception import GsaParameterValueUpdateException -from .models.gsa_parameter_value_used_by_type import GsaParameterValueUsedByType from .models.gsa_parameter_with_data_value import GsaParameterWithDataValue from .models.gsa_parameters_info import GsaParametersInfo from .models.gsa_permission import GsaPermission -from .models.gsa_permission_access_control import GsaPermissionAccessControl -from .models.gsa_permission_access_control_aggregate import GsaPermissionAccessControlAggregate -from .models.gsa_permission_based_access_control_aggregation_error_detail import ( - GsaPermissionBasedAccessControlAggregationErrorDetail, -) -from .models.gsa_permission_based_access_control_aggregation_error_reason import ( - GsaPermissionBasedAccessControlAggregationErrorReason, -) -from .models.gsa_permission_based_access_control_aggregation_exception import ( - GsaPermissionBasedAccessControlAggregationException, -) -from .models.gsa_permission_based_access_control_entities_error_reason import ( - GsaPermissionBasedAccessControlEntitiesErrorReason, -) -from .models.gsa_permission_based_access_control_info import GsaPermissionBasedAccessControlInfo -from .models.gsa_permission_based_access_control_update_operation_exception import ( - GsaPermissionBasedAccessControlUpdateOperationException, -) -from .models.gsa_permission_based_access_control_update_operations_error_detail import ( - GsaPermissionBasedAccessControlUpdateOperationsErrorDetail, -) -from .models.gsa_permission_based_access_control_update_operations_error_reason import ( - GsaPermissionBasedAccessControlUpdateOperationsErrorReason, -) -from .models.gsa_permission_categories_access_control_error_detail import ( - GsaPermissionCategoriesAccessControlErrorDetail, -) -from .models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) -from .models.gsa_permission_categories_access_control_update_exception import ( - GsaPermissionCategoriesAccessControlUpdateException, -) from .models.gsa_permission_categories_info import GsaPermissionCategoriesInfo -from .models.gsa_permission_categories_update_operations_error_detail import ( - GsaPermissionCategoriesUpdateOperationsErrorDetail, -) from .models.gsa_permission_category import GsaPermissionCategory -from .models.gsa_permission_category_access_control import GsaPermissionCategoryAccessControl -from .models.gsa_permission_category_access_control_aggregate import ( - GsaPermissionCategoryAccessControlAggregate, -) -from .models.gsa_permission_category_access_control_aggregate_info import ( - GsaPermissionCategoryAccessControlAggregateInfo, -) -from .models.gsa_permission_category_access_control_info import ( - GsaPermissionCategoryAccessControlInfo, -) -from .models.gsa_permission_category_creation_exception import ( - GsaPermissionCategoryCreationException, -) -from .models.gsa_permission_category_error_detail import GsaPermissionCategoryErrorDetail -from .models.gsa_permission_category_error_reason import GsaPermissionCategoryErrorReason -from .models.gsa_permission_category_replace_exception import GsaPermissionCategoryReplaceException -from .models.gsa_permission_category_update_exception import GsaPermissionCategoryUpdateException -from .models.gsa_permission_creation_exception import GsaPermissionCreationException -from .models.gsa_permission_deletion_error_detail import GsaPermissionDeletionErrorDetail -from .models.gsa_permission_deletion_error_reason import GsaPermissionDeletionErrorReason -from .models.gsa_permission_deletion_exception import GsaPermissionDeletionException -from .models.gsa_permission_error_detail import GsaPermissionErrorDetail -from .models.gsa_permission_error_reason import GsaPermissionErrorReason -from .models.gsa_permission_permission_category_error_detail import ( - GsaPermissionPermissionCategoryErrorDetail, -) -from .models.gsa_permission_update_exception import GsaPermissionUpdateException -from .models.gsa_permissions_in_use_info import GsaPermissionsInUseInfo from .models.gsa_permissions_info import GsaPermissionsInfo from .models.gsa_picture_attribute import GsaPictureAttribute from .models.gsa_picture_datum import GsaPictureDatum @@ -1375,7 +817,6 @@ from .models.gsa_point_aggregation import GsaPointAggregation from .models.gsa_point_aggregation_datum_criterion import GsaPointAggregationDatumCriterion from .models.gsa_point_attribute import GsaPointAttribute -from .models.gsa_point_chart_data import GsaPointChartData from .models.gsa_point_data_value import GsaPointDataValue from .models.gsa_point_datum import GsaPointDatum from .models.gsa_point_datum_criterion import GsaPointDatumCriterion @@ -1395,23 +836,6 @@ from .models.gsa_profile_table import GsaProfileTable from .models.gsa_profile_tables_info import GsaProfileTablesInfo from .models.gsa_property import GsaProperty -from .models.gsa_put_discrete_value import GsaPutDiscreteValue -from .models.gsa_put_layout_item import GsaPutLayoutItem -from .models.gsa_put_permission import GsaPutPermission -from .models.gsa_put_permission_category import GsaPutPermissionCategory -from .models.gsa_put_type import GsaPutType -from .models.gsa_quality_discrete_value import GsaQualityDiscreteValue -from .models.gsa_quality_discrete_value_error_detail import GsaQualityDiscreteValueErrorDetail -from .models.gsa_quality_discrete_value_error_reason import GsaQualityDiscreteValueErrorReason -from .models.gsa_quality_discrete_values_error_detail import GsaQualityDiscreteValuesErrorDetail -from .models.gsa_quality_system import GsaQualitySystem -from .models.gsa_quality_system_creation_exception import GsaQualitySystemCreationException -from .models.gsa_quality_system_deletion_exception import GsaQualitySystemDeletionException -from .models.gsa_quality_system_error_detail import GsaQualitySystemErrorDetail -from .models.gsa_quality_system_error_reason import GsaQualitySystemErrorReason -from .models.gsa_quality_system_guid_error_detail import GsaQualitySystemGuidErrorDetail -from .models.gsa_quality_system_type import GsaQualitySystemType -from .models.gsa_quality_systems_info import GsaQualitySystemsInfo from .models.gsa_query_attribute import GsaQueryAttribute from .models.gsa_query_attribute_filter import GsaQueryAttributeFilter from .models.gsa_query_attribute_info import GsaQueryAttributeInfo @@ -1428,25 +852,9 @@ from .models.gsa_query_discrete_type_properties import GsaQueryDiscreteTypeProperties from .models.gsa_query_discrete_types_info import GsaQueryDiscreteTypesInfo from .models.gsa_query_discrete_types_request import GsaQueryDiscreteTypesRequest -from .models.gsa_query_layout import GsaQueryLayout -from .models.gsa_query_layout_filter import GsaQueryLayoutFilter -from .models.gsa_query_layout_item import GsaQueryLayoutItem -from .models.gsa_query_layout_item_filter import GsaQueryLayoutItemFilter -from .models.gsa_query_layout_item_properties import GsaQueryLayoutItemProperties -from .models.gsa_query_layout_properties import GsaQueryLayoutProperties -from .models.gsa_query_layout_section import GsaQueryLayoutSection -from .models.gsa_query_layout_section_filter import GsaQueryLayoutSectionFilter -from .models.gsa_query_layout_section_properties import GsaQueryLayoutSectionProperties -from .models.gsa_query_layout_sections_info import GsaQueryLayoutSectionsInfo -from .models.gsa_query_layout_sections_request import GsaQueryLayoutSectionsRequest -from .models.gsa_query_layouts_info import GsaQueryLayoutsInfo -from .models.gsa_query_layouts_request import GsaQueryLayoutsRequest from .models.gsa_query_slim_discrete_type import GsaQuerySlimDiscreteType from .models.gsa_query_slim_discrete_type_properties import GsaQuerySlimDiscreteTypeProperties -from .models.gsa_query_slim_entity import GsaQuerySlimEntity -from .models.gsa_query_slim_entity_properties import GsaQuerySlimEntityProperties from .models.gsa_query_slim_named_entity import GsaQuerySlimNamedEntity -from .models.gsa_query_slim_named_entity_filter import GsaQuerySlimNamedEntityFilter from .models.gsa_query_slim_named_entity_properties import GsaQuerySlimNamedEntityProperties from .models.gsa_query_slim_typed_attribute import GsaQuerySlimTypedAttribute from .models.gsa_query_slim_typed_attribute_properties import GsaQuerySlimTypedAttributeProperties @@ -1459,18 +867,14 @@ from .models.gsa_query_tabular_attribute_target_properties import ( GsaQueryTabularAttributeTargetProperties, ) -from .models.gsa_query_tabular_column import GsaQueryTabularColumn -from .models.gsa_query_tabular_column_properties import GsaQueryTabularColumnProperties from .models.gsa_query_unit import GsaQueryUnit from .models.gsa_query_unit_properties import GsaQueryUnitProperties from .models.gsa_range_aggregation import GsaRangeAggregation from .models.gsa_range_aggregation_datum_criterion import GsaRangeAggregationDatumCriterion from .models.gsa_range_attribute import GsaRangeAttribute -from .models.gsa_range_chart_data import GsaRangeChartData from .models.gsa_range_datum import GsaRangeDatum from .models.gsa_range_datum_criterion import GsaRangeDatumCriterion from .models.gsa_range_datum_exists_criterion import GsaRangeDatumExistsCriterion -from .models.gsa_range_endpoint import GsaRangeEndpoint from .models.gsa_range_fixed_width_histogram_aggregation_datum_criterion import ( GsaRangeFixedWidthHistogramAggregationDatumCriterion, ) @@ -1481,32 +885,19 @@ ) from .models.gsa_record_ancestor_criterion import GsaRecordAncestorCriterion from .models.gsa_record_ancestor_history_criterion import GsaRecordAncestorHistoryCriterion -from .models.gsa_record_and_attribute_selection_type import GsaRecordAndAttributeSelectionType +from .models.gsa_record_capabilities import GsaRecordCapabilities from .models.gsa_record_color import GsaRecordColor from .models.gsa_record_color_property import GsaRecordColorProperty from .models.gsa_record_export_failure import GsaRecordExportFailure from .models.gsa_record_guid_property import GsaRecordGuidProperty from .models.gsa_record_history import GsaRecordHistory from .models.gsa_record_history_copy_exception import GsaRecordHistoryCopyException -from .models.gsa_record_history_descendants_access_control_entity import ( - GsaRecordHistoryDescendantsAccessControlEntity, -) -from .models.gsa_record_history_error_reason import GsaRecordHistoryErrorReason from .models.gsa_record_history_guid_property import GsaRecordHistoryGuidProperty from .models.gsa_record_history_move_exception import GsaRecordHistoryMoveException from .models.gsa_record_history_reference import GsaRecordHistoryReference -from .models.gsa_record_link import GsaRecordLink -from .models.gsa_record_link_base import GsaRecordLinkBase -from .models.gsa_record_link_create_put_layout_item import GsaRecordLinkCreatePutLayoutItem from .models.gsa_record_link_group import GsaRecordLinkGroup -from .models.gsa_record_link_group_creation_exception import GsaRecordLinkGroupCreationException -from .models.gsa_record_link_group_error_detail import GsaRecordLinkGroupErrorDetail -from .models.gsa_record_link_group_error_reason import GsaRecordLinkGroupErrorReason from .models.gsa_record_link_group_type import GsaRecordLinkGroupType -from .models.gsa_record_link_group_update_exception import GsaRecordLinkGroupUpdateException from .models.gsa_record_link_groups_info import GsaRecordLinkGroupsInfo -from .models.gsa_record_link_result import GsaRecordLinkResult -from .models.gsa_record_link_results import GsaRecordLinkResults from .models.gsa_record_list_header import GsaRecordListHeader from .models.gsa_record_list_headers_info import GsaRecordListHeadersInfo from .models.gsa_record_list_items_info import GsaRecordListItemsInfo @@ -1526,19 +917,12 @@ from .models.gsa_record_reference_type import GsaRecordReferenceType from .models.gsa_record_subset_criterion import GsaRecordSubsetCriterion from .models.gsa_record_type import GsaRecordType -from .models.gsa_record_type_criterion import GsaRecordTypeCriterion from .models.gsa_record_type_property import GsaRecordTypeProperty -from .models.gsa_record_user_capabilities import GsaRecordUserCapabilities from .models.gsa_record_version import GsaRecordVersion -from .models.gsa_record_version_access_control_entity import GsaRecordVersionAccessControlEntity from .models.gsa_record_version_reference import GsaRecordVersionReference from .models.gsa_record_with_data import GsaRecordWithData from .models.gsa_referenced_by_type import GsaReferencedByType from .models.gsa_referential_integrity_model import GsaReferentialIntegrityModel -from .models.gsa_referential_integrity_model_record_link_group_error_detail import ( - GsaReferentialIntegrityModelRecordLinkGroupErrorDetail, -) -from .models.gsa_register_update_request import GsaRegisterUpdateRequest from .models.gsa_release_record_version_control_exception import ( GsaReleaseRecordVersionControlException, ) @@ -1549,56 +933,18 @@ from .models.gsa_relevance_sort_criterion import GsaRelevanceSortCriterion from .models.gsa_remove_record_history_from_subset import GsaRemoveRecordHistoryFromSubset from .models.gsa_reorder_sections_info import GsaReorderSectionsInfo -from .models.gsa_reorder_tables_error_detail import GsaReorderTablesErrorDetail -from .models.gsa_reorder_tables_error_reason import GsaReorderTablesErrorReason -from .models.gsa_reorder_tables_exception import GsaReorderTablesException -from .models.gsa_reorder_tables_request import GsaReorderTablesRequest -from .models.gsa_replace_discrete_values_exception import GsaReplaceDiscreteValuesException -from .models.gsa_replace_permission_categories_request import GsaReplacePermissionCategoriesRequest -from .models.gsa_replace_permission_category_error_detail import ( - GsaReplacePermissionCategoryErrorDetail, -) -from .models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) from .models.gsa_replacement_string import GsaReplacementString from .models.gsa_replacement_strings_info import GsaReplacementStringsInfo -from .models.gsa_resolve_link_targets_info import GsaResolveLinkTargetsInfo -from .models.gsa_resolve_link_targets_request import GsaResolveLinkTargetsRequest -from .models.gsa_resolved_breadcrumb import GsaResolvedBreadcrumb +from .models.gsa_resolved_link import GsaResolvedLink +from .models.gsa_resolved_link_info import GsaResolvedLinkInfo from .models.gsa_resolved_link_target import GsaResolvedLinkTarget -from .models.gsa_resolved_target_attribute import GsaResolvedTargetAttribute from .models.gsa_response_options import GsaResponseOptions from .models.gsa_resubmit_job_request import GsaResubmitJobRequest -from .models.gsa_retarget_potential_request import GsaRetargetPotentialRequest -from .models.gsa_retarget_request import GsaRetargetRequest -from .models.gsa_retarget_result import GsaRetargetResult -from .models.gsa_retarget_result_type import GsaRetargetResultType -from .models.gsa_retarget_results_info import GsaRetargetResultsInfo -from .models.gsa_reverse_name_already_exists_as_name_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail, -) -from .models.gsa_reverse_name_already_exists_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail, -) -from .models.gsa_reverse_name_not_provided_record_link_group_error_detail import ( - GsaReverseNameNotProvidedRecordLinkGroupErrorDetail, -) from .models.gsa_rich_text_type import GsaRichTextType from .models.gsa_rich_text_value import GsaRichTextValue -from .models.gsa_role_not_provided_permission_error_detail import ( - GsaRoleNotProvidedPermissionErrorDetail, -) from .models.gsa_rollup_export_failure import GsaRollupExportFailure from .models.gsa_rollup_reference import GsaRollupReference -from .models.gsa_root_folder_move_error_detail import GsaRootFolderMoveErrorDetail -from .models.gsa_root_record_not_available_to_rename_error_detail import ( - GsaRootRecordNotAvailableToRenameErrorDetail, -) -from .models.gsa_rule_engine import GsaRuleEngine -from .models.gsa_same_parent_file_move_error_detail import GsaSameParentFileMoveErrorDetail -from .models.gsa_same_parent_folder_move_error_detail import GsaSameParentFolderMoveErrorDetail -from .models.gsa_schema_generation_warning_reason import GsaSchemaGenerationWarningReason +from .models.gsa_save_search_request import GsaSaveSearchRequest from .models.gsa_schema_too_new_add_database_validation_issue import ( GsaSchemaTooNewAddDatabaseValidationIssue, ) @@ -1606,9 +952,8 @@ GsaSchemaTooOldAddDatabaseValidationIssue, ) from .models.gsa_search_cluster_status import GsaSearchClusterStatus +from .models.gsa_search_detail import GsaSearchDetail from .models.gsa_search_index_status import GsaSearchIndexStatus -from .models.gsa_search_mask import GsaSearchMask -from .models.gsa_search_mask_info import GsaSearchMaskInfo from .models.gsa_search_mask_usage_data_modification_error_detail import ( GsaSearchMaskUsageDataModificationErrorDetail, ) @@ -1616,20 +961,13 @@ from .models.gsa_search_response import GsaSearchResponse from .models.gsa_search_result import GsaSearchResult from .models.gsa_search_results_request import GsaSearchResultsRequest -from .models.gsa_search_service_status import GsaSearchServiceStatus -from .models.gsa_search_template import GsaSearchTemplate -from .models.gsa_search_template_attribute_item import GsaSearchTemplateAttributeItem -from .models.gsa_search_template_info import GsaSearchTemplateInfo -from .models.gsa_search_template_item import GsaSearchTemplateItem -from .models.gsa_search_template_item_type import GsaSearchTemplateItemType -from .models.gsa_search_template_link_item import GsaSearchTemplateLinkItem -from .models.gsa_search_template_tabular_column_item import GsaSearchTemplateTabularColumnItem from .models.gsa_searchable_record_property import GsaSearchableRecordProperty +from .models.gsa_security_attribute_grouping import GsaSecurityAttributeGrouping from .models.gsa_security_attribute_usage_data_modification_error_detail import ( GsaSecurityAttributeUsageDataModificationErrorDetail, ) from .models.gsa_security_groups import GsaSecurityGroups -from .models.gsa_selection import GsaSelection +from .models.gsa_selection_search import GsaSelectionSearch from .models.gsa_series_graph import GsaSeriesGraph from .models.gsa_set_date_time_datum import GsaSetDateTimeDatum from .models.gsa_set_datum import GsaSetDatum @@ -1649,9 +987,6 @@ from .models.gsa_set_short_text_datum import GsaSetShortTextDatum from .models.gsa_set_tabular_datum import GsaSetTabularDatum from .models.gsa_set_tabular_datum_row import GsaSetTabularDatumRow -from .models.gsa_set_unit_equivalent import GsaSetUnitEquivalent -from .models.gsa_set_unit_equivalents_exception import GsaSetUnitEquivalentsException -from .models.gsa_set_unit_equivalents_info import GsaSetUnitEquivalentsInfo from .models.gsa_short_name_property import GsaShortNameProperty from .models.gsa_short_text_aggregation import GsaShortTextAggregation from .models.gsa_short_text_aggregation_datum_criterion import GsaShortTextAggregationDatumCriterion @@ -1661,16 +996,11 @@ from .models.gsa_short_text_datum_exists_criterion import GsaShortTextDatumExistsCriterion from .models.gsa_short_text_prefix_datum_criterion import GsaShortTextPrefixDatumCriterion from .models.gsa_significant_figures_info import GsaSignificantFiguresInfo -from .models.gsa_similarity_setting import GsaSimilaritySetting -from .models.gsa_similarity_settings import GsaSimilaritySettings -from .models.gsa_similarity_sort_criterion import GsaSimilaritySortCriterion from .models.gsa_simple_attribute_to_export import GsaSimpleAttributeToExport -from .models.gsa_slim_access_control_info import GsaSlimAccessControlInfo from .models.gsa_slim_attribute import GsaSlimAttribute -from .models.gsa_slim_attribute_with_help_path import GsaSlimAttributeWithHelpPath from .models.gsa_slim_configuration import GsaSlimConfiguration +from .models.gsa_slim_constant import GsaSlimConstant from .models.gsa_slim_database import GsaSlimDatabase -from .models.gsa_slim_database_access_control_info import GsaSlimDatabaseAccessControlInfo from .models.gsa_slim_discrete_type import GsaSlimDiscreteType from .models.gsa_slim_entity import GsaSlimEntity from .models.gsa_slim_expression import GsaSlimExpression @@ -1678,104 +1008,45 @@ from .models.gsa_slim_identified_entity import GsaSlimIdentifiedEntity from .models.gsa_slim_layout import GsaSlimLayout from .models.gsa_slim_layout_section import GsaSlimLayoutSection -from .models.gsa_slim_localized_entity import GsaSlimLocalizedEntity from .models.gsa_slim_named_entity import GsaSlimNamedEntity +from .models.gsa_slim_named_unit import GsaSlimNamedUnit from .models.gsa_slim_objects import GsaSlimObjects from .models.gsa_slim_parameter import GsaSlimParameter -from .models.gsa_slim_parameter_with_help_path import GsaSlimParameterWithHelpPath +from .models.gsa_slim_permission import GsaSlimPermission +from .models.gsa_slim_permission_category import GsaSlimPermissionCategory from .models.gsa_slim_profile import GsaSlimProfile from .models.gsa_slim_profile_table import GsaSlimProfileTable from .models.gsa_slim_record_history import GsaSlimRecordHistory from .models.gsa_slim_record_link_group import GsaSlimRecordLinkGroup from .models.gsa_slim_record_version import GsaSlimRecordVersion from .models.gsa_slim_replacement_string import GsaSlimReplacementString -from .models.gsa_slim_search_mask import GsaSlimSearchMask -from .models.gsa_slim_search_template import GsaSlimSearchTemplate from .models.gsa_slim_subset import GsaSlimSubset from .models.gsa_slim_table import GsaSlimTable from .models.gsa_slim_typed_attribute import GsaSlimTypedAttribute from .models.gsa_slim_unit import GsaSlimUnit -from .models.gsa_smart_attributes_error_detail import GsaSmartAttributesErrorDetail -from .models.gsa_smart_attributes_error_reason import GsaSmartAttributesErrorReason -from .models.gsa_smart_attributes_record_link_group_error_detail import ( - GsaSmartAttributesRecordLinkGroupErrorDetail, -) -from .models.gsa_smart_link import GsaSmartLink -from .models.gsa_smart_link_create_put_layout_item import GsaSmartLinkCreatePutLayoutItem -from .models.gsa_smart_link_group_usage_data_modification_error_detail import ( - GsaSmartLinkGroupUsageDataModificationErrorDetail, -) -from .models.gsa_smart_record_link_group import GsaSmartRecordLinkGroup -from .models.gsa_smart_record_link_result import GsaSmartRecordLinkResult +from .models.gsa_slim_unit_system import GsaSlimUnitSystem +from .models.gsa_smtp_properties import GsaSmtpProperties from .models.gsa_sort_criterion import GsaSortCriterion from .models.gsa_sort_criterion_type import GsaSortCriterionType from .models.gsa_sort_direction import GsaSortDirection from .models.gsa_sort_type import GsaSortType from .models.gsa_sorting_value import GsaSortingValue from .models.gsa_sorting_value_type import GsaSortingValueType -from .models.gsa_source_cannot_be_target_smart_attributes_error_detail import ( - GsaSourceCannotBeTargetSmartAttributesErrorDetail, -) from .models.gsa_source_of_object_identifier import GsaSourceOfObjectIdentifier from .models.gsa_specific_values_specifier import GsaSpecificValuesSpecifier -from .models.gsa_sql_credentials import GsaSqlCredentials from .models.gsa_standard_name import GsaStandardName -from .models.gsa_standard_name_already_exists_error_detail import ( - GsaStandardNameAlreadyExistsErrorDetail, -) -from .models.gsa_standard_name_creation_exception import GsaStandardNameCreationException -from .models.gsa_standard_name_deletion_error_detail import GsaStandardNameDeletionErrorDetail -from .models.gsa_standard_name_deletion_error_reason import GsaStandardNameDeletionErrorReason -from .models.gsa_standard_name_deletion_exception import GsaStandardNameDeletionException -from .models.gsa_standard_name_error_detail import GsaStandardNameErrorDetail -from .models.gsa_standard_name_error_reason import GsaStandardNameErrorReason -from .models.gsa_standard_name_update_exception import GsaStandardNameUpdateException from .models.gsa_standard_names_info import GsaStandardNamesInfo -from .models.gsa_static_record_link import GsaStaticRecordLink from .models.gsa_static_record_link_group import GsaStaticRecordLinkGroup -from .models.gsa_static_record_link_group_mapping import GsaStaticRecordLinkGroupMapping -from .models.gsa_static_record_link_result import GsaStaticRecordLinkResult from .models.gsa_string_sorting_value import GsaStringSortingValue from .models.gsa_subset import GsaSubset from .models.gsa_subsets_info import GsaSubsetsInfo -from .models.gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail import ( - GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail, -) -from .models.gsa_symbol_cannot_contain_comma_unit_error_detail import ( - GsaSymbolCannotContainCommaUnitErrorDetail, -) -from .models.gsa_t_item import GsaTItem from .models.gsa_table import GsaTable -from .models.gsa_table_access_control_entity import GsaTableAccessControlEntity -from .models.gsa_table_creation_exception import GsaTableCreationException from .models.gsa_table_deletion_exception import GsaTableDeletionException -from .models.gsa_table_descendants_access_control_entity import ( - GsaTableDescendantsAccessControlEntity, -) -from .models.gsa_table_error_detail import GsaTableErrorDetail -from .models.gsa_table_error_reason import GsaTableErrorReason from .models.gsa_table_guid_property import GsaTableGuidProperty from .models.gsa_table_identity_property import GsaTableIdentityProperty from .models.gsa_table_name_property import GsaTableNameProperty -from .models.gsa_table_search_behaviour import GsaTableSearchBehaviour -from .models.gsa_table_type_contains_comma_error_detail import GsaTableTypeContainsCommaErrorDetail -from .models.gsa_table_type_error_detail import GsaTableTypeErrorDetail -from .models.gsa_table_type_error_reason import GsaTableTypeErrorReason -from .models.gsa_table_types_error_detail import GsaTableTypesErrorDetail -from .models.gsa_table_types_info import GsaTableTypesInfo -from .models.gsa_table_update_exception import GsaTableUpdateException -from .models.gsa_table_usage_data_modification_error_detail import ( - GsaTableUsageDataModificationErrorDetail, -) -from .models.gsa_table_version_state_access_control_category_error_detail import ( - GsaTableVersionStateAccessControlCategoryErrorDetail, -) from .models.gsa_tables_info import GsaTablesInfo -from .models.gsa_tables_missing_reorder_tables_error_detail import ( - GsaTablesMissingReorderTablesErrorDetail, -) from .models.gsa_tabular_attribute import GsaTabularAttribute -from .models.gsa_tabular_attribute_link import GsaTabularAttributeLink from .models.gsa_tabular_attribute_target import GsaTabularAttributeTarget from .models.gsa_tabular_attribute_usage_data_modification_error_detail import ( GsaTabularAttributeUsageDataModificationErrorDetail, @@ -1788,9 +1059,6 @@ ) from .models.gsa_tabular_column_no_such_entity_type import GsaTabularColumnNoSuchEntityType from .models.gsa_tabular_column_roll_up_type import GsaTabularColumnRollUpType -from .models.gsa_tabular_column_usage_data_modification_error_detail import ( - GsaTabularColumnUsageDataModificationErrorDetail, -) from .models.gsa_tabular_datum import GsaTabularDatum from .models.gsa_tabular_datum_cell import GsaTabularDatumCell from .models.gsa_tabular_datum_exists_criterion import GsaTabularDatumExistsCriterion @@ -1799,101 +1067,34 @@ from .models.gsa_tabular_datum_summary_row import GsaTabularDatumSummaryRow from .models.gsa_tabular_linking_value_criterion import GsaTabularLinkingValueCriterion from .models.gsa_tabular_row_export_behavior import GsaTabularRowExportBehavior -from .models.gsa_target_attribute import GsaTargetAttribute from .models.gsa_target_attribute_not_in_table_attribute_error_detail import ( GsaTargetAttributeNotInTableAttributeErrorDetail, ) -from .models.gsa_target_attribute_type import GsaTargetAttributeType from .models.gsa_target_attribute_type_attribute_error_detail import ( GsaTargetAttributeTypeAttributeErrorDetail, ) -from .models.gsa_target_not_fully_specified_attribute_error_detail import ( - GsaTargetNotFullySpecifiedAttributeErrorDetail, -) from .models.gsa_term_with_count import GsaTermWithCount from .models.gsa_text_match_behavior import GsaTextMatchBehavior from .models.gsa_threshold_type_attribute_error_detail import GsaThresholdTypeAttributeErrorDetail -from .models.gsa_threshold_value_name_empty_error_detail import ( - GsaThresholdValueNameEmptyErrorDetail, -) -from .models.gsa_threshold_value_name_invalid_error_detail import ( - GsaThresholdValueNameInvalidErrorDetail, -) -from .models.gsa_too_long_code_currency_error_detail import GsaTooLongCodeCurrencyErrorDetail -from .models.gsa_too_many_attribute_pairs_smart_attributes_error_detail import ( - GsaTooManyAttributePairsSmartAttributesErrorDetail, -) -from .models.gsa_too_many_permissions_permission_category_error_detail import ( - GsaTooManyPermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_too_many_permissions_replace_permission_category_error_detail import ( - GsaTooManyPermissionsReplacePermissionCategoryErrorDetail, -) -from .models.gsa_translate_between_guids_and_identities_response import ( - GsaTranslateBetweenGuidsAndIdentitiesResponse, -) from .models.gsa_translate_guids_to_identities_request import GsaTranslateGuidsToIdentitiesRequest -from .models.gsa_translate_identities_to_guids_request import GsaTranslateIdentitiesToGuidsRequest +from .models.gsa_translate_guids_to_identities_response import GsaTranslateGuidsToIdentitiesResponse from .models.gsa_unable_to_connect_add_database_validation_issue import ( GsaUnableToConnectAddDatabaseValidationIssue, ) from .models.gsa_unavailable_tabular_column import GsaUnavailableTabularColumn from .models.gsa_unit import GsaUnit -from .models.gsa_unit_as_exponent_unit_equation_error_detail import ( - GsaUnitAsExponentUnitEquationErrorDetail, -) from .models.gsa_unit_conversion_set import GsaUnitConversionSet from .models.gsa_unit_conversion_set_request import GsaUnitConversionSetRequest from .models.gsa_unit_conversions_info import GsaUnitConversionsInfo -from .models.gsa_unit_creation_exception import GsaUnitCreationException -from .models.gsa_unit_deletion_exception import GsaUnitDeletionException -from .models.gsa_unit_equation_error_detail import GsaUnitEquationErrorDetail -from .models.gsa_unit_equation_error_reason import GsaUnitEquationErrorReason from .models.gsa_unit_equivalent import GsaUnitEquivalent -from .models.gsa_unit_equivalent_error_detail import GsaUnitEquivalentErrorDetail -from .models.gsa_unit_equivalent_error_reason import GsaUnitEquivalentErrorReason from .models.gsa_unit_equivalents_info import GsaUnitEquivalentsInfo -from .models.gsa_unit_error_detail import GsaUnitErrorDetail -from .models.gsa_unit_error_reason import GsaUnitErrorReason from .models.gsa_unit_mapping import GsaUnitMapping from .models.gsa_unit_system import GsaUnitSystem from .models.gsa_unit_systems_info import GsaUnitSystemsInfo -from .models.gsa_unit_update_exception import GsaUnitUpdateException from .models.gsa_unit_usage import GsaUnitUsage -from .models.gsa_unit_usage_data_modification_error_detail import ( - GsaUnitUsageDataModificationErrorDetail, -) -from .models.gsa_unit_usage_type import GsaUnitUsageType -from .models.gsa_units_grouping_info import GsaUnitsGroupingInfo from .models.gsa_units_info import GsaUnitsInfo -from .models.gsa_unknown_unit_symbol_unit_equation_error_detail import ( - GsaUnknownUnitSymbolUnitEquationErrorDetail, -) -from .models.gsa_unresolved_attribute_guids_error_detail import ( - GsaUnresolvedAttributeGuidsErrorDetail, -) -from .models.gsa_unresolved_breadcrumb import GsaUnresolvedBreadcrumb -from .models.gsa_unresolved_cross_database_record_link_group_guids_error_detail import ( - GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_unresolved_parameter_guids_error_detail import ( - GsaUnresolvedParameterGuidsErrorDetail, -) -from .models.gsa_unresolved_record_link_group_guids_error_detail import ( - GsaUnresolvedRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_unresolved_reverse_record_link_groups_error_detail import ( - GsaUnresolvedReverseRecordLinkGroupsErrorDetail, -) -from .models.gsa_unresolved_target_attribute import GsaUnresolvedTargetAttribute -from .models.gsa_update_access_control import GsaUpdateAccessControl -from .models.gsa_update_access_control_category import GsaUpdateAccessControlCategory -from .models.gsa_update_access_control_category_table_mapping import ( - GsaUpdateAccessControlCategoryTableMapping, -) from .models.gsa_update_all_profiles_info import GsaUpdateAllProfilesInfo from .models.gsa_update_attribute import GsaUpdateAttribute -from .models.gsa_update_attribute_based_access_control import GsaUpdateAttributeBasedAccessControl from .models.gsa_update_axis_name import GsaUpdateAxisName from .models.gsa_update_configuration import GsaUpdateConfiguration from .models.gsa_update_constant import GsaUpdateConstant @@ -1901,15 +1102,9 @@ from .models.gsa_update_cross_database_record_link_group import ( GsaUpdateCrossDatabaseRecordLinkGroup, ) -from .models.gsa_update_current_rule_engine import GsaUpdateCurrentRuleEngine from .models.gsa_update_data_rule import GsaUpdateDataRule from .models.gsa_update_database import GsaUpdateDatabase -from .models.gsa_update_database_security_groups import GsaUpdateDatabaseSecurityGroups from .models.gsa_update_date_time_attribute import GsaUpdateDateTimeAttribute -from .models.gsa_update_default_database import GsaUpdateDefaultDatabase -from .models.gsa_update_default_fallback_security_groups import ( - GsaUpdateDefaultFallbackSecurityGroups, -) from .models.gsa_update_default_profile import GsaUpdateDefaultProfile from .models.gsa_update_discrete_attribute import GsaUpdateDiscreteAttribute from .models.gsa_update_discrete_functional_attribute import GsaUpdateDiscreteFunctionalAttribute @@ -1927,8 +1122,7 @@ from .models.gsa_update_discrete_parameter_value import GsaUpdateDiscreteParameterValue from .models.gsa_update_discrete_range import GsaUpdateDiscreteRange from .models.gsa_update_discrete_type import GsaUpdateDiscreteType -from .models.gsa_update_display_names import GsaUpdateDisplayNames -from .models.gsa_update_display_names_response import GsaUpdateDisplayNamesResponse +from .models.gsa_update_dynamic_record_link_group import GsaUpdateDynamicRecordLinkGroup from .models.gsa_update_expression import GsaUpdateExpression from .models.gsa_update_file import GsaUpdateFile from .models.gsa_update_file_attribute import GsaUpdateFileAttribute @@ -1947,7 +1141,6 @@ from .models.gsa_update_integer_attribute import GsaUpdateIntegerAttribute from .models.gsa_update_job_request import GsaUpdateJobRequest from .models.gsa_update_layout import GsaUpdateLayout -from .models.gsa_update_layout_section import GsaUpdateLayoutSection from .models.gsa_update_linked_attribute_tabular_column import GsaUpdateLinkedAttributeTabularColumn from .models.gsa_update_linked_column_tabular_column import GsaUpdateLinkedColumnTabularColumn from .models.gsa_update_linked_record_tabular_column import GsaUpdateLinkedRecordTabularColumn @@ -1972,94 +1165,52 @@ from .models.gsa_update_parameter import GsaUpdateParameter from .models.gsa_update_parameter_content import GsaUpdateParameterContent from .models.gsa_update_parameter_value import GsaUpdateParameterValue -from .models.gsa_update_permission import GsaUpdatePermission -from .models.gsa_update_permission_access_control import GsaUpdatePermissionAccessControl -from .models.gsa_update_permission_based_access_control import GsaUpdatePermissionBasedAccessControl -from .models.gsa_update_permission_category import GsaUpdatePermissionCategory -from .models.gsa_update_permission_category_access_control import ( - GsaUpdatePermissionCategoryAccessControl, -) -from .models.gsa_update_permission_category_access_control_request import ( - GsaUpdatePermissionCategoryAccessControlRequest, -) -from .models.gsa_update_permission_category_access_controls_operation_request import ( - GsaUpdatePermissionCategoryAccessControlsOperationRequest, -) from .models.gsa_update_picture_attribute import GsaUpdatePictureAttribute from .models.gsa_update_point_attribute import GsaUpdatePointAttribute from .models.gsa_update_profile import GsaUpdateProfile from .models.gsa_update_profile_table import GsaUpdateProfileTable -from .models.gsa_update_put_discrete_value import GsaUpdatePutDiscreteValue -from .models.gsa_update_put_layout_item import GsaUpdatePutLayoutItem -from .models.gsa_update_put_permission import GsaUpdatePutPermission -from .models.gsa_update_put_permission_category import GsaUpdatePutPermissionCategory from .models.gsa_update_range_attribute import GsaUpdateRangeAttribute from .models.gsa_update_record_link_group import GsaUpdateRecordLinkGroup from .models.gsa_update_record_list_permission_flags import GsaUpdateRecordListPermissionFlags from .models.gsa_update_record_list_properties import GsaUpdateRecordListProperties from .models.gsa_update_replacement_string import GsaUpdateReplacementString -from .models.gsa_update_root_folder_error_detail import GsaUpdateRootFolderErrorDetail -from .models.gsa_update_run_status import GsaUpdateRunStatus from .models.gsa_update_short_text_attribute import GsaUpdateShortTextAttribute -from .models.gsa_update_smart_record_link_group import GsaUpdateSmartRecordLinkGroup from .models.gsa_update_standard_name import GsaUpdateStandardName from .models.gsa_update_static_record_link_group import GsaUpdateStaticRecordLinkGroup -from .models.gsa_update_static_record_link_group_mapping import ( - GsaUpdateStaticRecordLinkGroupMapping, -) from .models.gsa_update_subset import GsaUpdateSubset from .models.gsa_update_table import GsaUpdateTable from .models.gsa_update_tabular_attribute import GsaUpdateTabularAttribute from .models.gsa_update_tabular_attribute_target import GsaUpdateTabularAttributeTarget from .models.gsa_update_tabular_column import GsaUpdateTabularColumn -from .models.gsa_update_tabular_column_property_not_provided_attribute_error_detail import ( - GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail, -) -from .models.gsa_update_tabular_column_type_attribute_error_detail import ( - GsaUpdateTabularColumnTypeAttributeErrorDetail, -) from .models.gsa_update_unavailable_tabular_column import GsaUpdateUnavailableTabularColumn from .models.gsa_update_unit import GsaUpdateUnit from .models.gsa_update_unit_system import GsaUpdateUnitSystem from .models.gsa_update_user_permission import GsaUpdateUserPermission from .models.gsa_update_user_permissions_info import GsaUpdateUserPermissionsInfo -from .models.gsa_upgrade_database_exception import GsaUpgradeDatabaseException -from .models.gsa_upgrade_database_failure_reason import GsaUpgradeDatabaseFailureReason from .models.gsa_usage_data_modification_error_detail import GsaUsageDataModificationErrorDetail -from .models.gsa_user_capabilities import GsaUserCapabilities +from .models.gsa_user_or_group import GsaUserOrGroup from .models.gsa_user_permission import GsaUserPermission from .models.gsa_user_permissions_info import GsaUserPermissionsInfo from .models.gsa_user_role import GsaUserRole from .models.gsa_validate_attribute_request import GsaValidateAttributeRequest -from .models.gsa_validate_unit_equation_request import GsaValidateUnitEquationRequest -from .models.gsa_validate_unit_equation_response import GsaValidateUnitEquationResponse -from .models.gsa_value_not_provided_parameter_value_error_detail import ( - GsaValueNotProvidedParameterValueErrorDetail, -) from .models.gsa_value_specifier import GsaValueSpecifier from .models.gsa_value_specifier_type import GsaValueSpecifierType from .models.gsa_value_with_count_of_boolean import GsaValueWithCountOfBoolean from .models.gsa_value_with_count_of_guid import GsaValueWithCountOfGuid from .models.gsa_value_with_count_of_int32 import GsaValueWithCountOfInt32 from .models.gsa_version_control_error_detail import GsaVersionControlErrorDetail -from .models.gsa_version_control_error_reason import GsaVersionControlErrorReason -from .models.gsa_version_control_mode import GsaVersionControlMode from .models.gsa_version_controlled_data_usage_data_modification_error_detail import ( GsaVersionControlledDataUsageDataModificationErrorDetail, ) from .models.gsa_version_number_property import GsaVersionNumberProperty from .models.gsa_version_state import GsaVersionState from .models.gsa_version_state_property import GsaVersionStateProperty -from .models.gsa_weighting_type import GsaWeightingType from .models.gsa_withdraw_record_version_control_exception import ( GsaWithdrawRecordVersionControlException, ) -from .models.gsa_xy_chart_template import GsaXYChartTemplate from .models.gsa_xy_chart_template_usage_data_modification_error_detail import ( GsaXYChartTemplateUsageDataModificationErrorDetail, ) -from .models.gsa_xy_chart_templates_info import GsaXYChartTemplatesInfo -from .models.gsa_xy_template_axis import GsaXYTemplateAxis from .models.jobqueue_files_body import JobqueueFilesBody from .models.json_patch_document import JsonPatchDocument from .models.microsoft_asp_net_core_mvc_formatters_i_output_formatter import ( @@ -2069,21 +1220,11 @@ from .models.system_net_http_status_code import SystemNetHttpStatusCode __all__ = [ - "AccessControlApi", - "AccessControlAttributeBasedCategoriesApi", - "AccessControlPermissionBasedApi", - "AccessControlPermissionBasedSchemaApi", - "ActivityLogApi", "AggregationApi", - "BlobInfosApi", - "BlobsApi", "BulkApi", - "CurrenciesApi", "DataApi", "DataExportApi", - "DataUpdaterApi", "DatabaseApi", - "FindSimilarApi", "GraphApi", "HelpLocationApi", "IdentitiesApi", @@ -2095,7 +1236,7 @@ "ListManagementApi", "ListPermissionsApi", "MetricsApi", - "RecordLinksApi", + "PermissionBasedAccessControlApi", "RecordsRecordHistoriesApi", "RecordsRecordVersionsApi", "SchemaApi", @@ -2106,7 +1247,6 @@ "SchemaDatabasesApi", "SchemaDiscreteTypesDiscreteValuesApi", "SchemaDiscreteTypesApi", - "SchemaDisplayNamesApi", "SchemaExportersApi", "SchemaExpressionsApi", "SchemaGlobalStandardNamesApi", @@ -2117,19 +1257,15 @@ "SchemaParametersApi", "SchemaProfileTablesApi", "SchemaProfilesApi", - "SchemaQualitySystemsApi", "SchemaRecordLinkGroupsApi", "SchemaReplacementStringsApi", - "SchemaSearchMasksApi", - "SchemaSearchTemplatesApi", - "SchemaSecurityGroupsApi", "SchemaStandardNamesApi", "SchemaSubsetsApi", "SchemaTablesApi", - "SchemaUnitEquivalentsApi", "SchemaUnitsApi", - "SchemaXYChartTemplatesApi", "SearchApi", + "SelectionSearchesApi", + "ServerManagerApi", "StatusApi", "AttributesAttributeguidimportfileBody", "AttributesAttributeguidimportfileBody1", @@ -2143,46 +1279,12 @@ "FolderguidFilesBody1", "FolderguidFilesBody2", "GrantaMIRecordPropertyFakeAttributeIdentities", - "GrantaMISearchFreeTextIdentifiers", "GsaAboutAttributeCannotBeMetaAttributeErrorDetail", - "GsaAccessControlCategoriesInfo", - "GsaAccessControlCategory", - "GsaAccessControlCategoryCreationException", - "GsaAccessControlCategoryErrorDetail", - "GsaAccessControlCategoryErrorReason", - "GsaAccessControlCategoryInclude", - "GsaAccessControlCategoryNoSuchEntityType", - "GsaAccessControlCategoryTableMapping", - "GsaAccessControlCategoryUpdateException", - "GsaAccessControlDatabaseUserCapabilities", - "GsaAccessControlEntitiesAggregationErrorDetail", - "GsaAccessControlEntitiesErrorDetail", - "GsaAccessControlEntitiesUpdateOperationsErrorDetail", - "GsaAccessControlEntity", - "GsaAccessControlEntityType", - "GsaAccessControlInfo", - "GsaAccessControlMode", - "GsaAccessControlUserCapabilities", - "GsaActivityLogApplicationNameFilter", - "GsaActivityLogApplicationNamesCollectionFilter", - "GsaActivityLogCollectionMatchType", - "GsaActivityLogDatabaseKeyFilter", - "GsaActivityLogDateFilter", - "GsaActivityLogEntriesFilter", - "GsaActivityLogEntriesInfo", - "GsaActivityLogEntry", - "GsaActivityLogMatchType", - "GsaActivityLogUsageMode", - "GsaActivityLogUsageModeFilter", - "GsaActivityLogUsernameFilter", "GsaAddDatabase", "GsaAddDatabaseIssueType", - "GsaAddDatabaseSecurityGroups", "GsaAddDatabaseValidationIssue", "GsaAddDatabaseValidationResult", "GsaAddRecordHistoryToSubset", - "GsaAdditionalSqlParameters", - "GsaAggregatePermissionAccessControlsRequest", "GsaAggregation", "GsaAggregationCriterion", "GsaAggregationDatum", @@ -2203,23 +1305,16 @@ "GsaAppendPointValues", "GsaApplicableDatum", "GsaApplicationsInfo", - "GsaApplyOptions", - "GsaAssociationChainCreatePutLayoutItem", "GsaAttribute", - "GsaAttributeAccessControlEntity", "GsaAttributeAggregation", "GsaAttributeAggregationCriterion", "GsaAttributeAggregationExistsCriterion", "GsaAttributeAggregationType", "GsaAttributeAggregationValueCriterion", - "GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "GsaAttributeBasedAccessControlInfo", - "GsaAttributeCreatePutLayoutItem", "GsaAttributeCreationException", "GsaAttributeCriterion", "GsaAttributeCriterionType", "GsaAttributeDeletionException", - "GsaAttributeDiscreteTypeMismatchErrorDetail", "GsaAttributeErrorDetail", "GsaAttributeErrorReason", "GsaAttributeExistsAggregation", @@ -2231,76 +1326,42 @@ "GsaAttributeMatchesCriterion", "GsaAttributeNoSuchEntityType", "GsaAttributeNotApplicableCriterion", - "GsaAttributeNotOnTableErrorDetail", - "GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "GsaAttributePairTypeMismatchSmartAttributesErrorDetail", "GsaAttributeReference", "GsaAttributeScaleType", "GsaAttributeSortCriterion", "GsaAttributeThresholdType", "GsaAttributeToExport", "GsaAttributeType", - "GsaAttributeTypeAttributeErrorDetail", - "GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", - "GsaAttributeUpdateException", "GsaAttributeUsageDataModificationErrorDetail", "GsaAttributeValidateResponse", "GsaAttributeValueAggregation", "GsaAttributesInfo", "GsaAxisName", - "GsaBlobInfoDto", "GsaBooleanCriterion", "GsaBoostByGuid", "GsaBoostByIdentity", - "GsaBracketMismatchUnitEquationErrorDetail", - "GsaBreadcrumb", - "GsaBreadcrumbType", - "GsaBreadcrumbsProperty", "GsaBulkInfo", "GsaBulkRequest", "GsaBulkRequestHttpMethod", "GsaBulkRequestItem", "GsaBulkResponseItem", "GsaCalendarInterval", - "GsaCannotChangeDiscreteTypeAttributeErrorDetail", - "GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail", - "GsaCannotDeleteTabularColumnAttributeErrorDetail", - "GsaCannotRemoveParameterInUseAttributeErrorDetail", - "GsaCategoryReplacePermissionCategoryErrorDetail", - "GsaChartData", - "GsaChartDataType", - "GsaCircularReferenceFolderMoveErrorDetail", - "GsaCodeMissingCurrencyErrorDetail", - "GsaCodeWhitespaceCurrencyErrorDetail", - "GsaConfigInvalidJsonFileErrorDetail", "GsaConfiguration", - "GsaConfigurationDetails", "GsaConfigurationsInfo", "GsaConnectionDetails", "GsaConstant", - "GsaConstantCreationException", "GsaConstantDeletionException", - "GsaConstantErrorDetail", - "GsaConstantErrorReason", - "GsaConstantUpdateException", - "GsaConstantUsageDataModificationErrorDetail", "GsaConstantsInfo", - "GsaContinuousQualitySystem", "GsaContinuousRange", "GsaCopyRecordHistory", - "GsaCreateAccessControlCategory", - "GsaCreateAccessControlCategoryTableMapping", "GsaCreateAttribute", "GsaCreateAttributeLinkPair", "GsaCreateAxisName", "GsaCreateConfiguration", "GsaCreateConstant", - "GsaCreateContinuousQualitySystem", "GsaCreateContinuousRange", - "GsaCreateCrossDatabaseLinkTarget", "GsaCreateCrossDatabaseRecordLinkGroup", "GsaCreateDataRule", - "GsaCreateDataUpdateServerApiRequest", "GsaCreateDateTimeAttribute", "GsaCreateDiscreteAttribute", "GsaCreateDiscreteFunctionalAttribute", @@ -2310,9 +1371,9 @@ "GsaCreateDiscreteParameter", "GsaCreateDiscreteParameterContent", "GsaCreateDiscreteParameterValue", - "GsaCreateDiscreteQualitySystem", "GsaCreateDiscreteRange", "GsaCreateDiscreteType", + "GsaCreateDynamicRecordLinkGroup", "GsaCreateExpression", "GsaCreateFileAttribute", "GsaCreateFloatFunctionalAttribute", @@ -2350,51 +1411,31 @@ "GsaCreateParameter", "GsaCreateParameterContent", "GsaCreateParameterValue", - "GsaCreatePermission", - "GsaCreatePermissionCategory", "GsaCreatePictureAttribute", "GsaCreatePointAttribute", "GsaCreateProfile", "GsaCreateProfileTable", - "GsaCreatePutDiscreteValue", - "GsaCreatePutLayoutItem", - "GsaCreatePutPermission", - "GsaCreatePutPermissionCategory", - "GsaCreateQualityDiscreteValue", - "GsaCreateQualitySystem", "GsaCreateRangeAttribute", "GsaCreateRecordHistory", "GsaCreateRecordLinkGroup", "GsaCreateRecordList", "GsaCreateRecordListItemsInfo", "GsaCreateReplacementString", + "GsaCreateSearchRequest", "GsaCreateShortTextAttribute", - "GsaCreateSmartLinkTarget", - "GsaCreateSmartRecordLinkGroup", "GsaCreateStandardName", - "GsaCreateStaticLinkTarget", "GsaCreateStaticRecordLinkGroup", - "GsaCreateStaticRecordLinkGroupMapping", "GsaCreateSubset", "GsaCreateTable", "GsaCreateTabularAttribute", "GsaCreateTabularColumn", "GsaCreateUnit", - "GsaCreateUnitMapping", "GsaCreateUnitSystem", "GsaCreatedByUserProperty", "GsaCreatedDateProperty", "GsaCriterion", "GsaCriterionType", - "GsaCrossDatabaseLink", - "GsaCrossDatabaseLinkCreatePutLayoutItem", - "GsaCrossDatabaseRecordLink", "GsaCrossDatabaseRecordLinkGroup", - "GsaCrossDatabaseRecordLinkResult", - "GsaCurrenciesInfo", - "GsaCurrency", - "GsaCurrencyErrorDetail", - "GsaCurrencyErrorReason", "GsaCurrentUser", "GsaDataExportApplicableDatum", "GsaDataExportBinaryData", @@ -2444,27 +1485,11 @@ "GsaDataModificationErrorReason", "GsaDataRule", "GsaDataRulesInfo", - "GsaDataSource", - "GsaDataUpdate", - "GsaDataUpdateDeletionException", - "GsaDataUpdateHeader", - "GsaDataUpdateRunInfo", - "GsaDataUpdateToken", - "GsaDataUpdaterJob", - "GsaDataUpdaterJobStatus", - "GsaDataUpdaterJobType", - "GsaDataUpdaterProject", "GsaDataUsageDataModificationErrorDetail", "GsaDatabase", - "GsaDatabaseAccessControlEntity", - "GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "GsaDatabaseIssues", "GsaDatabaseKeyProperty", - "GsaDatabaseSecurityGroups", - "GsaDatabaseSecurityGroupsInfo", "GsaDatabaseStatus", "GsaDatabaseStatusInformation", - "GsaDatabaseUserCapabilities", "GsaDatabasesInfo", "GsaDateTimeAggregation", "GsaDateTimeAggregationDatumCriterion", @@ -2492,22 +1517,11 @@ "GsaDatumRollupType", "GsaDatumType", "GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail", - "GsaDefaultFallbackSecurityGroups", "GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail", - "GsaDefaultLayoutGuidErrorDetail", - "GsaDefaultParameterValueGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexParameterErrorDetail", - "GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", "GsaDefaultParameterValueUsageDataModificationErrorDetail", - "GsaDefaultSubsetGuidErrorDetail", "GsaDeleteRecordListItem", "GsaDeleteRecordListItems", - "GsaDeletionEntityType", - "GsaDeletionException", - "GsaDescriptionLengthFileErrorDetail", "GsaDiscreteAttribute", - "GsaDiscreteChartData", "GsaDiscreteDatum", "GsaDiscreteDatumExistsCriterion", "GsaDiscreteFunctionalAttribute", @@ -2534,7 +1548,6 @@ "GsaDiscreteParameterNameConstraint", "GsaDiscreteParameterValue", "GsaDiscreteParameterValueConstraint", - "GsaDiscreteQualitySystem", "GsaDiscreteRange", "GsaDiscreteRangeDatumCriterion", "GsaDiscreteSeries", @@ -2546,107 +1559,52 @@ "GsaDiscreteTextPrefixDatumCriterion", "GsaDiscreteTextValuesDatumCriterion", "GsaDiscreteType", - "GsaDiscreteTypeCreationException", "GsaDiscreteTypeDeletionException", - "GsaDiscreteTypeErrorDetail", - "GsaDiscreteTypeErrorReason", - "GsaDiscreteTypeUpdateException", "GsaDiscreteTypeUsage", - "GsaDiscreteTypeUsageType", "GsaDiscreteTypesInfo", "GsaDiscreteValue", - "GsaDiscreteValueCreationException", - "GsaDiscreteValueDeletionException", - "GsaDiscreteValueErrorDetail", - "GsaDiscreteValueErrorReason", - "GsaDiscreteValueNotInDiscreteTypeErrorDetail", - "GsaDiscreteValueUpdateException", - "GsaDiscreteValueUsedInDataErrorDetail", + "GsaDiscreteValueAggregateErrorReason", + "GsaDiscreteValueAggregateException", "GsaDiscreteValuesCreateDiscreteValue", "GsaDiscreteValuesDiscreteValue", "GsaDiscreteValuesDiscreteValuesInfo", - "GsaDiscreteValuesErrorDetail", "GsaDiscreteValuesReplaceDiscreteValuesInfo", "GsaDiscreteValuesUpdateDiscreteValue", "GsaDiskStatus", - "GsaDisplayNameEmptyErrorDetail", - "GsaDisplayNameLanguageNotProvidedErrorDetail", - "GsaDisplayNameLanguageNotSupportedErrorDetail", - "GsaDisplayNamesImportErrorDetail", - "GsaDisplayNamesImportErrorReason", - "GsaDisplayNamesImportException", - "GsaDisplayNamesInfo", - "GsaDivideByZeroUnitEquationErrorDetail", "GsaDoubleSortingValue", - "GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "GsaDuplicateCodeCurrencyErrorDetail", "GsaDuplicateDatabaseAddDatabaseValidationIssue", - "GsaDuplicateDiscreteValueErrorDetail", "GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail", "GsaDuplicateGuidAddDatabaseValidationIssue", "GsaDuplicateKeyAddDatabaseValidationIssue", - "GsaDuplicateMappedAttributeGuidsErrorDetail", - "GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateMappedParameterGuidsErrorDetail", - "GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateNameCurrencyErrorDetail", "GsaDuplicateParameterGuidsAttributeErrorDetail", - "GsaDuplicatePermissionGuidsAccessControlErrorDetail", - "GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "GsaDuplicateSymbolUnitErrorDetail", - "GsaDuplicateTableErrorDetail", - "GsaDuplicateTablesReorderTablesErrorDetail", "GsaDuplicateTabularColumnGuidsErrorDetail", "GsaDuplicateTabularColumnNamesErrorDetail", "GsaDuplicateVersionGuidAddDatabaseValidationIssue", + "GsaDynamicLinkGroupUsageDataModificationErrorDetail", + "GsaDynamicRecordLinkGroup", "GsaEmptyAxisNameAttributeErrorDetail", - "GsaEmptySymbolUnitErrorDetail", - "GsaEmptyTableTypeErrorDetail", "GsaEnabledLicensesInfo", "GsaEntityAlreadyExistsErrorDetail", "GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "GsaEntityType", - "GsaEquationUnitErrorDetail", - "GsaErrorCode", - "GsaErrorDetailOfRecordHistoryErrorReason", - "GsaErrorDetailOfUpgradeDatabaseFailureReason", - "GsaErrorResponse", - "GsaExceptionInformation", + "GsaErrorDetail", "GsaExcludeValuesSpecifier", "GsaExistingTabularColumnGuidErrorDetail", "GsaExportFailure", "GsaExportFailureType", "GsaExporterRefetchInfo", "GsaExpression", - "GsaExpressionAccessControlEntity", - "GsaExpressionDeletionException", "GsaExpressionMathsFunctionalErrorDetail", "GsaExpressionUsageDataModificationErrorDetail", "GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail", "GsaExpressionsInfo", - "GsaFileAlreadyExistsFileMoveErrorDetail", "GsaFileAttribute", - "GsaFileCreationException", "GsaFileDatum", "GsaFileDatumCriterion", "GsaFileDatumExistsCriterion", - "GsaFileErrorDetail", - "GsaFileErrorReason", "GsaFileHeader", - "GsaFileHeaderInfo", - "GsaFileMoveErrorDetail", - "GsaFileMoveErrorReason", - "GsaFileMoveException", - "GsaFileNameFileErrorDetail", - "GsaFileNameFolderErrorDetail", "GsaFilePrefixDatumCriterion", - "GsaFileUpdateException", "GsaFilesInfo", - "GsaFindSimilarRequest", - "GsaFindSimilarResponse", - "GsaFindSimilarResult", - "GsaFindSimilarSearchCriterion", + "GsaFindSearchRequest", "GsaFindStandardNames", "GsaFloatFunctionalAggregation", "GsaFloatFunctionalAggregationDatumCriterion", @@ -2668,20 +1626,7 @@ "GsaFloatSeriesGraph", "GsaFloatSeriesPoint", "GsaFolder", - "GsaFolderAlreadyExistsFolderMoveErrorDetail", - "GsaFolderCreationException", - "GsaFolderDeletionErrorDetail", - "GsaFolderDeletionErrorReason", - "GsaFolderDeletionException", - "GsaFolderErrorDetail", - "GsaFolderErrorReason", - "GsaFolderMoveErrorDetail", - "GsaFolderMoveErrorReason", - "GsaFolderMoveException", - "GsaFolderType", - "GsaFolderUpdateException", "GsaFoldersInfo", - "GsaForbidOrphansRecordLinkGroupErrorDetail", "GsaFreeTextAggregation", "GsaFreeTextAggregationCriterion", "GsaFreeTextCriterion", @@ -2689,18 +1634,14 @@ "GsaFullLayoutSection", "GsaFullNameProperty", "GsaFuncNoParamsAttributeErrorDetail", - "GsaFunctionalDataDefaultUsageDataModificationErrorDetail", "GsaFunctionalDatumParameterInfo", "GsaFunctionalParameterSetting", "GsaFunctionalType", - "GsaGeneralUnitEquationErrorDetail", "GsaGeneratedIntegrationSchemaOfObjectIdentifier", - "GsaGetFindSimilarResultsResponse", "GsaGetJobsResponse", "GsaGetJobsSummaryResponse", "GsaGetModifiableRecordVersionControlException", "GsaGetUnitConversionsRequest", - "GsaGetUnitEquivalentsException", "GsaGraph", "GsaGraphDecorationType", "GsaGraphEvaluationSettings", @@ -2709,7 +1650,6 @@ "GsaGraphType", "GsaGraphValue", "GsaGraphValueType", - "GsaGrid", "GsaGridGraph", "GsaGuidOnlyAttribute", "GsaGuidOnlyDiscreteType", @@ -2718,7 +1658,6 @@ "GsaGuidOnlyLayout", "GsaGuidOnlyMappingOfObjectIdentifier", "GsaGuidOnlySourceOfObjectIdentifier", - "GsaHelpPathsValidationResponse", "GsaHistogram", "GsaHistogramBucket", "GsaHyperlinkAttribute", @@ -2727,18 +1666,12 @@ "GsaHyperlinkDatumExistsCriterion", "GsaHyperlinkPrefixDatumCriterion", "GsaHyperlinkTarget", - "GsaInUseParameterValueErrorDetail", - "GsaInclusiveness", - "GsaIncompatibleUnitsErrorDetail", "GsaIndexRecordFailure", "GsaIndirectLinks", - "GsaInputConnectionDetails", "GsaInputValidationErrorDetail", - "GsaInputValidationErrorReason", "GsaIntegerAggregation", "GsaIntegerAggregationDatumCriterion", "GsaIntegerAttribute", - "GsaIntegerChartData", "GsaIntegerDatum", "GsaIntegerDatumCriterion", "GsaIntegerDatumExistsCriterion", @@ -2753,8 +1686,6 @@ "GsaIntegrationSchemaGenerationErrorDetail", "GsaIntegrationSchemaOfObjectIdentifier", "GsaIntegrationSchemaStatus", - "GsaInvalidEquivalenceTargetErrorDetail", - "GsaInvalidExchangeRateCurrencyErrorDetail", "GsaInvalidKeyAddDatabaseValidationIssue", "GsaInvalidParentStateErrorDetail", "GsaInvalidVersionStateErrorDetail", @@ -2774,7 +1705,6 @@ "GsaLayoutSectionsInfo", "GsaLayoutTabularColumn", "GsaLayoutsInfo", - "GsaLink", "GsaLinkAggregation", "GsaLinkAggregationDatumCriterion", "GsaLinkAttributeToExport", @@ -2827,27 +1757,19 @@ "GsaLocalRangeTabularColumn", "GsaLocalRowsBehavior", "GsaLocalShortTextTabularColumn", - "GsaLogScaleNegativeParameterValueErrorDetail", "GsaLogicalAggregation", "GsaLogicalAggregationDatumCriterion", "GsaLogicalAttribute", - "GsaLogicalChartData", "GsaLogicalDatum", "GsaLogicalDatumCriterion", "GsaLogicalDatumExistsCriterion", - "GsaLongRunningOperation", - "GsaLongRunningOperationInclude", - "GsaLongRunningOperationInvalidStatusException", - "GsaLongRunningStatus", "GsaLongSortingValue", "GsaLongTextAttribute", "GsaLongTextDatum", "GsaLongTextDatumCriterion", "GsaLongTextDatumExistsCriterion", "GsaLongTextPrefixDatumCriterion", - "GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", "GsaMappingOfObjectIdentifier", - "GsaMatchMode", "GsaMathsContent", "GsaMathsFunctionalAttribute", "GsaMathsFunctionalAttributeErrorDetail", @@ -2855,8 +1777,6 @@ "GsaMathsFunctionalDatumExistsCriterion", "GsaMathsFunctionalErrorDetail", "GsaMathsFunctionalErrorReason", - "GsaMaxPermissionsReachedPermissionErrorDetail", - "GsaMetaAttributeCannotHaveMetaAttributeErrorDetail", "GsaMfaExpressionErrorDetail", "GsaMfaExpressionErrorReason", "GsaMiVersion", @@ -2865,38 +1785,12 @@ "GsaMoveFile", "GsaMoveFolder", "GsaMoveRecordHistory", - "GsaMultiValuedAttributeErrorDetail", - "GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "GsaMultiValuedReason", - "GsaMultiValuedSmartAttributesErrorDetail", - "GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", "GsaNameAlreadyExistsErrorDetail", - "GsaNameAlreadySpecifiedErrorDetail", - "GsaNameMissingCurrencyErrorDetail", "GsaNameNotProvidedErrorDetail", - "GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "GsaNameWhitespaceCurrencyErrorDetail", - "GsaNameWhitespaceParameterValueErrorDetail", "GsaNamedCriterion", - "GsaNamedEntityAccessControlCategoryErrorDetail", "GsaNamedEntityAttributeErrorDetail", - "GsaNamedEntityConstantErrorDetail", - "GsaNamedEntityDiscreteTypeErrorDetail", - "GsaNamedEntityDiscreteValueErrorDetail", "GsaNamedEntityErrorDetail", "GsaNamedEntityErrorReason", - "GsaNamedEntityFileErrorDetail", - "GsaNamedEntityFolderErrorDetail", - "GsaNamedEntityParameterErrorDetail", - "GsaNamedEntityParameterValueErrorDetail", - "GsaNamedEntityPermissionCategoryErrorDetail", - "GsaNamedEntityPermissionErrorDetail", - "GsaNamedEntityQualityDiscreteValueErrorDetail", - "GsaNamedEntityQualitySystemErrorDetail", - "GsaNamedEntityRecordLinkGroupErrorDetail", - "GsaNamedEntityTableErrorDetail", - "GsaNamedEntityUnitErrorDetail", "GsaNewLayoutAssociationChainItem", "GsaNewLayoutAssociationChainLink", "GsaNewLayoutAttributeItem", @@ -2905,54 +1799,23 @@ "GsaNewLayoutItemType", "GsaNewLayoutRecordLinkItem", "GsaNewLayoutSmartLinkItem", - "GsaNoAttributePairsSmartAttributesErrorDetail", - "GsaNoDataFileErrorDetail", "GsaNoExpressionsMathsFunctionalErrorDetail", - "GsaNoFileFileErrorDetail", - "GsaNoParameterValuesParameterErrorDetail", - "GsaNoPermissionsPermissionCategoryErrorDetail", - "GsaNoQualityDiscreteValuesErrorDetail", - "GsaNoSuchAttributeSmartAttributesErrorDetail", - "GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "GsaNoSuchCategoryAccessControlErrorDetail", - "GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail", - "GsaNoSuchEntitiesAccessControlEntitiesErrorDetail", - "GsaNoSuchEntityAccessControlCategoryErrorDetail", "GsaNoSuchEntityAttributeErrorDetail", "GsaNoSuchEntityTabularColumnErrorDetail", "GsaNoSuchExpressionsMathsFunctionalErrorDetail", - "GsaNoSuchNewParentFileMoveErrorDetail", - "GsaNoSuchNewParentFolderMoveErrorDetail", "GsaNoSuchParameterValueParameterContentErrorDetail", - "GsaNoSuchPermissionAccessControlErrorDetail", - "GsaNoSuchPermissionsPermissionCategoryErrorDetail", - "GsaNoSuchSubsetAccessControlEntitiesErrorDetail", - "GsaNoSuchTableMappingErrorDetail", - "GsaNoSuchTablesReorderTablesErrorDetail", - "GsaNoSuchTabularColumnAttributeErrorDetail", - "GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "GsaNoSuchUnitConstantErrorDetail", - "GsaNoSuchUnitParameterErrorDetail", - "GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "GsaNoSuchUnitUnitEquivalentErrorDetail", "GsaNoValueExistsGraphValue", "GsaNoValuesSpecifier", - "GsaNonCustomStandardNameCannotBeChangedErrorDetail", "GsaNotApplicableDatum", "GsaNotTheLatestVersionErrorDetail", "GsaNotVersionedErrorDetail", - "GsaNumberParsingUnitEquationErrorDetail", "GsaNumericGraphParameterValue", "GsaNumericParameter", "GsaNumericParameterConstraint", "GsaNumericParameterContent", "GsaNumericParameterDataValue", "GsaNumericParameterValue", - "GsaNumericRestrictedInterpolationParameterErrorDetail", "GsaObjectIdentifier", - "GsaPaginatedItemType", - "GsaPaginatedResponseOf", - "GsaPaginationLinks", "GsaPagingOptions", "GsaParameter", "GsaParameterConstraint", @@ -2964,11 +1827,8 @@ "GsaParameterContentMathsFunctionalErrorDetail", "GsaParameterContentMissingArgument", "GsaParameterContentUnknownParametersMathsFunctionalErrorDetail", - "GsaParameterCreationException", "GsaParameterDataValue", "GsaParameterDeletionException", - "GsaParameterErrorDetail", - "GsaParameterErrorReason", "GsaParameterInfo", "GsaParameterInfoInterpolationType", "GsaParameterInfoParameterType", @@ -2978,56 +1838,14 @@ "GsaParameterSettingDefinedAt", "GsaParameterType", "GsaParameterTypeParameterContentErrorDetail", - "GsaParameterTypeParameterErrorDetail", - "GsaParameterUpdateException", - "GsaParameterUsageDataModificationErrorDetail", "GsaParameterValue", - "GsaParameterValueCreationException", "GsaParameterValueDeletionException", - "GsaParameterValueErrorDetail", - "GsaParameterValueErrorReason", - "GsaParameterValueParameterErrorDetail", "GsaParameterValueType", - "GsaParameterValueTypeParameterValueErrorDetail", - "GsaParameterValueUpdateException", - "GsaParameterValueUsedByType", "GsaParameterWithDataValue", "GsaParametersInfo", "GsaPermission", - "GsaPermissionAccessControl", - "GsaPermissionAccessControlAggregate", - "GsaPermissionBasedAccessControlAggregationErrorDetail", - "GsaPermissionBasedAccessControlAggregationErrorReason", - "GsaPermissionBasedAccessControlAggregationException", - "GsaPermissionBasedAccessControlEntitiesErrorReason", - "GsaPermissionBasedAccessControlInfo", - "GsaPermissionBasedAccessControlUpdateOperationException", - "GsaPermissionBasedAccessControlUpdateOperationsErrorDetail", - "GsaPermissionBasedAccessControlUpdateOperationsErrorReason", - "GsaPermissionCategoriesAccessControlErrorDetail", - "GsaPermissionCategoriesAccessControlErrorReason", - "GsaPermissionCategoriesAccessControlUpdateException", "GsaPermissionCategoriesInfo", - "GsaPermissionCategoriesUpdateOperationsErrorDetail", "GsaPermissionCategory", - "GsaPermissionCategoryAccessControl", - "GsaPermissionCategoryAccessControlAggregate", - "GsaPermissionCategoryAccessControlAggregateInfo", - "GsaPermissionCategoryAccessControlInfo", - "GsaPermissionCategoryCreationException", - "GsaPermissionCategoryErrorDetail", - "GsaPermissionCategoryErrorReason", - "GsaPermissionCategoryReplaceException", - "GsaPermissionCategoryUpdateException", - "GsaPermissionCreationException", - "GsaPermissionDeletionErrorDetail", - "GsaPermissionDeletionErrorReason", - "GsaPermissionDeletionException", - "GsaPermissionErrorDetail", - "GsaPermissionErrorReason", - "GsaPermissionPermissionCategoryErrorDetail", - "GsaPermissionUpdateException", - "GsaPermissionsInUseInfo", "GsaPermissionsInfo", "GsaPictureAttribute", "GsaPictureDatum", @@ -3036,7 +1854,6 @@ "GsaPointAggregation", "GsaPointAggregationDatumCriterion", "GsaPointAttribute", - "GsaPointChartData", "GsaPointDataValue", "GsaPointDatum", "GsaPointDatumCriterion", @@ -3050,23 +1867,6 @@ "GsaProfileTable", "GsaProfileTablesInfo", "GsaProperty", - "GsaPutDiscreteValue", - "GsaPutLayoutItem", - "GsaPutPermission", - "GsaPutPermissionCategory", - "GsaPutType", - "GsaQualityDiscreteValue", - "GsaQualityDiscreteValueErrorDetail", - "GsaQualityDiscreteValueErrorReason", - "GsaQualityDiscreteValuesErrorDetail", - "GsaQualitySystem", - "GsaQualitySystemCreationException", - "GsaQualitySystemDeletionException", - "GsaQualitySystemErrorDetail", - "GsaQualitySystemErrorReason", - "GsaQualitySystemGuidErrorDetail", - "GsaQualitySystemType", - "GsaQualitySystemsInfo", "GsaQueryAttribute", "GsaQueryAttributeFilter", "GsaQueryAttributeInfo", @@ -3083,25 +1883,9 @@ "GsaQueryDiscreteTypeProperties", "GsaQueryDiscreteTypesInfo", "GsaQueryDiscreteTypesRequest", - "GsaQueryLayout", - "GsaQueryLayoutFilter", - "GsaQueryLayoutItem", - "GsaQueryLayoutItemFilter", - "GsaQueryLayoutItemProperties", - "GsaQueryLayoutProperties", - "GsaQueryLayoutSection", - "GsaQueryLayoutSectionFilter", - "GsaQueryLayoutSectionProperties", - "GsaQueryLayoutSectionsInfo", - "GsaQueryLayoutSectionsRequest", - "GsaQueryLayoutsInfo", - "GsaQueryLayoutsRequest", "GsaQuerySlimDiscreteType", "GsaQuerySlimDiscreteTypeProperties", - "GsaQuerySlimEntity", - "GsaQuerySlimEntityProperties", "GsaQuerySlimNamedEntity", - "GsaQuerySlimNamedEntityFilter", "GsaQuerySlimNamedEntityProperties", "GsaQuerySlimTypedAttribute", "GsaQuerySlimTypedAttributeProperties", @@ -3112,48 +1896,33 @@ "GsaQueryTablesRequest", "GsaQueryTabularAttributeTarget", "GsaQueryTabularAttributeTargetProperties", - "GsaQueryTabularColumn", - "GsaQueryTabularColumnProperties", "GsaQueryUnit", "GsaQueryUnitProperties", "GsaRangeAggregation", "GsaRangeAggregationDatumCriterion", "GsaRangeAttribute", - "GsaRangeChartData", "GsaRangeDatum", "GsaRangeDatumCriterion", "GsaRangeDatumExistsCriterion", - "GsaRangeEndpoint", "GsaRangeFixedWidthHistogramAggregationDatumCriterion", "GsaRangeGraphValue", "GsaRangeHistogramAggregation", "GsaRangeHistogramAggregationDatumCriterion", "GsaRecordAncestorCriterion", "GsaRecordAncestorHistoryCriterion", - "GsaRecordAndAttributeSelectionType", + "GsaRecordCapabilities", "GsaRecordColor", "GsaRecordColorProperty", "GsaRecordExportFailure", "GsaRecordGuidProperty", "GsaRecordHistory", "GsaRecordHistoryCopyException", - "GsaRecordHistoryDescendantsAccessControlEntity", - "GsaRecordHistoryErrorReason", "GsaRecordHistoryGuidProperty", "GsaRecordHistoryMoveException", "GsaRecordHistoryReference", - "GsaRecordLink", - "GsaRecordLinkBase", - "GsaRecordLinkCreatePutLayoutItem", "GsaRecordLinkGroup", - "GsaRecordLinkGroupCreationException", - "GsaRecordLinkGroupErrorDetail", - "GsaRecordLinkGroupErrorReason", "GsaRecordLinkGroupType", - "GsaRecordLinkGroupUpdateException", "GsaRecordLinkGroupsInfo", - "GsaRecordLinkResult", - "GsaRecordLinkResults", "GsaRecordListHeader", "GsaRecordListHeadersInfo", "GsaRecordListItemsInfo", @@ -3173,82 +1942,45 @@ "GsaRecordReferenceType", "GsaRecordSubsetCriterion", "GsaRecordType", - "GsaRecordTypeCriterion", "GsaRecordTypeProperty", - "GsaRecordUserCapabilities", "GsaRecordVersion", - "GsaRecordVersionAccessControlEntity", "GsaRecordVersionReference", "GsaRecordWithData", "GsaReferencedByType", "GsaReferentialIntegrityModel", - "GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "GsaRegisterUpdateRequest", "GsaReleaseRecordVersionControlException", "GsaReleaseTableVersionControlException", "GsaReleasedDateProperty", "GsaRelevanceSortCriterion", "GsaRemoveRecordHistoryFromSubset", "GsaReorderSectionsInfo", - "GsaReorderTablesErrorDetail", - "GsaReorderTablesErrorReason", - "GsaReorderTablesException", - "GsaReorderTablesRequest", - "GsaReplaceDiscreteValuesException", - "GsaReplacePermissionCategoriesRequest", - "GsaReplacePermissionCategoryErrorDetail", - "GsaReplacePermissionCategoryErrorReason", "GsaReplacementString", "GsaReplacementStringsInfo", - "GsaResolveLinkTargetsInfo", - "GsaResolveLinkTargetsRequest", - "GsaResolvedBreadcrumb", + "GsaResolvedLink", + "GsaResolvedLinkInfo", "GsaResolvedLinkTarget", - "GsaResolvedTargetAttribute", "GsaResponseOptions", "GsaResubmitJobRequest", - "GsaRetargetPotentialRequest", - "GsaRetargetRequest", - "GsaRetargetResult", - "GsaRetargetResultType", - "GsaRetargetResultsInfo", - "GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", "GsaRichTextType", "GsaRichTextValue", - "GsaRoleNotProvidedPermissionErrorDetail", "GsaRollupExportFailure", "GsaRollupReference", - "GsaRootFolderMoveErrorDetail", - "GsaRootRecordNotAvailableToRenameErrorDetail", - "GsaRuleEngine", - "GsaSameParentFileMoveErrorDetail", - "GsaSameParentFolderMoveErrorDetail", - "GsaSchemaGenerationWarningReason", + "GsaSaveSearchRequest", "GsaSchemaTooNewAddDatabaseValidationIssue", "GsaSchemaTooOldAddDatabaseValidationIssue", "GsaSearchClusterStatus", + "GsaSearchDetail", "GsaSearchIndexStatus", - "GsaSearchMask", - "GsaSearchMaskInfo", "GsaSearchMaskUsageDataModificationErrorDetail", "GsaSearchRequest", "GsaSearchResponse", "GsaSearchResult", "GsaSearchResultsRequest", - "GsaSearchServiceStatus", - "GsaSearchTemplate", - "GsaSearchTemplateAttributeItem", - "GsaSearchTemplateInfo", - "GsaSearchTemplateItem", - "GsaSearchTemplateItemType", - "GsaSearchTemplateLinkItem", - "GsaSearchTemplateTabularColumnItem", "GsaSearchableRecordProperty", + "GsaSecurityAttributeGrouping", "GsaSecurityAttributeUsageDataModificationErrorDetail", "GsaSecurityGroups", - "GsaSelection", + "GsaSelectionSearch", "GsaSeriesGraph", "GsaSetDateTimeDatum", "GsaSetDatum", @@ -3268,9 +2000,6 @@ "GsaSetShortTextDatum", "GsaSetTabularDatum", "GsaSetTabularDatumRow", - "GsaSetUnitEquivalent", - "GsaSetUnitEquivalentsException", - "GsaSetUnitEquivalentsInfo", "GsaShortNameProperty", "GsaShortTextAggregation", "GsaShortTextAggregationDatumCriterion", @@ -3280,16 +2009,11 @@ "GsaShortTextDatumExistsCriterion", "GsaShortTextPrefixDatumCriterion", "GsaSignificantFiguresInfo", - "GsaSimilaritySetting", - "GsaSimilaritySettings", - "GsaSimilaritySortCriterion", "GsaSimpleAttributeToExport", - "GsaSlimAccessControlInfo", "GsaSlimAttribute", - "GsaSlimAttributeWithHelpPath", "GsaSlimConfiguration", + "GsaSlimConstant", "GsaSlimDatabase", - "GsaSlimDatabaseAccessControlInfo", "GsaSlimDiscreteType", "GsaSlimEntity", "GsaSlimExpression", @@ -3297,84 +2021,45 @@ "GsaSlimIdentifiedEntity", "GsaSlimLayout", "GsaSlimLayoutSection", - "GsaSlimLocalizedEntity", "GsaSlimNamedEntity", + "GsaSlimNamedUnit", "GsaSlimObjects", "GsaSlimParameter", - "GsaSlimParameterWithHelpPath", + "GsaSlimPermission", + "GsaSlimPermissionCategory", "GsaSlimProfile", "GsaSlimProfileTable", "GsaSlimRecordHistory", "GsaSlimRecordLinkGroup", "GsaSlimRecordVersion", "GsaSlimReplacementString", - "GsaSlimSearchMask", - "GsaSlimSearchTemplate", "GsaSlimSubset", "GsaSlimTable", "GsaSlimTypedAttribute", "GsaSlimUnit", - "GsaSmartAttributesErrorDetail", - "GsaSmartAttributesErrorReason", - "GsaSmartAttributesRecordLinkGroupErrorDetail", - "GsaSmartLink", - "GsaSmartLinkCreatePutLayoutItem", - "GsaSmartLinkGroupUsageDataModificationErrorDetail", - "GsaSmartRecordLinkGroup", - "GsaSmartRecordLinkResult", + "GsaSlimUnitSystem", + "GsaSmtpProperties", "GsaSortCriterion", "GsaSortCriterionType", "GsaSortDirection", "GsaSortType", "GsaSortingValue", "GsaSortingValueType", - "GsaSourceCannotBeTargetSmartAttributesErrorDetail", "GsaSourceOfObjectIdentifier", "GsaSpecificValuesSpecifier", - "GsaSqlCredentials", "GsaStandardName", - "GsaStandardNameAlreadyExistsErrorDetail", - "GsaStandardNameCreationException", - "GsaStandardNameDeletionErrorDetail", - "GsaStandardNameDeletionErrorReason", - "GsaStandardNameDeletionException", - "GsaStandardNameErrorDetail", - "GsaStandardNameErrorReason", - "GsaStandardNameUpdateException", "GsaStandardNamesInfo", - "GsaStaticRecordLink", "GsaStaticRecordLinkGroup", - "GsaStaticRecordLinkGroupMapping", - "GsaStaticRecordLinkResult", "GsaStringSortingValue", "GsaSubset", "GsaSubsetsInfo", - "GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail", - "GsaSymbolCannotContainCommaUnitErrorDetail", - "GsaTItem", "GsaTable", - "GsaTableAccessControlEntity", - "GsaTableCreationException", "GsaTableDeletionException", - "GsaTableDescendantsAccessControlEntity", - "GsaTableErrorDetail", - "GsaTableErrorReason", "GsaTableGuidProperty", "GsaTableIdentityProperty", "GsaTableNameProperty", - "GsaTableSearchBehaviour", - "GsaTableTypeContainsCommaErrorDetail", - "GsaTableTypeErrorDetail", - "GsaTableTypeErrorReason", - "GsaTableTypesErrorDetail", - "GsaTableTypesInfo", - "GsaTableUpdateException", - "GsaTableUsageDataModificationErrorDetail", - "GsaTableVersionStateAccessControlCategoryErrorDetail", "GsaTablesInfo", - "GsaTablesMissingReorderTablesErrorDetail", "GsaTabularAttribute", - "GsaTabularAttributeLink", "GsaTabularAttributeTarget", "GsaTabularAttributeUsageDataModificationErrorDetail", "GsaTabularAttributeWithColumns", @@ -3383,7 +2068,6 @@ "GsaTabularColumnNameNotProvidedErrorDetail", "GsaTabularColumnNoSuchEntityType", "GsaTabularColumnRollUpType", - "GsaTabularColumnUsageDataModificationErrorDetail", "GsaTabularDatum", "GsaTabularDatumCell", "GsaTabularDatumExistsCriterion", @@ -3392,75 +2076,36 @@ "GsaTabularDatumSummaryRow", "GsaTabularLinkingValueCriterion", "GsaTabularRowExportBehavior", - "GsaTargetAttribute", "GsaTargetAttributeNotInTableAttributeErrorDetail", - "GsaTargetAttributeType", "GsaTargetAttributeTypeAttributeErrorDetail", - "GsaTargetNotFullySpecifiedAttributeErrorDetail", "GsaTermWithCount", "GsaTextMatchBehavior", "GsaThresholdTypeAttributeErrorDetail", - "GsaThresholdValueNameEmptyErrorDetail", - "GsaThresholdValueNameInvalidErrorDetail", - "GsaTooLongCodeCurrencyErrorDetail", - "GsaTooManyAttributePairsSmartAttributesErrorDetail", - "GsaTooManyPermissionsPermissionCategoryErrorDetail", - "GsaTooManyPermissionsReplacePermissionCategoryErrorDetail", - "GsaTranslateBetweenGuidsAndIdentitiesResponse", "GsaTranslateGuidsToIdentitiesRequest", - "GsaTranslateIdentitiesToGuidsRequest", + "GsaTranslateGuidsToIdentitiesResponse", "GsaUnableToConnectAddDatabaseValidationIssue", "GsaUnavailableTabularColumn", "GsaUnit", - "GsaUnitAsExponentUnitEquationErrorDetail", "GsaUnitConversionSet", "GsaUnitConversionSetRequest", "GsaUnitConversionsInfo", - "GsaUnitCreationException", - "GsaUnitDeletionException", - "GsaUnitEquationErrorDetail", - "GsaUnitEquationErrorReason", "GsaUnitEquivalent", - "GsaUnitEquivalentErrorDetail", - "GsaUnitEquivalentErrorReason", "GsaUnitEquivalentsInfo", - "GsaUnitErrorDetail", - "GsaUnitErrorReason", "GsaUnitMapping", "GsaUnitSystem", "GsaUnitSystemsInfo", - "GsaUnitUpdateException", "GsaUnitUsage", - "GsaUnitUsageDataModificationErrorDetail", - "GsaUnitUsageType", - "GsaUnitsGroupingInfo", "GsaUnitsInfo", - "GsaUnknownUnitSymbolUnitEquationErrorDetail", - "GsaUnresolvedAttributeGuidsErrorDetail", - "GsaUnresolvedBreadcrumb", - "GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedParameterGuidsErrorDetail", - "GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedReverseRecordLinkGroupsErrorDetail", - "GsaUnresolvedTargetAttribute", - "GsaUpdateAccessControl", - "GsaUpdateAccessControlCategory", - "GsaUpdateAccessControlCategoryTableMapping", "GsaUpdateAllProfilesInfo", "GsaUpdateAttribute", - "GsaUpdateAttributeBasedAccessControl", "GsaUpdateAxisName", "GsaUpdateConfiguration", "GsaUpdateConstant", "GsaUpdateContinuousRange", "GsaUpdateCrossDatabaseRecordLinkGroup", - "GsaUpdateCurrentRuleEngine", "GsaUpdateDataRule", "GsaUpdateDatabase", - "GsaUpdateDatabaseSecurityGroups", "GsaUpdateDateTimeAttribute", - "GsaUpdateDefaultDatabase", - "GsaUpdateDefaultFallbackSecurityGroups", "GsaUpdateDefaultProfile", "GsaUpdateDiscreteAttribute", "GsaUpdateDiscreteFunctionalAttribute", @@ -3472,8 +2117,7 @@ "GsaUpdateDiscreteParameterValue", "GsaUpdateDiscreteRange", "GsaUpdateDiscreteType", - "GsaUpdateDisplayNames", - "GsaUpdateDisplayNamesResponse", + "GsaUpdateDynamicRecordLinkGroup", "GsaUpdateExpression", "GsaUpdateFile", "GsaUpdateFileAttribute", @@ -3486,7 +2130,6 @@ "GsaUpdateIntegerAttribute", "GsaUpdateJobRequest", "GsaUpdateLayout", - "GsaUpdateLayoutSection", "GsaUpdateLinkedAttributeTabularColumn", "GsaUpdateLinkedColumnTabularColumn", "GsaUpdateLinkedRecordTabularColumn", @@ -3511,74 +2154,46 @@ "GsaUpdateParameter", "GsaUpdateParameterContent", "GsaUpdateParameterValue", - "GsaUpdatePermission", - "GsaUpdatePermissionAccessControl", - "GsaUpdatePermissionBasedAccessControl", - "GsaUpdatePermissionCategory", - "GsaUpdatePermissionCategoryAccessControl", - "GsaUpdatePermissionCategoryAccessControlRequest", - "GsaUpdatePermissionCategoryAccessControlsOperationRequest", "GsaUpdatePictureAttribute", "GsaUpdatePointAttribute", "GsaUpdateProfile", "GsaUpdateProfileTable", - "GsaUpdatePutDiscreteValue", - "GsaUpdatePutLayoutItem", - "GsaUpdatePutPermission", - "GsaUpdatePutPermissionCategory", "GsaUpdateRangeAttribute", "GsaUpdateRecordLinkGroup", "GsaUpdateRecordListPermissionFlags", "GsaUpdateRecordListProperties", "GsaUpdateReplacementString", - "GsaUpdateRootFolderErrorDetail", - "GsaUpdateRunStatus", "GsaUpdateShortTextAttribute", - "GsaUpdateSmartRecordLinkGroup", "GsaUpdateStandardName", "GsaUpdateStaticRecordLinkGroup", - "GsaUpdateStaticRecordLinkGroupMapping", "GsaUpdateSubset", "GsaUpdateTable", "GsaUpdateTabularAttribute", "GsaUpdateTabularAttributeTarget", "GsaUpdateTabularColumn", - "GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail", - "GsaUpdateTabularColumnTypeAttributeErrorDetail", "GsaUpdateUnavailableTabularColumn", "GsaUpdateUnit", "GsaUpdateUnitSystem", "GsaUpdateUserPermission", "GsaUpdateUserPermissionsInfo", - "GsaUpgradeDatabaseException", - "GsaUpgradeDatabaseFailureReason", "GsaUsageDataModificationErrorDetail", - "GsaUserCapabilities", + "GsaUserOrGroup", "GsaUserPermission", "GsaUserPermissionsInfo", "GsaUserRole", "GsaValidateAttributeRequest", - "GsaValidateUnitEquationRequest", - "GsaValidateUnitEquationResponse", - "GsaValueNotProvidedParameterValueErrorDetail", "GsaValueSpecifier", "GsaValueSpecifierType", "GsaValueWithCountOfBoolean", "GsaValueWithCountOfGuid", "GsaValueWithCountOfInt32", "GsaVersionControlErrorDetail", - "GsaVersionControlErrorReason", - "GsaVersionControlMode", "GsaVersionControlledDataUsageDataModificationErrorDetail", "GsaVersionNumberProperty", "GsaVersionState", "GsaVersionStateProperty", - "GsaWeightingType", "GsaWithdrawRecordVersionControlException", - "GsaXYChartTemplate", "GsaXYChartTemplateUsageDataModificationErrorDetail", - "GsaXYChartTemplatesInfo", - "GsaXYTemplateAxis", "JobqueueFilesBody", "JsonPatchDocument", "MicrosoftAspNetCoreMvcFormattersIOutputFormatter", diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/__init__.py index 3c4b14c1..3a9d33cb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/__init__.py @@ -25,25 +25,12 @@ # import API ABC from ansys.openapi.common import ApiBase -from .access_control___attribute_based_categories_api import ( - AccessControlAttributeBasedCategoriesApi, -) -from .access_control___permission_based_api import AccessControlPermissionBasedApi -from .access_control___permission_based_schema_api import AccessControlPermissionBasedSchemaApi - # import apis into api package -from .access_control_api import AccessControlApi -from .activity_log_api import ActivityLogApi from .aggregation_api import AggregationApi -from .blob_infos_api import BlobInfosApi -from .blobs_api import BlobsApi from .bulk_api import BulkApi -from .currencies_api import CurrenciesApi from .data_api import DataApi from .data_export_api import DataExportApi -from .data_updater_api import DataUpdaterApi from .database_api import DatabaseApi -from .find_similar_api import FindSimilarApi from .graph_api import GraphApi from .help_location_api import HelpLocationApi from .identities_api import IdentitiesApi @@ -55,7 +42,7 @@ from .list_management_api import ListManagementApi from .list_permissions_api import ListPermissionsApi from .metrics_api import MetricsApi -from .record_links_api import RecordLinksApi +from .permission_based_access_control_api import PermissionBasedAccessControlApi from .records___record_histories_api import RecordsRecordHistoriesApi from .records___record_versions_api import RecordsRecordVersionsApi from .schema___attributes_api import SchemaAttributesApi @@ -65,7 +52,6 @@ from .schema___databases_api import SchemaDatabasesApi from .schema___discrete_types___discrete_values_api import SchemaDiscreteTypesDiscreteValuesApi from .schema___discrete_types_api import SchemaDiscreteTypesApi -from .schema___display_names_api import SchemaDisplayNamesApi from .schema___exporters_api import SchemaExportersApi from .schema___expressions_api import SchemaExpressionsApi from .schema___global_standard_names_api import SchemaGlobalStandardNamesApi @@ -76,39 +62,25 @@ from .schema___parameters_api import SchemaParametersApi from .schema___profile_tables_api import SchemaProfileTablesApi from .schema___profiles_api import SchemaProfilesApi -from .schema___quality_systems_api import SchemaQualitySystemsApi from .schema___record_link_groups_api import SchemaRecordLinkGroupsApi from .schema___replacement_strings_api import SchemaReplacementStringsApi -from .schema___search_masks_api import SchemaSearchMasksApi -from .schema___search_templates_api import SchemaSearchTemplatesApi -from .schema___security_groups_api import SchemaSecurityGroupsApi from .schema___standard_names_api import SchemaStandardNamesApi from .schema___subsets_api import SchemaSubsetsApi from .schema___tables_api import SchemaTablesApi -from .schema___unit_equivalents_api import SchemaUnitEquivalentsApi from .schema___units_api import SchemaUnitsApi -from .schema___xy_chart_templates_api import SchemaXYChartTemplatesApi from .schema_api import SchemaApi from .search_api import SearchApi +from .selection_searches_api import SelectionSearchesApi +from .server_manager_api import ServerManagerApi from .status_api import StatusApi __all__ = [ "ApiBase", - "AccessControlApi", - "AccessControlAttributeBasedCategoriesApi", - "AccessControlPermissionBasedApi", - "AccessControlPermissionBasedSchemaApi", - "ActivityLogApi", "AggregationApi", - "BlobInfosApi", - "BlobsApi", "BulkApi", - "CurrenciesApi", "DataApi", "DataExportApi", - "DataUpdaterApi", "DatabaseApi", - "FindSimilarApi", "GraphApi", "HelpLocationApi", "IdentitiesApi", @@ -120,7 +92,7 @@ "ListManagementApi", "ListPermissionsApi", "MetricsApi", - "RecordLinksApi", + "PermissionBasedAccessControlApi", "RecordsRecordHistoriesApi", "RecordsRecordVersionsApi", "SchemaApi", @@ -131,7 +103,6 @@ "SchemaDatabasesApi", "SchemaDiscreteTypesDiscreteValuesApi", "SchemaDiscreteTypesApi", - "SchemaDisplayNamesApi", "SchemaExportersApi", "SchemaExpressionsApi", "SchemaGlobalStandardNamesApi", @@ -142,18 +113,14 @@ "SchemaParametersApi", "SchemaProfileTablesApi", "SchemaProfilesApi", - "SchemaQualitySystemsApi", "SchemaRecordLinkGroupsApi", "SchemaReplacementStringsApi", - "SchemaSearchMasksApi", - "SchemaSearchTemplatesApi", - "SchemaSecurityGroupsApi", "SchemaStandardNamesApi", "SchemaSubsetsApi", "SchemaTablesApi", - "SchemaUnitEquivalentsApi", "SchemaUnitsApi", - "SchemaXYChartTemplatesApi", "SearchApi", + "SelectionSearchesApi", + "ServerManagerApi", "StatusApi", ] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___attribute_based_categories_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___attribute_based_categories_api.py deleted file mode 100644 index aa3fdd56..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___attribute_based_categories_api.py +++ /dev/null @@ -1,552 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class AccessControlAttributeBasedCategoriesApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def create_category( - self, *, database_key: "str", body: "Optional[GsaCreateAccessControlCategory]" = None - ) -> "GsaAccessControlCategory | GsaAccessControlCategoryCreationException | None": - """Create an attribute-based access control category in the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaCreateAccessControlCategory - - Returns - ------- - GsaAccessControlCategory | GsaAccessControlCategoryCreationException | None - """ - data = self._create_category_with_http_info(database_key, body, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _create_category_with_http_info( - self, - database_key: "str", - body: "Optional[GsaCreateAccessControlCategory]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 201: "GsaAccessControlCategory", - 400: "GsaAccessControlCategoryCreationException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_category(self, *, database_key: "str", category_guid: "str") -> "None": - """Delete an attribute-based access control category in the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - - Returns - ------- - None - """ - data = self._delete_category_with_http_info( - database_key, category_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_category_with_http_info( - self, database_key: "str", category_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'delete_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_categories( - self, - *, - database_key: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - ) -> "GsaAccessControlCategoriesInfo | None": - """Get all access control categories for the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - include: list[GsaAccessControlCategoryInclude] - Optionally include related data e.g. tableMappings in the response. - - Returns - ------- - GsaAccessControlCategoriesInfo | None - """ - data = self._get_categories_with_http_info( - database_key, include, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_categories_with_http_info( - self, - database_key: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "include", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_categories" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_categories'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "include" in params and include is not None: - query_params.append(("include", params["include"])) - collection_formats["include"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlCategoriesInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_category_by_guid( - self, - *, - database_key: "str", - category_guid: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - ) -> "GsaAccessControlCategory | None": - """Get the access control category with the specified guid in the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - include: list[GsaAccessControlCategoryInclude] - Optionally include related data e.g. tableMappings in the response. - - Returns - ------- - GsaAccessControlCategory | None - """ - data = self._get_category_by_guid_with_http_info( - database_key, category_guid, include, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_category_by_guid_with_http_info( - self, - database_key: "str", - category_guid: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "include", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_category_by_guid" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_category_by_guid'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_category_by_guid'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - if "include" in params and include is not None: - query_params.append(("include", params["include"])) - collection_formats["include"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlCategory", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_category( - self, - *, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdateAccessControlCategory]" = None, - ) -> "GsaAccessControlCategory | GsaAccessControlCategoryUpdateException | None": - """Update an attribute-based access control category in the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - body: GsaUpdateAccessControlCategory - - Returns - ------- - GsaAccessControlCategory | GsaAccessControlCategoryUpdateException | None - """ - data = self._update_category_with_http_info( - database_key, category_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_category_with_http_info( - self, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdateAccessControlCategory]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'update_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlCategory", - 400: "GsaAccessControlCategoryUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_api.py deleted file mode 100644 index 1a96cba9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_api.py +++ /dev/null @@ -1,648 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class AccessControlPermissionBasedApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def aggregate_permission_access_controls( - self, - *, - database_key: "str", - body: "Optional[GsaAggregatePermissionAccessControlsRequest]" = None, - ) -> "GsaPermissionBasedAccessControlAggregationException | GsaPermissionCategoryAccessControlAggregateInfo | None": - """Gets the aggregated permission-based access control settings for entities. Returns whether all, some, or none of the provided entities have read or write access for each permission. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaAggregatePermissionAccessControlsRequest - - Returns - ------- - GsaPermissionBasedAccessControlAggregationException | GsaPermissionCategoryAccessControlAggregateInfo | None - """ - data = self._aggregate_permission_access_controls_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _aggregate_permission_access_controls_with_http_info( - self, - database_key: "str", - body: "Optional[GsaAggregatePermissionAccessControlsRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method aggregate_permission_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'aggregate_permission_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlAggregateInfo", - 400: "GsaPermissionBasedAccessControlAggregationException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-based-access-control/aggregate", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def cancel_permission_category_access_controls_operation( - self, *, database_key: "str", operation_identifier: "str" - ) -> "GsaLongRunningOperation | GsaLongRunningOperationInvalidStatusException | None": - """Requests cancellation of a long-running operation for updating permission-based access control settings. Cancellation will only happen when the operation is pending or in progress, and is not guaranteed - it is a best-effort attempt to stop the operation early. The long-running operation status will be set to awaitingCancellation; then to cancelled if cancellation is successful. If the long-running operation has already completed (succeeded or failed), an error will be returned. If the long-running operation has already been cancelled, the status will remain as is (awaitingCancellation or cancelled). - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - operation_identifier: str - - Returns - ------- - GsaLongRunningOperation | GsaLongRunningOperationInvalidStatusException | None - """ - data = self._cancel_permission_category_access_controls_operation_with_http_info( - database_key, operation_identifier, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _cancel_permission_category_access_controls_operation_with_http_info( - self, database_key: "str", operation_identifier: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "operation_identifier", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method cancel_permission_category_access_controls_operation" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'cancel_permission_category_access_controls_operation'" - ) - # verify the required parameter "operation_identifier" is set - if "operation_identifier" not in params or params["operation_identifier"] is None: - raise ValueError( - "Missing the required parameter 'operation_identifier' when calling 'cancel_permission_category_access_controls_operation'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "operation_identifier" in params and operation_identifier is not None: - path_params["operation-identifier"] = params["operation_identifier"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLongRunningOperation", - 422: "GsaLongRunningOperationInvalidStatusException", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations/{operation-identifier}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_category_access_controls_operation( - self, - *, - database_key: "str", - operation_identifier: "str", - include: "Optional[list[GsaLongRunningOperationInclude]]" = None, - ) -> "GsaLongRunningOperation | None": - """Gets the long-running operation for updating permission-based access control settings in the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - operation_identifier: str - include: list[GsaLongRunningOperationInclude] - - Returns - ------- - GsaLongRunningOperation | None - """ - data = self._get_permission_category_access_controls_operation_with_http_info( - database_key, operation_identifier, include, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_category_access_controls_operation_with_http_info( - self, - database_key: "str", - operation_identifier: "str", - include: "Optional[list[GsaLongRunningOperationInclude]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "operation_identifier", - "include", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_category_access_controls_operation" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_category_access_controls_operation'" - ) - # verify the required parameter "operation_identifier" is set - if "operation_identifier" not in params or params["operation_identifier"] is None: - raise ValueError( - "Missing the required parameter 'operation_identifier' when calling 'get_permission_category_access_controls_operation'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "operation_identifier" in params and operation_identifier is not None: - path_params["operation-identifier"] = params["operation_identifier"] - - query_params: list[Any] = [] - if "include" in params and include is not None: - query_params.append(("include", params["include"])) - collection_formats["include"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLongRunningOperation", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations/{operation-identifier}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_category_access_controls_operation_result( - self, *, database_key: "str", operation_identifier: "str" - ) -> "None": - """Gets the result of a long-running operation for updating permission-based access control settings in the specified database. A successful response would return a 204 No Content response. A failed response would return an error response. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - operation_identifier: str - - Returns - ------- - None - """ - data = self._get_permission_category_access_controls_operation_result_with_http_info( - database_key, operation_identifier, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_category_access_controls_operation_result_with_http_info( - self, database_key: "str", operation_identifier: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "operation_identifier", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_category_access_controls_operation_result" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_category_access_controls_operation_result'" - ) - # verify the required parameter "operation_identifier" is set - if "operation_identifier" not in params or params["operation_identifier"] is None: - raise ValueError( - "Missing the required parameter 'operation_identifier' when calling 'get_permission_category_access_controls_operation_result'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "operation_identifier" in params and operation_identifier is not None: - path_params["operation-identifier"] = params["operation_identifier"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 204: None, - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations/{operation-identifier}/result", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_category_access_controls_operations( - self, - *, - database_key: "str", - include: "Optional[list[GsaLongRunningOperationInclude]]" = None, - status: "Optional[list[GsaLongRunningStatus]]" = None, - ) -> "None | list[GsaLongRunningOperation]": - """Gets all long-running operations for updating permission-based access control settings in the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - include: list[GsaLongRunningOperationInclude] - Optionally include more detailed information in the response. - status: list[GsaLongRunningStatus] - Optional filter for the status of the long-running operations. - - Returns - ------- - None | list[GsaLongRunningOperation] - """ - data = self._get_permission_category_access_controls_operations_with_http_info( - database_key, include, status, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_category_access_controls_operations_with_http_info( - self, - database_key: "str", - include: "Optional[list[GsaLongRunningOperationInclude]]" = None, - status: "Optional[list[GsaLongRunningStatus]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "include", - "status", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_category_access_controls_operations" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_category_access_controls_operations'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "include" in params and include is not None: - query_params.append(("include", params["include"])) - collection_formats["include"] = "multi" - if "status" in params and status is not None: - query_params.append(("status", params["status"])) - collection_formats["status"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaLongRunningOperation]", - 403: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_permission_category_access_controls_operation( - self, - *, - database_key: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlsOperationRequest]" = None, - ) -> "GsaLongRunningOperation | GsaPermissionBasedAccessControlUpdateOperationException | None": - """Update permission-based access control settings for entities. Sets the access control for the given permissions on each entity. If setting access control on a record, its data will also be updated, but constrained by the attribute. If setting access control on an attribute, its data will also be updated, but constrained by the latest relevant recordVersion. This runs as a long-running operation. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaUpdatePermissionCategoryAccessControlsOperationRequest - - Returns - ------- - GsaLongRunningOperation | GsaPermissionBasedAccessControlUpdateOperationException | None - """ - data = self._update_permission_category_access_controls_operation_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_permission_category_access_controls_operation_with_http_info( - self, - database_key: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlsOperationRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_permission_category_access_controls_operation" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_permission_category_access_controls_operation'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 202: "GsaLongRunningOperation", - 400: "GsaPermissionBasedAccessControlUpdateOperationException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-based-access-control/update-operations", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_schema_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_schema_api.py deleted file mode 100644 index dabf6ce7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control___permission_based_schema_api.py +++ /dev/null @@ -1,1252 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class AccessControlPermissionBasedSchemaApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def create_permission( - self, - *, - database_key: "str", - category_guid: "str", - body: "Optional[GsaCreatePermission]" = None, - ) -> "GsaPermission | GsaPermissionCreationException | None": - """Create a new permission-based access control permission. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - body: GsaCreatePermission - - Returns - ------- - GsaPermission | GsaPermissionCreationException | None - """ - data = self._create_permission_with_http_info( - database_key, category_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_permission_with_http_info( - self, - database_key: "str", - category_guid: "str", - body: "Optional[GsaCreatePermission]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_permission" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_permission'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'create_permission'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 201: "GsaPermission", - 400: "GsaPermissionCreationException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def create_permission_category( - self, *, database_key: "str", body: "Optional[GsaCreatePermissionCategory]" = None - ) -> "GsaPermissionCategory | GsaPermissionCategoryCreationException | None": - """Create a new permission-based access control category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaCreatePermissionCategory - - Returns - ------- - GsaPermissionCategory | GsaPermissionCategoryCreationException | None - """ - data = self._create_permission_category_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_permission_category_with_http_info( - self, - database_key: "str", - body: "Optional[GsaCreatePermissionCategory]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 201: "GsaPermissionCategory", - 400: "GsaPermissionCategoryCreationException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_permission( - self, *, database_key: "str", category_guid: "str", permission_guid: "str" - ) -> "GsaPermissionDeletionException | None": - """Delete a permission-based access control permission. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - permission_guid: str - See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory) - - Returns - ------- - GsaPermissionDeletionException | None - """ - data = self._delete_permission_with_http_info( - database_key, category_guid, permission_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_permission_with_http_info( - self, database_key: "str", category_guid: "str", permission_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "permission_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_permission" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_permission'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'delete_permission'" - ) - # verify the required parameter "permission_guid" is set - if "permission_guid" not in params or params["permission_guid"] is None: - raise ValueError( - "Missing the required parameter 'permission_guid' when calling 'delete_permission'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - if "permission_guid" in params and permission_guid is not None: - path_params["permission-guid"] = params["permission_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 400: "GsaPermissionDeletionException", - 200: None, - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_permission_category(self, *, database_key: "str", category_guid: "str") -> "None": - """Delete a permission-based access control category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - - Returns - ------- - None - """ - data = self._delete_permission_category_with_http_info( - database_key, category_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_permission_category_with_http_info( - self, database_key: "str", category_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_permission_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'delete_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_categories( - self, *, database_key: "str" - ) -> "GsaPermissionCategoriesInfo | None": - """Get all permission-based access control categories for the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaPermissionCategoriesInfo | None - """ - data = self._get_permission_categories_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_categories_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_categories" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_categories'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoriesInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_category( - self, *, database_key: "str", category_guid: "str" - ) -> "GsaPermissionCategory | None": - """Get a permission-based access control category with a specified guid. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - - Returns - ------- - GsaPermissionCategory | None - """ - data = self._get_permission_category_with_http_info( - database_key, category_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_category_with_http_info( - self, database_key: "str", category_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategory", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_in_category( - self, *, database_key: "str", category_guid: "str", permission_guid: "str" - ) -> "GsaPermission | None": - """Get a permission-based access control permission with a given guid in the specified category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - permission_guid: str - See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory) - - Returns - ------- - GsaPermission | None - """ - data = self._get_permission_in_category_with_http_info( - database_key, category_guid, permission_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_in_category_with_http_info( - self, database_key: "str", category_guid: "str", permission_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "permission_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_in_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_in_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_permission_in_category'" - ) - # verify the required parameter "permission_guid" is set - if "permission_guid" not in params or params["permission_guid"] is None: - raise ValueError( - "Missing the required parameter 'permission_guid' when calling 'get_permission_in_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - if "permission_guid" in params and permission_guid is not None: - path_params["permission-guid"] = params["permission_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermission", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permissions_in_category( - self, *, database_key: "str", category_guid: "str" - ) -> "GsaPermissionsInfo | None": - """Get all permission-based access control permissions for the specified category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - - Returns - ------- - GsaPermissionsInfo | None - """ - data = self._get_permissions_in_category_with_http_info( - database_key, category_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permissions_in_category_with_http_info( - self, database_key: "str", category_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permissions_in_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permissions_in_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_permissions_in_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionsInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permissions_in_use(self, *, database_key: "str") -> "GsaPermissionsInUseInfo | None": - """Gets the number of permissions that have been used and the number remaining that are available to be used. A schema for a database may have up to 128 permissions, this is the total number of permissions that have ever existed in the schema. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaPermissionsInUseInfo | None - """ - data = self._get_permissions_in_use_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permissions_in_use_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permissions_in_use" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permissions_in_use'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionsInUseInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/permissionsInUse", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def replace_permission_categories( - self, *, database_key: "str", body: "Optional[GsaReplacePermissionCategoriesRequest]" = None - ) -> "GsaPermissionCategoriesInfo | GsaPermissionCategoryReplaceException | None": - """Replace all permission-based access control categories. This can result in adding, modifying and deleting permission categories. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaReplacePermissionCategoriesRequest - - Returns - ------- - GsaPermissionCategoriesInfo | GsaPermissionCategoryReplaceException | None - """ - data = self._replace_permission_categories_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _replace_permission_categories_with_http_info( - self, - database_key: "str", - body: "Optional[GsaReplacePermissionCategoriesRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method replace_permission_categories" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'replace_permission_categories'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoriesInfo", - 400: "GsaPermissionCategoryReplaceException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories", - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_permission( - self, - *, - database_key: "str", - category_guid: "str", - permission_guid: "str", - body: "Optional[GsaUpdatePermission]" = None, - ) -> "GsaPermission | GsaPermissionUpdateException | None": - """Update a permission-based access control permission. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - permission_guid: str - See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory) - body: GsaUpdatePermission - - Returns - ------- - GsaPermission | GsaPermissionUpdateException | None - """ - data = self._update_permission_with_http_info( - database_key, category_guid, permission_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_permission_with_http_info( - self, - database_key: "str", - category_guid: "str", - permission_guid: "str", - body: "Optional[GsaUpdatePermission]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "permission_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_permission" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_permission'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'update_permission'" - ) - # verify the required parameter "permission_guid" is set - if "permission_guid" not in params or params["permission_guid"] is None: - raise ValueError( - "Missing the required parameter 'permission_guid' when calling 'update_permission'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - if "permission_guid" in params and permission_guid is not None: - path_params["permission-guid"] = params["permission_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermission", - 400: "GsaPermissionUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_permission_category( - self, - *, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdatePermissionCategory]" = None, - ) -> "GsaPermissionCategory | GsaPermissionCategoryUpdateException | None": - """Update a permission-based access control category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - body: GsaUpdatePermissionCategory - - Returns - ------- - GsaPermissionCategory | GsaPermissionCategoryUpdateException | None - """ - data = self._update_permission_category_with_http_info( - database_key, category_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_permission_category_with_http_info( - self, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdatePermissionCategory]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_permission_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'update_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategory", - 400: "GsaPermissionCategoryUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control_api.py deleted file mode 100644 index 95908665..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/access_control_api.py +++ /dev/null @@ -1,337 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class AccessControlApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_access_control_database_user_capabilities( - self, *, database_key: "str" - ) -> "GsaAccessControlDatabaseUserCapabilities | None": - """Gets user capabilities for access control for the given database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaAccessControlDatabaseUserCapabilities | None - """ - data = self._get_access_control_database_user_capabilities_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_access_control_database_user_capabilities_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_access_control_database_user_capabilities" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_access_control_database_user_capabilities'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlDatabaseUserCapabilities", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/accessControl/{database-key}/user-capabilities", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_access_control_user_capabilities(self) -> "GsaAccessControlUserCapabilities | None": - """Gets user capabilities for access control. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaAccessControlUserCapabilities | None - """ - data = self._get_access_control_user_capabilities_with_http_info( - _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_access_control_user_capabilities_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_access_control_user_capabilities" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlUserCapabilities", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/accessControl/user-capabilities", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_slim_access_control_info(self) -> "GsaSlimAccessControlInfo | None": - """Gets information about current access control. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaSlimAccessControlInfo | None - """ - data = self._get_slim_access_control_info_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_slim_access_control_info_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_slim_access_control_info" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSlimAccessControlInfo", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/accessControl", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_slim_database_access_control_info( - self, *, database_key: "str" - ) -> "GsaSlimDatabaseAccessControlInfo | None": - """Gets information about current access control for the given database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaSlimDatabaseAccessControlInfo | None - """ - data = self._get_slim_database_access_control_info_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_slim_database_access_control_info_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_slim_database_access_control_info" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_slim_database_access_control_info'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSlimDatabaseAccessControlInfo", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/accessControl/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/activity_log_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/activity_log_api.py deleted file mode 100644 index db5edeed..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/activity_log_api.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class ActivityLogApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_entries( - self, - *, - body: "Optional[GsaActivityLogEntriesFilter]" = None, - page_size: "Optional[int]" = 1000, - page: "Optional[int]" = 1, - ) -> "GsaActivityLogEntriesInfo | None": - """Get filtered activity log entries, ordered from newest to oldest. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaActivityLogEntriesFilter - Filter object used to narrow down the entries to return. - page_size: int - Page size. Defaults to 1 000. The limit is 10 000. - page: int - Page number. Defaults to 1. - - Returns - ------- - GsaActivityLogEntriesInfo | None - """ - data = self._get_entries_with_http_info(body, page_size, page, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_entries_with_http_info( - self, - body: "Optional[GsaActivityLogEntriesFilter]" = None, - page_size: "Optional[int]" = 1000, - page: "Optional[int]" = 1, - **kwargs: Any, - ) -> Any: - all_params = [ - "body", - "page_size", - "page", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_entries") - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - if "page_size" in params and page_size is not None: - query_params.append(("pageSize", params["page_size"])) - if "page" in params and page is not None: - query_params.append(("page", params["page"])) - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaActivityLogEntriesInfo", - 400: None, - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/activity-log/entries", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/aggregation_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/aggregation_api.py index 558d3fce..bc5a4ee2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/aggregation_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/aggregation_api.py @@ -63,12 +63,11 @@ def database_aggregation( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaAggregationsRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -178,14 +177,12 @@ def database_aggregation_for_table_with_guid( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaAggregationsRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -304,13 +301,12 @@ def database_aggregation_for_table_with_identity( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_identity: int body: GsaAggregationsRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blob_infos_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blob_infos_api.py deleted file mode 100644 index 26b5aa49..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blob_infos_api.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class BlobInfosApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_all_data_updater_blob_infos(self) -> "list[GsaBlobInfoDto]": - """Get a list of all blob descriptors for databases that the user is admin of. - - This method makes a synchronous HTTP request. - - Returns - ------- - list[GsaBlobInfoDto] - """ - data = self._get_all_data_updater_blob_infos_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_all_data_updater_blob_infos_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_data_updater_blob_infos" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaBlobInfoDto]", - } - - return self.api_client.call_api( - "/v1alpha/blob-infos/dataupdater", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_data_updater_blob_infos( - self, *, database_key: "str", blob_path: "str", recursive: "Optional[bool]" = None - ) -> "list[GsaBlobInfoDto]": - """Get a list of blob descriptors for a specific database, optionally limited by their relative path. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key. - blob_path: str - Path to look under (without the blob name). Can be empty - recursive: bool - Whether to look under sub-paths as well. - - Returns - ------- - list[GsaBlobInfoDto] - """ - data = self._get_data_updater_blob_infos_with_http_info( - database_key, blob_path, recursive, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_data_updater_blob_infos_with_http_info( - self, - database_key: "str", - blob_path: "str", - recursive: "Optional[bool]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "recursive", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_data_updater_blob_infos" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_data_updater_blob_infos'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'get_data_updater_blob_infos'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blob-path"] = params["blob_path"] - - query_params: list[Any] = [] - if "recursive" in params and recursive is not None: - query_params.append(("recursive", params["recursive"])) - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaBlobInfoDto]", - } - - return self.api_client.call_api( - "/v1alpha/blob-infos/dataupdater/{database-key}/{blob-path}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blobs_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blobs_api.py deleted file mode 100644 index 61042b86..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/blobs_api.py +++ /dev/null @@ -1,336 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class BlobsApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def delete_data_updater_blob(self, *, database_key: "str", blob_path: "str") -> "None": - """Delete DataUpdater blob. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key - blob_path: str - Blob path to a single blob (including its name). - - Returns - ------- - None - """ - data = self._delete_data_updater_blob_with_http_info( - database_key, blob_path, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_data_updater_blob_with_http_info( - self, database_key: "str", blob_path: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_data_updater_blob" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_data_updater_blob'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'delete_data_updater_blob'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blobPath"] = params["blob_path"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def download_data_updater_blob(self, *, database_key: "str", blob_path: "str") -> "None": - """Retrieve DataUpdater blob contents by its path. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key - blob_path: str - Blob path to a single blob (including its name). - - Returns - ------- - None - """ - data = self._download_data_updater_blob_with_http_info( - database_key, blob_path, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _download_data_updater_blob_with_http_info( - self, database_key: "str", blob_path: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method download_data_updater_blob" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'download_data_updater_blob'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'download_data_updater_blob'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blobPath"] = params["blob_path"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def upload_data_updater_blob( - self, - *, - database_key: "str", - blob_path: "str", - body: "Optional[BinaryIO | pathlib.Path]" = None, - ) -> "GsaBlobInfoDto": - """Store DataUpdater blob contents. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key - blob_path: str - Blob path to a single blob (including its name). - body: BinaryIO | pathlib.Path - - Returns - ------- - GsaBlobInfoDto - """ - data = self._upload_data_updater_blob_with_http_info( - database_key, blob_path, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _upload_data_updater_blob_with_http_info( - self, - database_key: "str", - blob_path: "str", - body: "Optional[BinaryIO | pathlib.Path]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method upload_data_updater_blob" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'upload_data_updater_blob'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'upload_data_updater_blob'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blobPath"] = params["blob_path"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/octet-stream", "application/zip"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaBlobInfoDto", - } - - return self.api_client.call_api( - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}", - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_api.py index c32ea737..5b4c7f8b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_api.py @@ -63,10 +63,8 @@ def append_values_for_discrete_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendDiscreteValues Returns @@ -187,12 +185,9 @@ def append_values_for_discrete_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendDiscreteValues Returns @@ -326,10 +321,8 @@ def append_values_for_point_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendPointValues Returns @@ -450,12 +443,9 @@ def append_values_for_point_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendPointValues Returns @@ -590,10 +580,8 @@ def delete_cell_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str @@ -727,12 +715,9 @@ def delete_cell_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str @@ -869,10 +854,8 @@ def delete_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -975,12 +958,9 @@ def delete_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -1103,14 +1083,12 @@ def export_binary_data_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -1250,16 +1228,13 @@ def export_binary_data_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -1409,15 +1384,13 @@ def export_binary_data_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -1568,17 +1541,14 @@ def export_binary_data_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -1739,16 +1709,14 @@ def export_cell_binary_data_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -1910,18 +1878,15 @@ def export_cell_binary_data_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -2093,17 +2058,15 @@ def export_cell_binary_data_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -2276,19 +2239,16 @@ def export_cell_binary_data_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. max_width: int max_height: int @@ -2467,16 +2427,14 @@ def get_cell_datum_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -2621,18 +2579,15 @@ def get_cell_datum_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -2787,17 +2742,15 @@ def get_cell_datum_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -2953,19 +2906,16 @@ def get_cell_datum_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -3129,14 +3079,12 @@ def get_datum_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. filter_empty_cells: bool filter_empty_rows: bool @@ -3273,16 +3221,13 @@ def get_datum_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. filter_empty_cells: bool filter_empty_rows: bool @@ -3429,15 +3374,13 @@ def get_datum_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. filter_empty_cells: bool filter_empty_rows: bool @@ -3585,17 +3528,14 @@ def get_datum_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. filter_empty_cells: bool filter_empty_rows: bool @@ -3750,10 +3690,8 @@ def set_cell_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str body: GsaSetDatum @@ -3902,12 +3840,9 @@ def set_cell_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str body: GsaSetDatum @@ -4068,10 +4003,8 @@ def set_cell_file_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str file: BinaryIO | pathlib.Path @@ -4239,12 +4172,9 @@ def set_cell_file_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str file: BinaryIO | pathlib.Path @@ -4418,10 +4348,8 @@ def set_cell_picture_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str picture: BinaryIO | pathlib.Path @@ -4569,12 +4497,9 @@ def set_cell_picture_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str picture: BinaryIO | pathlib.Path @@ -4729,10 +4654,8 @@ def set_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaSetDatum Returns @@ -4854,12 +4777,9 @@ def set_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaSetDatum Returns @@ -4989,10 +4909,8 @@ def set_datum_not_applicable( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -5095,12 +5013,9 @@ def set_datum_not_applicable_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -5223,10 +5138,8 @@ def set_file_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) file: BinaryIO | pathlib.Path description: str target: str @@ -5370,12 +5283,9 @@ def set_file_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) file: BinaryIO | pathlib.Path description: str target: str @@ -5525,10 +5435,8 @@ def set_picture_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) picture: BinaryIO | pathlib.Path Returns @@ -5648,12 +5556,9 @@ def set_picture_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) picture: BinaryIO | pathlib.Path Returns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_export_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_export_api.py index a08379fd..07a3478c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_export_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_export_api.py @@ -63,12 +63,11 @@ def export_data( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaDataExportRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_updater_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_updater_api.py deleted file mode 100644 index 54cb85b3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/data_updater_api.py +++ /dev/null @@ -1,1580 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class DataUpdaterApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def apply_update(self, *, database_key: "str", update_token_guid: "str") -> "str": - """Start an apply job for a given update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - str - """ - data = self._apply_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _apply_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method apply_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'apply_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'apply_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:apply", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def create_or_update_project( - self, - *, - database_key: "str", - project_id: "str", - body: "Optional[GsaDataUpdaterProject]" = None, - ) -> "None": - """Creates a new project or updates an existing one. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - project_id: str - body: GsaDataUpdaterProject - - Returns - ------- - None - """ - data = self._create_or_update_project_with_http_info( - database_key, project_id, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_or_update_project_with_http_info( - self, - database_key: "str", - project_id: "str", - body: "Optional[GsaDataUpdaterProject]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "project_id", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_or_update_project" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_or_update_project'" - ) - # verify the required parameter "project_id" is set - if "project_id" not in params or params["project_id"] is None: - raise ValueError( - "Missing the required parameter 'project_id' when calling 'create_or_update_project'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "project_id" in params and project_id is not None: - path_params["project-id"] = params["project_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}/{project-id}", - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def create_update( - self, - *, - database_key: "str", - project_id: "str", - body: "Optional[GsaCreateDataUpdateServerApiRequest]" = None, - ) -> "str": - """Creates and queues a new 'create update' job for a given project. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - project_id: str - body: GsaCreateDataUpdateServerApiRequest - - Returns - ------- - str - """ - data = self._create_update_with_http_info( - database_key, project_id, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_update_with_http_info( - self, - database_key: "str", - project_id: "str", - body: "Optional[GsaCreateDataUpdateServerApiRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "project_id", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_update'" - ) - # verify the required parameter "project_id" is set - if "project_id" not in params or params["project_id"] is None: - raise ValueError( - "Missing the required parameter 'project_id' when calling 'create_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "project_id" in params and project_id is not None: - path_params["project-id"] = params["project_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}/{project-id}", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_completed_data_updater_job(self, *, job_id: "str") -> "None": - """Delete a specific job. Only valid if job is in one of the completed states. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - job_id: str - - Returns - ------- - None - """ - data = self._delete_completed_data_updater_job_with_http_info( - job_id, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_completed_data_updater_job_with_http_info( - self, job_id: "str", **kwargs: Any - ) -> Any: - all_params = ["job_id", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_completed_data_updater_job" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "job_id" is set - if "job_id" not in params or params["job_id"] is None: - raise ValueError( - "Missing the required parameter 'job_id' when calling 'delete_completed_data_updater_job'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "job_id" in params and job_id is not None: - path_params["job-id"] = params["job_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/jobs/{job-id}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_project(self, *, database_key: "str", project_id: "str") -> "None": - """Deletes a project. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - project_id: str - - Returns - ------- - None - """ - data = self._delete_project_with_http_info( - database_key, project_id, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_project_with_http_info( - self, database_key: "str", project_id: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "project_id", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_project" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_project'" - ) - # verify the required parameter "project_id" is set - if "project_id" not in params or params["project_id"] is None: - raise ValueError( - "Missing the required parameter 'project_id' when calling 'delete_project'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "project_id" in params and project_id is not None: - path_params["project-id"] = params["project_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}/{project-id}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_update(self, *, database_key: "str", update_token_guid: "str") -> "None": - """Deletes an update if it is in a deletable state. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - None - """ - data = self._delete_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'delete_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def dry_run_update(self, *, database_key: "str", update_token_guid: "str") -> "str": - """Start a dry run job for a given update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - str - """ - data = self._dry_run_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _dry_run_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method dry_run_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'dry_run_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'dry_run_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:dry-run", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def fill_in_fallback_identifiers(self, *, database_key: "str") -> "None": - """Starts a long-running operation of generating fallback identifiers for a given database. Returns immediately. User is expected to watch MI Server logs for progress and errors. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - None - """ - data = self._fill_in_fallback_identifiers_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _fill_in_fallback_identifiers_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method fill_in_fallback_identifiers" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'fill_in_fallback_identifiers'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}:fill-in-fallback-ids", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def finalize_update(self, *, database_key: "str", update_token_guid: "str") -> "str": - """Start a finalize job for a given update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - str - """ - data = self._finalize_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _finalize_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method finalize_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'finalize_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'finalize_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:finalize", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_all_updates(self) -> "list[GsaDataUpdate]": - """get_all_updates - - This method makes a synchronous HTTP request. - - Returns - ------- - list[GsaDataUpdate] - """ - data = self._get_all_updates_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_all_updates_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_updates" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdate]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_data_updater_job(self, *, job_id: "str") -> "GsaDataUpdaterJob": - """Get a specific job. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - job_id: str - - Returns - ------- - GsaDataUpdaterJob - """ - data = self._get_data_updater_job_with_http_info(job_id, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_data_updater_job_with_http_info(self, job_id: "str", **kwargs: Any) -> Any: - all_params = ["job_id", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_data_updater_job" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "job_id" is set - if "job_id" not in params or params["job_id"] is None: - raise ValueError( - "Missing the required parameter 'job_id' when calling 'get_data_updater_job'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "job_id" in params and job_id is not None: - path_params["job-id"] = params["job_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdaterJob", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/jobs/{job-id}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_data_updater_jobs(self) -> "list[GsaDataUpdaterJob]": - """Get all jobs. (pertaining to databases that the user is administrator of) - - This method makes a synchronous HTTP request. - - Returns - ------- - list[GsaDataUpdaterJob] - """ - data = self._get_data_updater_jobs_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_data_updater_jobs_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_data_updater_jobs" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdaterJob]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/jobs", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_projects_for_database(self, *, database_key: "str") -> "list[GsaDataUpdaterProject]": - """get_projects_for_database - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - list[GsaDataUpdaterProject] - """ - data = self._get_projects_for_database_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_projects_for_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_projects_for_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_projects_for_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdaterProject]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_selection(self, *, database_key: "str", profile_id: "str") -> "GsaSelection": - """Retrieves selection based on profile and database key - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - profile_id: str - - Returns - ------- - GsaSelection - """ - data = self._get_selection_with_http_info( - database_key, profile_id, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_selection_with_http_info( - self, database_key: "str", profile_id: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "profile_id", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_selection" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_selection'" - ) - # verify the required parameter "profile_id" is set - if "profile_id" not in params or params["profile_id"] is None: - raise ValueError( - "Missing the required parameter 'profile_id' when calling 'get_selection'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "profile_id" in params and profile_id is not None: - path_params["profile-id"] = params["profile_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSelection", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/profiles/{profile-id}/selections/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_update(self, *, database_key: "str", update_token_guid: "str") -> "GsaDataUpdate": - """Get registered update. Retrieves info about an update that was registered by the Apply side. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - GsaDataUpdate - """ - data = self._get_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_update") - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'get_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdate", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_update_header( - self, *, database_key: "str", update_token_guid: "str" - ) -> "GsaDataUpdateHeader": - """Get update header from update file. Works even for unregistered updates (i.e. ones just created by the Create side). - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - GsaDataUpdateHeader - """ - data = self._get_update_header_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_update_header_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_update_header" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_update_header'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'get_update_header'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdateHeader", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}/header", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_updates_for_database(self, *, database_key: "str") -> "list[GsaDataUpdate]": - """get_updates_for_database - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - list[GsaDataUpdate] - """ - data = self._get_updates_for_database_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_updates_for_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_updates_for_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_updates_for_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdate]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def register_update( - self, *, database_key: "str", body: "Optional[GsaRegisterUpdateRequest]" = None - ) -> "GsaDataUpdateToken": - """Register an update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaRegisterUpdateRequest - - Returns - ------- - GsaDataUpdateToken - """ - data = self._register_update_with_http_info(database_key, body, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _register_update_with_http_info( - self, database_key: "str", body: "Optional[GsaRegisterUpdateRequest]" = None, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method register_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'register_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdateToken", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/database_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/database_api.py index 7b88cde6..df2dffc3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/database_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/database_api.py @@ -825,7 +825,7 @@ def _generate_schema_from_table_name_with_http_info( def get_search_index_status( self, *, database_key: "str", include_errors: "Optional[bool]" = None ) -> "GsaSearchIndexStatus | None": - """GetSearch Index Status for a given database + """Get Search Index Status for a given database This method makes a synchronous HTTP request. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/find_similar_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/find_similar_api.py deleted file mode 100644 index d892ab09..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/find_similar_api.py +++ /dev/null @@ -1,667 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class FindSimilarApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def cancel_find_similar_run( - self, *, operation_identifier: "str" - ) -> "GsaLongRunningOperation | GsaLongRunningOperationInvalidStatusException | None": - """Requests cancellation of a long-running operation for calculating similarity scores. Cancellation will only happen when the operation is pending or in progress, and is not guaranteed - it is a best-effort attempt to stop the operation early. The long-running operation status will be set to awaitingCancellation; then to cancelled if cancellation is successful. If the long-running operation has already completed (succeeded or failed), an error will be returned. If the long-running operation has already been cancelled, the status will remain as is (awaitingCancellation or cancelled). - - This method makes a synchronous HTTP request. - - Parameters - ---------- - operation_identifier: str - - Returns - ------- - GsaLongRunningOperation | GsaLongRunningOperationInvalidStatusException | None - """ - data = self._cancel_find_similar_run_with_http_info( - operation_identifier, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _cancel_find_similar_run_with_http_info( - self, operation_identifier: "str", **kwargs: Any - ) -> Any: - all_params = [ - "operation_identifier", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method cancel_find_similar_run" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "operation_identifier" is set - if "operation_identifier" not in params or params["operation_identifier"] is None: - raise ValueError( - "Missing the required parameter 'operation_identifier' when calling 'cancel_find_similar_run'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "operation_identifier" in params and operation_identifier is not None: - path_params["operation-identifier"] = params["operation_identifier"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLongRunningOperation", - 422: "GsaLongRunningOperationInvalidStatusException", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/find-similar/{operation-identifier}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def find_similar( - self, - *, - database_key: "str", - table_guid: "str", - record_guid: "str", - body: "Optional[GsaFindSimilarRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaLongRunningOperation": - """Gets the long-running operation for running the finds similar records calculation in a given database and table for a given record - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_guid: str - body: GsaFindSimilarRequest - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - - Returns - ------- - GsaLongRunningOperation - """ - data = self._find_similar_with_http_info( - database_key, - table_guid, - record_guid, - body, - x_ansys_vc_mode, - mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _find_similar_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_guid: "str", - body: "Optional[GsaFindSimilarRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_guid", - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method find_similar" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'find_similar'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'find_similar'" - ) - # verify the required parameter "record_guid" is set - if "record_guid" not in params or params["record_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_guid' when calling 'find_similar'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_guid" in params and record_guid is not None: - path_params["record-guid"] = params["record_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLongRunningOperation", - } - - return self.api_client.call_api( - "/v1alpha/find-similar/databases/{database-key}/tables/{table-guid}/record/{record-guid}", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_find_similar_operation_full_result( - self, *, find_similar_identifier: "str" - ) -> "GsaGetFindSimilarResultsResponse | None": - """Returns the find similar results for a given find similar identifier. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - find_similar_identifier: str - - Returns - ------- - GsaGetFindSimilarResultsResponse | None - """ - data = self._get_find_similar_operation_full_result_with_http_info( - find_similar_identifier, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_find_similar_operation_full_result_with_http_info( - self, find_similar_identifier: "str", **kwargs: Any - ) -> Any: - all_params = [ - "find_similar_identifier", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_find_similar_operation_full_result" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "find_similar_identifier" is set - if "find_similar_identifier" not in params or params["find_similar_identifier"] is None: - raise ValueError( - "Missing the required parameter 'find_similar_identifier' when calling 'get_find_similar_operation_full_result'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "find_similar_identifier" in params and find_similar_identifier is not None: - path_params["find-similar-identifier"] = params["find_similar_identifier"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaGetFindSimilarResultsResponse", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/find-similar/{find-similar-identifier}/full-results", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_find_similar_operation_result( - self, *, operation_identifier: "str" - ) -> "GsaFindSimilarResponse | None": - """Gets the result of a long-running operation running a find similar calculation. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - operation_identifier: str - - Returns - ------- - GsaFindSimilarResponse | None - """ - data = self._get_find_similar_operation_result_with_http_info( - operation_identifier, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_find_similar_operation_result_with_http_info( - self, operation_identifier: "str", **kwargs: Any - ) -> Any: - all_params = [ - "operation_identifier", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_find_similar_operation_result" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "operation_identifier" is set - if "operation_identifier" not in params or params["operation_identifier"] is None: - raise ValueError( - "Missing the required parameter 'operation_identifier' when calling 'get_find_similar_operation_result'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "operation_identifier" in params and operation_identifier is not None: - path_params["operation-identifier"] = params["operation_identifier"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFindSimilarResponse", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/find-similar/{operation-identifier}/result", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_run_find_similar_operation( - self, - *, - operation_identifier: "str", - include: "Optional[list[GsaLongRunningOperationInclude]]" = None, - ) -> "GsaLongRunningOperation | None": - """Gets the long-running operation for calculating the find similar results. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - operation_identifier: str - include: list[GsaLongRunningOperationInclude] - - Returns - ------- - GsaLongRunningOperation | None - """ - data = self._get_run_find_similar_operation_with_http_info( - operation_identifier, include, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_run_find_similar_operation_with_http_info( - self, - operation_identifier: "str", - include: "Optional[list[GsaLongRunningOperationInclude]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "operation_identifier", - "include", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_run_find_similar_operation" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "operation_identifier" is set - if "operation_identifier" not in params or params["operation_identifier"] is None: - raise ValueError( - "Missing the required parameter 'operation_identifier' when calling 'get_run_find_similar_operation'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "operation_identifier" in params and operation_identifier is not None: - path_params["operation-identifier"] = params["operation_identifier"] - - query_params: list[Any] = [] - if "include" in params and include is not None: - query_params.append(("include", params["include"])) - collection_formats["include"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLongRunningOperation", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/find-similar/{operation-identifier}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def integration_find_similar( - self, - *, - schema: "str", - database_key: "str", - record_guid: "str", - body: "Optional[GsaFindSimilarRequest]" = None, - ) -> "GsaLongRunningOperation | None": - """Gets the long-running operation for running a find similar calculation against an integration schema. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - schema: str - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - record_guid: str - body: GsaFindSimilarRequest - - Returns - ------- - GsaLongRunningOperation | None - """ - data = self._integration_find_similar_with_http_info( - schema, database_key, record_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _integration_find_similar_with_http_info( - self, - schema: "str", - database_key: "str", - record_guid: "str", - body: "Optional[GsaFindSimilarRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "schema", - "database_key", - "record_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method integration_find_similar" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "schema" is set - if "schema" not in params or params["schema"] is None: - raise ValueError( - "Missing the required parameter 'schema' when calling 'integration_find_similar'" - ) - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'integration_find_similar'" - ) - # verify the required parameter "record_guid" is set - if "record_guid" not in params or params["record_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_guid' when calling 'integration_find_similar'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "schema" in params and schema is not None: - path_params["schema"] = params["schema"] - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "record_guid" in params and record_guid is not None: - path_params["record-guid"] = params["record_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLongRunningOperation", - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/find-similar/integration-schemas/{schema}/databases/{database-key}/record/{record-guid}", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/graph_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/graph_api.py index 7b2344d8..87d44f99 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/graph_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/graph_api.py @@ -66,16 +66,14 @@ def evaluate_graph_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -221,18 +219,15 @@ def evaluate_graph_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -386,15 +381,13 @@ def evaluate_graph_value_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -529,17 +522,14 @@ def evaluate_graph_value_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -682,14 +672,12 @@ def get_graph_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -813,16 +801,13 @@ def get_graph_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -956,15 +941,13 @@ def get_graph_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -1099,17 +1082,14 @@ def get_graph_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/help_location_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/help_location_api.py index 008f9a57..c5ceaea8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/help_location_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/help_location_api.py @@ -51,7 +51,6 @@ class HelpLocationApi(ApiBase): def get_help_url(self, *, help_key: "str") -> "None": """Returns the URL that the given helpKey maps to. - Honours the request's `Accept` header: if the client accepts `text/plain`, the raw URL is returned as plain text; otherwise (including the default `application/json`) the URL is returned as a JSON-encoded string, e.g. `\"https://example.com/help\"`. This method makes a synchronous HTTP request. Parameters diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/identities_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/identities_api.py index 480f7f8b..ce7f6312 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/identities_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/identities_api.py @@ -54,7 +54,7 @@ def translate_guids_to_identities( body: "Optional[GsaTranslateGuidsToIdentitiesRequest]" = None, x_ansys_vc_mode: "Optional[str]" = None, mode: "Optional[str]" = None, - ) -> "GsaTranslateBetweenGuidsAndIdentitiesResponse | None": + ) -> "GsaTranslateGuidsToIdentitiesResponse | None": """For internal use only. Translates guids to identities. This method makes a synchronous HTTP request. @@ -63,13 +63,13 @@ def translate_guids_to_identities( ---------- body: GsaTranslateGuidsToIdentitiesRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- - GsaTranslateBetweenGuidsAndIdentitiesResponse | None + GsaTranslateGuidsToIdentitiesResponse | None """ data = self._translate_guids_to_identities_with_http_info( body, x_ansys_vc_mode, mode, _return_http_data_only=True @@ -128,7 +128,7 @@ def _translate_guids_to_identities_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaTranslateBetweenGuidsAndIdentitiesResponse", + 200: "GsaTranslateGuidsToIdentitiesResponse", 400: None, } @@ -147,103 +147,3 @@ def _translate_guids_to_identities_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def translate_identities_to_guids( - self, - *, - body: "Optional[GsaTranslateIdentitiesToGuidsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaTranslateBetweenGuidsAndIdentitiesResponse | None": - """For internal use only. Translates identities to GUIDs. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaTranslateIdentitiesToGuidsRequest - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - - Returns - ------- - GsaTranslateBetweenGuidsAndIdentitiesResponse | None - """ - data = self._translate_identities_to_guids_with_http_info( - body, x_ansys_vc_mode, mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _translate_identities_to_guids_with_http_info( - self, - body: "Optional[GsaTranslateIdentitiesToGuidsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method translate_identities_to_guids" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaTranslateBetweenGuidsAndIdentitiesResponse", - 400: None, - } - - return self.api_client.call_api( - "/v1alpha/guids", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/integration_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/integration_api.py index fe625ff7..54c02a9d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/integration_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/integration_api.py @@ -460,7 +460,6 @@ def schema_table_mappings( ---------- schema: str database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_identity: int Returns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/license_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/license_api.py index 8e60dd6d..2d24e13f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/license_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/license_api.py @@ -124,72 +124,6 @@ def _checkout_app_license_with_http_info( response_type_map=response_type_map, ) - def ensure_advanced_selection_license_available( - self, - ) -> "MicrosoftAspNetCoreMvcObjectResult | None": - """Determines whether the requesting user has an Advanced Selection license available. If a user has a license available this will be checked out. - - This method makes a synchronous HTTP request. - - Returns - ------- - MicrosoftAspNetCoreMvcObjectResult | None - """ - data = self._ensure_advanced_selection_license_available_with_http_info( - _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _ensure_advanced_selection_license_available_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method ensure_advanced_selection_license_available" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 403: "MicrosoftAspNetCoreMvcObjectResult", - } - - return self.api_client.call_api( - "/v1alpha/license/advanced-selection-license:ensure-checked-out", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def ensure_user_license_available(self) -> "MicrosoftAspNetCoreMvcObjectResult | None": """Either checks out a user license for the requesting user, or returns an error response if no such license is available. This method is a no-op because it relies on license check to happen within Granta.Server.Api.Auth.UserContextFilter @@ -312,74 +246,3 @@ def _get_server_license_with_http_info(self, **kwargs: Any) -> Any: collection_formats=collection_formats, response_type_map=response_type_map, ) - - def remove_user_licenses(self, *, user_name: "str") -> "None": - """Removes all checked-out user and database licenses for the specified user. Restricted to MI System Administrators. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - user_name: str - The username whose licenses should be removed. - - Returns - ------- - None - """ - data = self._remove_user_licenses_with_http_info(user_name, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _remove_user_licenses_with_http_info(self, user_name: "str", **kwargs: Any) -> Any: - all_params = ["user_name", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method remove_user_licenses" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "user_name" is set - if "user_name" not in params or params["user_name"] is None: - raise ValueError( - "Missing the required parameter 'user_name' when calling 'remove_user_licenses'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "user_name" in params and user_name is not None: - path_params["userName"] = params["user_name"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 204: None, - 400: None, - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/license/users/{userName}/licenses", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/metrics_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/metrics_api.py index 1aaf20db..ce8801e2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/metrics_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/metrics_api.py @@ -56,7 +56,6 @@ def get_jobs_summary(self, *, start: "Optional[str]" = None) -> "GsaGetJobsSumma Parameters ---------- start: str - The number of System.DateTime.Ticks that represent the UTC start time. Returns ------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___quality_systems_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/permission_based_access_control_api.py similarity index 67% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___quality_systems_api.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/permission_based_access_control_api.py index 14ce8065..556e6bb7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___quality_systems_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/permission_based_access_control_api.py @@ -41,41 +41,36 @@ from ..models import * -class SchemaQualitySystemsApi(ApiBase): +class PermissionBasedAccessControlApi(ApiBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen """ - def create_quality_system( - self, *, database_key: "str", body: "Optional[GsaCreateQualitySystem]" = None - ) -> "GsaQualitySystem | GsaQualitySystemCreationException | None": - """Create a new quality system. + def get_permission_categories( + self, *, database_key: "str" + ) -> "GsaPermissionCategoriesInfo | None": + """Get all permission-based access control categories for the specified database. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaCreateQualitySystem Returns ------- - GsaQualitySystem | GsaQualitySystemCreationException | None + GsaPermissionCategoriesInfo | None """ - data = self._create_quality_system_with_http_info( - database_key, body, _return_http_data_only=True + data = self._get_permission_categories_with_http_info( + database_key, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _create_quality_system_with_http_info( - self, database_key: "str", body: "Optional[GsaCreateQualitySystem]" = None, **kwargs: Any - ) -> Any: + def _get_permission_categories_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: all_params = [ "database_key", - "body", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -85,14 +80,14 @@ def _create_quality_system_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_quality_system" + f"Got an unexpected keyword argument '{key}' to method get_permission_categories" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_quality_system'" + "Missing the required parameter 'database_key' when calling 'get_permission_categories'" ) collection_formats: dict[str, Any] = {} @@ -109,26 +104,19 @@ def _create_quality_system_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - if "body" in params and body is not None: - body_params = params["body"] # HTTP header 'Accept' header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - response_type_map: dict[int, Optional[str]] = { - 201: "GsaQualitySystem", - 400: "GsaQualitySystemCreationException", + 200: "GsaPermissionCategoriesInfo", 403: None, 404: None, + 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/quality-systems", - "POST", + "/v1alpha/databases/{database-key}/permission-categories", + "GET", path_params, query_params, header_params, @@ -142,34 +130,33 @@ def _create_quality_system_with_http_info( response_type_map=response_type_map, ) - def delete_quality_system( - self, *, database_key: "str", quality_system_guid: "str" - ) -> "GsaQualitySystemDeletionException | None": - """Delete a quality system. + def get_permission_category( + self, *, database_key: "str", category_guid: "str" + ) -> "GsaPermissionCategory | None": + """Get a permission-based access control category with a specified guid. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - quality_system_guid: str + category_guid: str Returns ------- - GsaQualitySystemDeletionException | None + GsaPermissionCategory | None """ - data = self._delete_quality_system_with_http_info( - database_key, quality_system_guid, _return_http_data_only=True + data = self._get_permission_category_with_http_info( + database_key, category_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _delete_quality_system_with_http_info( - self, database_key: "str", quality_system_guid: "str", **kwargs: Any + def _get_permission_category_with_http_info( + self, database_key: "str", category_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", - "quality_system_guid", + "category_guid", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -179,19 +166,19 @@ def _delete_quality_system_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_quality_system" + f"Got an unexpected keyword argument '{key}' to method get_permission_category" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_quality_system'" + "Missing the required parameter 'database_key' when calling 'get_permission_category'" ) - # verify the required parameter "quality_system_guid" is set - if "quality_system_guid" not in params or params["quality_system_guid"] is None: + # verify the required parameter "category_guid" is set + if "category_guid" not in params or params["category_guid"] is None: raise ValueError( - "Missing the required parameter 'quality_system_guid' when calling 'delete_quality_system'" + "Missing the required parameter 'category_guid' when calling 'get_permission_category'" ) collection_formats: dict[str, Any] = {} @@ -199,8 +186,8 @@ def _delete_quality_system_with_http_info( path_params: dict[str, Any] = {} if "database_key" in params and database_key is not None: path_params["database-key"] = params["database_key"] - if "quality_system_guid" in params and quality_system_guid is not None: - path_params["quality-system-guid"] = params["quality_system_guid"] + if "category_guid" in params and category_guid is not None: + path_params["category-guid"] = params["category_guid"] query_params: list[Any] = [] @@ -214,15 +201,15 @@ def _delete_quality_system_with_http_info( header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaQualitySystemDeletionException", - 200: None, + 200: "GsaPermissionCategory", 403: None, 404: None, + 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/quality-systems/{quality-system-guid}", - "DELETE", + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", + "GET", path_params, query_params, header_params, @@ -236,34 +223,35 @@ def _delete_quality_system_with_http_info( response_type_map=response_type_map, ) - def get_quality_system( - self, *, database_key: "str", quality_system_guid: "str" - ) -> "GsaQualitySystem | None": - """Get individual quality system + def get_permission_in_category( + self, *, database_key: "str", category_guid: "str", permission_guid: "str" + ) -> "GsaPermission | None": + """Get a permission-based access control permission with a given guid in the specified category. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - quality_system_guid: str + category_guid: str + permission_guid: str Returns ------- - GsaQualitySystem | None + GsaPermission | None """ - data = self._get_quality_system_with_http_info( - database_key, quality_system_guid, _return_http_data_only=True + data = self._get_permission_in_category_with_http_info( + database_key, category_guid, permission_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _get_quality_system_with_http_info( - self, database_key: "str", quality_system_guid: "str", **kwargs: Any + def _get_permission_in_category_with_http_info( + self, database_key: "str", category_guid: "str", permission_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", - "quality_system_guid", + "category_guid", + "permission_guid", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -273,19 +261,24 @@ def _get_quality_system_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_quality_system" + f"Got an unexpected keyword argument '{key}' to method get_permission_in_category" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_quality_system'" + "Missing the required parameter 'database_key' when calling 'get_permission_in_category'" + ) + # verify the required parameter "category_guid" is set + if "category_guid" not in params or params["category_guid"] is None: + raise ValueError( + "Missing the required parameter 'category_guid' when calling 'get_permission_in_category'" ) - # verify the required parameter "quality_system_guid" is set - if "quality_system_guid" not in params or params["quality_system_guid"] is None: + # verify the required parameter "permission_guid" is set + if "permission_guid" not in params or params["permission_guid"] is None: raise ValueError( - "Missing the required parameter 'quality_system_guid' when calling 'get_quality_system'" + "Missing the required parameter 'permission_guid' when calling 'get_permission_in_category'" ) collection_formats: dict[str, Any] = {} @@ -293,8 +286,10 @@ def _get_quality_system_with_http_info( path_params: dict[str, Any] = {} if "database_key" in params and database_key is not None: path_params["database-key"] = params["database_key"] - if "quality_system_guid" in params and quality_system_guid is not None: - path_params["quality-system-guid"] = params["quality_system_guid"] + if "category_guid" in params and category_guid is not None: + path_params["category-guid"] = params["category_guid"] + if "permission_guid" in params and permission_guid is not None: + path_params["permission-guid"] = params["permission_guid"] query_params: list[Any] = [] @@ -308,12 +303,14 @@ def _get_quality_system_with_http_info( header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaQualitySystem", + 200: "GsaPermission", + 403: None, 404: None, + 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/quality-systems/{quality-system-guid}", + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", "GET", path_params, query_params, @@ -328,26 +325,33 @@ def _get_quality_system_with_http_info( response_type_map=response_type_map, ) - def get_quality_systems(self, *, database_key: "str") -> "GsaQualitySystemsInfo | None": - """Get all quality systems + def get_permissions_in_category( + self, *, database_key: "str", category_guid: "str" + ) -> "GsaPermissionsInfo | None": + """Get all permission-based access control permissions for the specified category. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) + category_guid: str Returns ------- - GsaQualitySystemsInfo | None + GsaPermissionsInfo | None """ - data = self._get_quality_systems_with_http_info(database_key, _return_http_data_only=True) + data = self._get_permissions_in_category_with_http_info( + database_key, category_guid, _return_http_data_only=True + ) return data # type: ignore[no-any-return] - def _get_quality_systems_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: + def _get_permissions_in_category_with_http_info( + self, database_key: "str", category_guid: "str", **kwargs: Any + ) -> Any: all_params = [ "database_key", + "category_guid", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -357,14 +361,19 @@ def _get_quality_systems_with_http_info(self, database_key: "str", **kwargs: Any for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_quality_systems" + f"Got an unexpected keyword argument '{key}' to method get_permissions_in_category" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_quality_systems'" + "Missing the required parameter 'database_key' when calling 'get_permissions_in_category'" + ) + # verify the required parameter "category_guid" is set + if "category_guid" not in params or params["category_guid"] is None: + raise ValueError( + "Missing the required parameter 'category_guid' when calling 'get_permissions_in_category'" ) collection_formats: dict[str, Any] = {} @@ -372,6 +381,8 @@ def _get_quality_systems_with_http_info(self, database_key: "str", **kwargs: Any path_params: dict[str, Any] = {} if "database_key" in params and database_key is not None: path_params["database-key"] = params["database_key"] + if "category_guid" in params and category_guid is not None: + path_params["category-guid"] = params["category_guid"] query_params: list[Any] = [] @@ -385,12 +396,14 @@ def _get_quality_systems_with_http_info(self, database_key: "str", **kwargs: Any header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaQualitySystemsInfo", + 200: "GsaPermissionsInfo", + 403: None, 404: None, + 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/quality-systems", + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions", "GET", path_params, query_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/record_links_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/record_links_api.py deleted file mode 100644 index b3f38cc9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/record_links_api.py +++ /dev/null @@ -1,663 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class RecordLinksApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_link_results_for_group_for_history( - self, - *, - database_key: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for the latest version of a given record history for a given record link group - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - record_history_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_history_with_http_info( - database_key, - record_history_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_history_with_http_info( - self, - database_key: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "record_history_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_history" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_history'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_history'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_history'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_history'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_link_results_for_group_for_history_from_table( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for the latest version of a given record history in a given table for a given record link group. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_history_from_table_with_http_info( - database_key, - table_guid, - record_history_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_history_from_table_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_history_from_table" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_history_from_table'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_link_results_for_group_for_version( - self, - *, - database_key: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for a given record version of a given record history for a given record link group - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - record_history_guid: str - record_version_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_version_with_http_info( - database_key, - record_history_guid, - record_version_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_version_with_http_info( - self, - database_key: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "record_history_guid", - "record_version_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_version" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_version'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_link_results_for_group_for_version_from_table( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for a given record version in a given table and record history for a given record link group - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_version_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_version_from_table_with_http_info( - database_key, - table_guid, - record_history_guid, - record_version_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_version_from_table_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_version_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_version_from_table" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_version_from_table'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_histories_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_histories_api.py index 464fbe7b..5b6e332d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_histories_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_histories_api.py @@ -62,7 +62,6 @@ def copy_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str body: GsaCopyRecordHistory @@ -174,9 +173,7 @@ def copy_record_history_in_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str body: GsaCopyRecordHistory @@ -296,9 +293,7 @@ def create_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateRecordHistory Returns @@ -409,12 +404,11 @@ def get_latest_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -522,14 +516,12 @@ def get_latest_record_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -650,12 +642,11 @@ def get_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -763,14 +754,12 @@ def get_record_history_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -890,7 +879,6 @@ def move_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str body: GsaMoveRecordHistory @@ -1002,9 +990,7 @@ def move_record_history_in_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str body: GsaMoveRecordHistory diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_versions_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_versions_api.py index 9740e33f..f85b399d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_versions_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/records___record_versions_api.py @@ -63,9 +63,7 @@ def delete_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str @@ -187,9 +185,7 @@ def get_modifiable_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str @@ -316,15 +312,13 @@ def get_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -440,133 +434,6 @@ def _get_record_version_with_http_info( response_type_map=response_type_map, ) - def get_record_version_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given record version. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_version_guid: str - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_record_version_permission_category_access_controls_with_http_info( - database_key, - table_guid, - record_history_guid, - record_version_guid, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_record_version_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_version_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_record_version_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_record_version_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'get_record_version_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def release_record_version( self, *, @@ -582,9 +449,7 @@ def release_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str @@ -694,147 +559,6 @@ def _release_record_version_with_http_info( response_type_map=response_type_map, ) - def update_record_version_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given record version. Sets the access control for the given permissions. - - Can also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation) - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_version_guid: str - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_record_version_permission_category_access_controls_with_http_info( - database_key, - table_guid, - record_history_guid, - record_version_guid, - body, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _update_record_version_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_version_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_record_version_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_record_version_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'update_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'update_record_version_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def withdraw_record_version( self, *, @@ -850,9 +574,7 @@ def withdraw_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___attributes_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___attributes_api.py index 095819ce..db53c623 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___attributes_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___attributes_api.py @@ -58,9 +58,7 @@ def create_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateAttribute Returns @@ -171,11 +169,8 @@ def create_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaCreateAttribute Returns @@ -290,11 +285,8 @@ def delete_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -395,9 +387,7 @@ def delete_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str Returns @@ -505,15 +495,12 @@ def get_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -619,111 +606,6 @@ def _get_attribute_with_http_info( response_type_map=response_type_map, ) - def get_attribute_permission_category_access_controls( - self, *, database_key: "str", table_guid: "str", attribute_guid: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given attribute. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_attribute_permission_category_access_controls_with_http_info( - database_key, table_guid, attribute_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_attribute_permission_category_access_controls_with_http_info( - self, database_key: "str", table_guid: "str", attribute_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "attribute_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_attribute_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_attribute_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_attribute_permission_category_access_controls'" - ) - # verify the required parameter "attribute_guid" is set - if "attribute_guid" not in params or params["attribute_guid"] is None: - raise ValueError( - "Missing the required parameter 'attribute_guid' when calling 'get_attribute_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "attribute_guid" in params and attribute_guid is not None: - path_params["attribute-guid"] = params["attribute_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_attributes( self, *, @@ -739,13 +621,11 @@ def get_attributes( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -853,15 +733,12 @@ def get_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -967,110 +844,6 @@ def _get_meta_attribute_with_http_info( response_type_map=response_type_map, ) - def get_meta_attribute_permission_category_access_controls( - self, *, database_key: "str", table_guid: "str", meta_attribute_guid: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given meta-attribute. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - meta_attribute_guid: str - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_meta_attribute_permission_category_access_controls_with_http_info( - database_key, table_guid, meta_attribute_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_meta_attribute_permission_category_access_controls_with_http_info( - self, database_key: "str", table_guid: "str", meta_attribute_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "meta_attribute_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_meta_attribute_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_meta_attribute_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_meta_attribute_permission_category_access_controls'" - ) - # verify the required parameter "meta_attribute_guid" is set - if "meta_attribute_guid" not in params or params["meta_attribute_guid"] is None: - raise ValueError( - "Missing the required parameter 'meta_attribute_guid' when calling 'get_meta_attribute_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "meta_attribute_guid" in params and meta_attribute_guid is not None: - path_params["meta-attribute-guid"] = params["meta_attribute_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_meta_attributes( self, *, @@ -1086,13 +859,11 @@ def get_meta_attributes( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -1200,15 +971,12 @@ def get_meta_attributes_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -1330,14 +1098,12 @@ def query_attributes( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaQueryAttributesRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -1440,40 +1206,42 @@ def _query_attributes_with_http_info( response_type_map=response_type_map, ) - def query_attributes_in_database( + def query_meta_attributes( self, *, database_key: "str", + table_guid: "str", body: "Optional[GsaQueryAttributesRequest]" = None, x_ansys_vc_mode: "Optional[str]" = None, mode: "Optional[str]" = None, ) -> "GsaQueryAttributesInfo | None": - """Get attributes in database, populate the requested properties. Optionally filter the returned attributes. + """Get meta-attributes in table, populate the requested properties. Optionally filter the returned meta-attributes. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) + table_guid: str body: GsaQueryAttributesRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- GsaQueryAttributesInfo | None """ - data = self._query_attributes_in_database_with_http_info( - database_key, body, x_ansys_vc_mode, mode, _return_http_data_only=True + data = self._query_meta_attributes_with_http_info( + database_key, table_guid, body, x_ansys_vc_mode, mode, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _query_attributes_in_database_with_http_info( + def _query_meta_attributes_with_http_info( self, database_key: "str", + table_guid: "str", body: "Optional[GsaQueryAttributesRequest]" = None, x_ansys_vc_mode: "Optional[str]" = None, mode: "Optional[str]" = None, @@ -1481,6 +1249,7 @@ def _query_attributes_in_database_with_http_info( ) -> Any: all_params = [ "database_key", + "table_guid", "body", "x_ansys_vc_mode", "mode", @@ -1493,14 +1262,19 @@ def _query_attributes_in_database_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_attributes_in_database" + f"Got an unexpected keyword argument '{key}' to method query_meta_attributes" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_attributes_in_database'" + "Missing the required parameter 'database_key' when calling 'query_meta_attributes'" + ) + # verify the required parameter "table_guid" is set + if "table_guid" not in params or params["table_guid"] is None: + raise ValueError( + "Missing the required parameter 'table_guid' when calling 'query_meta_attributes'" ) collection_formats: dict[str, Any] = {} @@ -1508,6 +1282,8 @@ def _query_attributes_in_database_with_http_info( path_params: dict[str, Any] = {} if "database_key" in params and database_key is not None: path_params["database-key"] = params["database_key"] + if "table_guid" in params and table_guid is not None: + path_params["table-guid"] = params["table_guid"] query_params: list[Any] = [] if "mode" in params and mode is not None: @@ -1539,7 +1315,7 @@ def _query_attributes_in_database_with_http_info( } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/attributes:query", + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes:query", "POST", path_params, query_params, @@ -1554,44 +1330,51 @@ def _query_attributes_in_database_with_http_info( response_type_map=response_type_map, ) - def query_meta_attributes( + def query_meta_attributes_for_attribute( self, *, database_key: "str", table_guid: "str", + attribute_guid: "str", body: "Optional[GsaQueryAttributesRequest]" = None, x_ansys_vc_mode: "Optional[str]" = None, mode: "Optional[str]" = None, ) -> "GsaQueryAttributesInfo | None": - """Get meta-attributes in table, populate the requested properties. Optionally filter the returned meta-attributes. + """Get meta-attributes for attribute, populate the requested properties. Optionally filter the returned meta-attributes. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) + attribute_guid: str body: GsaQueryAttributesRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- GsaQueryAttributesInfo | None """ - data = self._query_meta_attributes_with_http_info( - database_key, table_guid, body, x_ansys_vc_mode, mode, _return_http_data_only=True + data = self._query_meta_attributes_for_attribute_with_http_info( + database_key, + table_guid, + attribute_guid, + body, + x_ansys_vc_mode, + mode, + _return_http_data_only=True, ) return data # type: ignore[no-any-return] - def _query_meta_attributes_with_http_info( + def _query_meta_attributes_for_attribute_with_http_info( self, database_key: "str", table_guid: "str", + attribute_guid: "str", body: "Optional[GsaQueryAttributesRequest]" = None, x_ansys_vc_mode: "Optional[str]" = None, mode: "Optional[str]" = None, @@ -1600,6 +1383,7 @@ def _query_meta_attributes_with_http_info( all_params = [ "database_key", "table_guid", + "attribute_guid", "body", "x_ansys_vc_mode", "mode", @@ -1612,19 +1396,24 @@ def _query_meta_attributes_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_meta_attributes" + f"Got an unexpected keyword argument '{key}' to method query_meta_attributes_for_attribute" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_meta_attributes'" + "Missing the required parameter 'database_key' when calling 'query_meta_attributes_for_attribute'" ) # verify the required parameter "table_guid" is set if "table_guid" not in params or params["table_guid"] is None: raise ValueError( - "Missing the required parameter 'table_guid' when calling 'query_meta_attributes'" + "Missing the required parameter 'table_guid' when calling 'query_meta_attributes_for_attribute'" + ) + # verify the required parameter "attribute_guid" is set + if "attribute_guid" not in params or params["attribute_guid"] is None: + raise ValueError( + "Missing the required parameter 'attribute_guid' when calling 'query_meta_attributes_for_attribute'" ) collection_formats: dict[str, Any] = {} @@ -1634,6 +1423,8 @@ def _query_meta_attributes_with_http_info( path_params["database-key"] = params["database_key"] if "table_guid" in params and table_guid is not None: path_params["table-guid"] = params["table_guid"] + if "attribute_guid" in params and attribute_guid is not None: + path_params["attribute-guid"] = params["attribute_guid"] query_params: list[Any] = [] if "mode" in params and mode is not None: @@ -1665,7 +1456,7 @@ def _query_meta_attributes_with_http_info( } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes:query", + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes:query", "POST", path_params, query_params, @@ -1680,289 +1471,28 @@ def _query_meta_attributes_with_http_info( response_type_map=response_type_map, ) - def query_meta_attributes_for_attribute( + def update_attribute( self, *, database_key: "str", table_guid: "str", attribute_guid: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaQueryAttributesInfo | None": - """Get meta-attributes for attribute, populate the requested properties. Optionally filter the returned meta-attributes. + body: "Optional[GsaUpdateAttribute]" = None, + ) -> "GsaAttribute | None": + """Update attribute. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) - body: GsaQueryAttributesRequest - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + body: GsaUpdateAttribute Returns ------- - GsaQueryAttributesInfo | None - """ - data = self._query_meta_attributes_for_attribute_with_http_info( - database_key, - table_guid, - attribute_guid, - body, - x_ansys_vc_mode, - mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _query_meta_attributes_for_attribute_with_http_info( - self, - database_key: "str", - table_guid: "str", - attribute_guid: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "attribute_guid", - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_meta_attributes_for_attribute" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_meta_attributes_for_attribute'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'query_meta_attributes_for_attribute'" - ) - # verify the required parameter "attribute_guid" is set - if "attribute_guid" not in params or params["attribute_guid"] is None: - raise ValueError( - "Missing the required parameter 'attribute_guid' when calling 'query_meta_attributes_for_attribute'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "attribute_guid" in params and attribute_guid is not None: - path_params["attribute-guid"] = params["attribute_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryAttributesInfo", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def query_meta_attributes_in_database( - self, - *, - database_key: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaQueryAttributesInfo | None": - """Get meta-attributes in database, populate the requested properties. Optionally filter the returned meta-attributes. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaQueryAttributesRequest - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - - Returns - ------- - GsaQueryAttributesInfo | None - """ - data = self._query_meta_attributes_in_database_with_http_info( - database_key, body, x_ansys_vc_mode, mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _query_meta_attributes_in_database_with_http_info( - self, - database_key: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_meta_attributes_in_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_meta_attributes_in_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryAttributesInfo", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/meta-attributes:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_attribute( - self, - *, - database_key: "str", - table_guid: "str", - attribute_guid: "str", - body: "Optional[GsaUpdateAttribute]" = None, - ) -> "GsaAttribute | GsaAttributeUpdateException | None": - """Update attribute. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) - body: GsaUpdateAttribute - - Returns - ------- - GsaAttribute | GsaAttributeUpdateException | None + GsaAttribute | None """ data = self._update_attribute_with_http_info( database_key, table_guid, attribute_guid, body, _return_http_data_only=True @@ -2041,7 +1571,7 @@ def _update_attribute_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaAttribute", - 400: "GsaAttributeUpdateException", + 400: None, 403: None, 404: None, } @@ -2062,132 +1592,6 @@ def _update_attribute_with_http_info( response_type_map=response_type_map, ) - def update_attribute_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - attribute_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given attribute. Sets the access control for the given permissions. - - Can also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation) - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_attribute_permission_category_access_controls_with_http_info( - database_key, table_guid, attribute_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_attribute_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - attribute_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "attribute_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_attribute_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_attribute_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_attribute_permission_category_access_controls'" - ) - # verify the required parameter "attribute_guid" is set - if "attribute_guid" not in params or params["attribute_guid"] is None: - raise ValueError( - "Missing the required parameter 'attribute_guid' when calling 'update_attribute_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "attribute_guid" in params and attribute_guid is not None: - path_params["attribute-guid"] = params["attribute_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_meta_attribute( self, *, @@ -2195,7 +1599,7 @@ def update_meta_attribute( table_guid: "str", meta_attribute_guid: "str", body: "Optional[GsaUpdateAttribute]" = None, - ) -> "GsaAttribute | GsaAttributeUpdateException | None": + ) -> "GsaAttribute | None": """Update meta-attribute. This method makes a synchronous HTTP request. @@ -2203,15 +1607,13 @@ def update_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str body: GsaUpdateAttribute Returns ------- - GsaAttribute | GsaAttributeUpdateException | None + GsaAttribute | None """ data = self._update_meta_attribute_with_http_info( database_key, table_guid, meta_attribute_guid, body, _return_http_data_only=True @@ -2290,7 +1692,7 @@ def _update_meta_attribute_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaAttribute", - 400: "GsaAttributeUpdateException", + 400: None, 403: None, 404: None, } @@ -2311,131 +1713,6 @@ def _update_meta_attribute_with_http_info( response_type_map=response_type_map, ) - def update_meta_attribute_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - meta_attribute_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given meta-attribute. Sets the access control for the given permissions. - - Can also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation) - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - meta_attribute_guid: str - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_meta_attribute_permission_category_access_controls_with_http_info( - database_key, table_guid, meta_attribute_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_meta_attribute_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - meta_attribute_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "meta_attribute_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_meta_attribute_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_meta_attribute_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_meta_attribute_permission_category_access_controls'" - ) - # verify the required parameter "meta_attribute_guid" is set - if "meta_attribute_guid" not in params or params["meta_attribute_guid"] is None: - raise ValueError( - "Missing the required parameter 'meta_attribute_guid' when calling 'update_meta_attribute_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "meta_attribute_guid" in params and meta_attribute_guid is not None: - path_params["meta-attribute-guid"] = params["meta_attribute_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def validate_attribute( self, *, @@ -2451,11 +1728,8 @@ def validate_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaValidateAttributeRequest Returns @@ -2575,11 +1849,8 @@ def validate_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaValidateAttributeRequest Returns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___configurations_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___configurations_api.py index 68f2a09a..539efa15 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___configurations_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___configurations_api.py @@ -54,7 +54,7 @@ def create_configuration( database_key: "str", configuration_type: "str", body: "Optional[GsaCreateConfiguration]" = None, - ) -> "GsaConfiguration | GsaFileCreationException | None": + ) -> "GsaConfiguration | None": """Create a new configuration. This method makes a synchronous HTTP request. @@ -62,14 +62,13 @@ def create_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. body: GsaCreateConfiguration Returns ------- - GsaConfiguration | GsaFileCreationException | None + GsaConfiguration | None """ data = self._create_configuration_with_http_info( database_key, configuration_type, body, _return_http_data_only=True @@ -139,7 +138,7 @@ def _create_configuration_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaConfiguration", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -170,9 +169,8 @@ def delete_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str Returns @@ -267,7 +265,7 @@ def _delete_configuration_with_http_info( def export_configuration( self, *, database_key: "str", configuration_type: "str", configuration_guid: "str" - ) -> "None | str": + ) -> "None": """Get individual configuration as a file This method makes a synchronous HTTP request. @@ -275,14 +273,13 @@ def export_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str Returns ------- - None | str + None """ data = self._export_configuration_with_http_info( database_key, configuration_type, configuration_guid, _return_http_data_only=True @@ -347,11 +344,9 @@ def _export_configuration_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -371,101 +366,6 @@ def _export_configuration_with_http_info( response_type_map=response_type_map, ) - def export_configurations( - self, *, database_key: "str", configuration_type: "str" - ) -> "None | str": - """Get configurations as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - configuration_type: str - The configuration type as entered. - - Returns - ------- - None | str - """ - data = self._export_configurations_with_http_info( - database_key, configuration_type, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_configurations_with_http_info( - self, database_key: "str", configuration_type: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "configuration_type", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_configurations" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_configurations'" - ) - # verify the required parameter "configuration_type" is set - if "configuration_type" not in params or params["configuration_type"] is None: - raise ValueError( - "Missing the required parameter 'configuration_type' when calling 'export_configurations'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "configuration_type" in params and configuration_type is not None: - path_params["configuration-type"] = params["configuration_type"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["application/zip", "application/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_configuration( self, *, database_key: "str", configuration_type: "str", configuration_guid: "str" ) -> "GsaConfiguration | None": @@ -476,9 +376,8 @@ def get_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str Returns @@ -582,9 +481,8 @@ def get_configurations( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. Returns ------- @@ -665,99 +563,6 @@ def _get_configurations_with_http_info( response_type_map=response_type_map, ) - def get_descendants( - self, *, database_key: "str", configuration_type: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all configurations for the specified type. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - configuration_type: str - The configuration type as entered. - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_descendants_with_http_info( - database_key, configuration_type, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_descendants_with_http_info( - self, database_key: "str", configuration_type: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "configuration_type", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_descendants'" - ) - # verify the required parameter "configuration_type" is set - if "configuration_type" not in params or params["configuration_type"] is None: - raise ValueError( - "Missing the required parameter 'configuration_type' when calling 'get_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "configuration_type" in params and configuration_type is not None: - path_params["configuration-type"] = params["configuration_type"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_configuration( self, *, @@ -765,7 +570,7 @@ def update_configuration( configuration_type: "str", configuration_guid: "str", body: "Optional[GsaUpdateConfiguration]" = None, - ) -> "GsaConfiguration | GsaFileUpdateException | None": + ) -> "GsaConfiguration | None": """Update a configuration. This method makes a synchronous HTTP request. @@ -773,15 +578,14 @@ def update_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str body: GsaUpdateConfiguration Returns ------- - GsaConfiguration | GsaFileUpdateException | None + GsaConfiguration | None """ data = self._update_configuration_with_http_info( database_key, configuration_type, configuration_guid, body, _return_http_data_only=True @@ -860,7 +664,7 @@ def _update_configuration_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaConfiguration", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___constants_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___constants_api.py index a176ff7a..1764f8a0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___constants_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___constants_api.py @@ -50,7 +50,7 @@ class SchemaConstantsApi(ApiBase): def create_constant( self, *, database_key: "str", body: "Optional[GsaCreateConstant]" = None - ) -> "GsaConstant | GsaConstantCreationException | None": + ) -> "GsaConstant | None": """Create a new constant. This method makes a synchronous HTTP request. @@ -64,7 +64,7 @@ def create_constant( Returns ------- - GsaConstant | GsaConstantCreationException | None + GsaConstant | None """ data = self._create_constant_with_http_info(database_key, body, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -120,7 +120,7 @@ def _create_constant_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaConstant", - 400: "GsaConstantCreationException", + 400: None, 403: None, 404: None, } @@ -335,7 +335,6 @@ def get_constants(self, *, database_key: "str") -> "GsaConstantsInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -410,7 +409,7 @@ def update_constant( database_key: "str", constant_guid: "str", body: "Optional[GsaUpdateConstant]" = None, - ) -> "GsaConstant | GsaConstantUpdateException | None": + ) -> "GsaConstant | None": """Update constant. This method makes a synchronous HTTP request. @@ -426,7 +425,7 @@ def update_constant( Returns ------- - GsaConstant | GsaConstantUpdateException | None + GsaConstant | None """ data = self._update_constant_with_http_info( database_key, constant_guid, body, _return_http_data_only=True @@ -496,7 +495,7 @@ def _update_constant_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaConstant", - 400: "GsaConstantUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___data_rules_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___data_rules_api.py index b9a36d37..92f7cf2e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___data_rules_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___data_rules_api.py @@ -58,7 +58,6 @@ def create_data_rule( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateDataRule Returns @@ -150,7 +149,6 @@ def delete_data_rule(self, *, database_key: "str", data_rule_guid: "str") -> "No Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) data_rule_guid: str Returns @@ -240,7 +238,6 @@ def get_data_rule(self, *, database_key: "str", data_rule_guid: "str") -> "GsaDa Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) data_rule_guid: str Returns @@ -330,7 +327,6 @@ def get_data_rules(self, *, database_key: "str") -> "GsaDataRulesInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -413,7 +409,6 @@ def update_data_rule( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) data_rule_guid: str body: GsaUpdateDataRule diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___databases_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___databases_api.py index f838abad..cd1a12fc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___databases_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___databases_api.py @@ -122,83 +122,6 @@ def _add_database_with_http_info( response_type_map=response_type_map, ) - def check_databases_for_retarget_potential( - self, *, body: "Optional[GsaRetargetPotentialRequest]" = None - ) -> "GsaDatabasesInfo | None": - """Check databases for retarget potential - whether there are any cross-database tabular attributes targeting them. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaRetargetPotentialRequest - - Returns - ------- - GsaDatabasesInfo | None - """ - data = self._check_databases_for_retarget_potential_with_http_info( - body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _check_databases_for_retarget_potential_with_http_info( - self, body: "Optional[GsaRetargetPotentialRequest]" = None, **kwargs: Any - ) -> Any: - all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method check_databases_for_retarget_potential" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabasesInfo", - 400: None, - } - - return self.api_client.call_api( - "/v1alpha/databases:check-retarget-potential", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_all_databases(self, *, role: "Optional[str]" = None) -> "GsaDatabasesInfo": """Lists all databases that the user can see. @@ -243,623 +166,14 @@ def _get_all_databases_with_http_info(self, role: "Optional[str]" = None, **kwar body_params = None # HTTP header 'Accept' header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabasesInfo", - } - - return self.api_client.call_api( - "/v1alpha/databases", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_all_table_types(self, *, database_key: "str") -> "GsaTableTypesInfo | None": - """Get all table types for a given database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - - Returns - ------- - GsaTableTypesInfo | None - """ - data = self._get_all_table_types_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_all_table_types_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_table_types" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_all_table_types'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaTableTypesInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/all-table-types", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_database(self, *, database_key: "str") -> "GsaDatabase | None": - """Returns details for a given database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaDatabase | None - """ - data = self._get_database_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabase", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_database_permission_category_access_controls( - self, *, database_key: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for the database. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_database_permission_category_access_controls_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_database_permission_category_access_controls_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_database_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_database_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_default_additional_sql_parameters(self) -> "GsaAdditionalSqlParameters | None": - """Returns additional SQL parameters used by the configuration database. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaAdditionalSqlParameters | None - """ - data = self._get_default_additional_sql_parameters_with_http_info( - _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_default_additional_sql_parameters_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_additional_sql_parameters" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAdditionalSqlParameters", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/defaultAdditionalSqlParameters", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_default_data_source(self) -> "GsaDataSource | None": - """Returns data source used by the configuration database. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaDataSource | None - """ - data = self._get_default_data_source_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_default_data_source_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_data_source" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataSource", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/defaultDataSource", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_default_database(self) -> "GsaDatabase | None": - """Returns details for a default database or null if the default database is not set or user cannot see it. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaDatabase | None - """ - data = self._get_default_database_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_default_database_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_database" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabase", - 204: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/default", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_outbound_links( - self, - *, - database_key: "str", - type: "Optional[list[GsaLinkAttributeType]]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaLinksInfo | None": - """Get all link groups and tabular attributes pointing from the database, i.e. the source of the link is in the given database. May include links where the target is in the same database, or where the target cannot be resolved (e.g. the target database is not loaded). - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - type: list[GsaLinkAttributeType] - The link types to include in the response. If not provided, all link types are included. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaLinksInfo | None - """ - data = self._get_outbound_links_with_http_info( - database_key, type, mode, x_ansys_vc_mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_outbound_links_with_http_info( - self, - database_key: "str", - type: "Optional[list[GsaLinkAttributeType]]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_outbound_links" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_outbound_links'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "type" in params and type is not None: - query_params.append(("type", params["type"])) - collection_formats["type"] = "multi" - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLinksInfo", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}:outbound-links", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def lock_database(self, *, database_key: "str") -> "GsaDatabase | None": - """Lock database - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database to lock - - Returns - ------- - GsaDatabase | None - """ - data = self._lock_database_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _lock_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method lock_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'lock_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabase", - 400: None, - 403: None, - 404: None, + + response_type_map: dict[int, Optional[str]] = { + 200: "GsaDatabasesInfo", } return self.api_client.call_api( - "/v1alpha/databases/{database-key}:lock", - "POST", + "/v1alpha/databases", + "GET", path_params, query_params, header_params, @@ -873,24 +187,23 @@ def _lock_database_with_http_info(self, database_key: "str", **kwargs: Any) -> A response_type_map=response_type_map, ) - def reload_database(self, *, database_key: "str") -> "GsaSlimDatabase | None": - """Reloads a database. Only available to users in the System Administrator role. + def get_database(self, *, database_key: "str") -> "GsaDatabase | None": + """Returns details for a given database. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- - GsaSlimDatabase | None + GsaDatabase | None """ - data = self._reload_database_with_http_info(database_key, _return_http_data_only=True) + data = self._get_database_with_http_info(database_key, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _reload_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: + def _get_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: all_params = [ "database_key", "_return_http_data_only", @@ -902,14 +215,14 @@ def _reload_database_with_http_info(self, database_key: "str", **kwargs: Any) -> for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method reload_database" + f"Got an unexpected keyword argument '{key}' to method get_database" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'reload_database'" + "Missing the required parameter 'database_key' when calling 'get_database'" ) collection_formats: dict[str, Any] = {} @@ -930,15 +243,13 @@ def _reload_database_with_http_info(self, database_key: "str", **kwargs: Any) -> header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaSlimDatabase", - 400: None, - 403: None, + 200: "GsaDatabase", 404: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}:reload", - "POST", + "/v1alpha/databases/{database-key}", + "GET", path_params, query_params, header_params, @@ -952,24 +263,24 @@ def _reload_database_with_http_info(self, database_key: "str", **kwargs: Any) -> response_type_map=response_type_map, ) - def remove_database(self, *, database_key: "str") -> "None": - """Removes the database from the MI server. Only available to users in the System Administrator role. + def lock_database(self, *, database_key: "str") -> "GsaDatabase | None": + """Lock database This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) + Database to lock Returns ------- - None + GsaDatabase | None """ - data = self._remove_database_with_http_info(database_key, _return_http_data_only=True) + data = self._lock_database_with_http_info(database_key, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _remove_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: + def _lock_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: all_params = [ "database_key", "_return_http_data_only", @@ -981,14 +292,14 @@ def _remove_database_with_http_info(self, database_key: "str", **kwargs: Any) -> for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method remove_database" + f"Got an unexpected keyword argument '{key}' to method lock_database" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'remove_database'" + "Missing the required parameter 'database_key' when calling 'lock_database'" ) collection_formats: dict[str, Any] = {} @@ -1005,17 +316,19 @@ def _remove_database_with_http_info(self, database_key: "str", **kwargs: Any) -> local_var_files: dict[str, Any] = {} body_params = None + # HTTP header 'Accept' + header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: None, + 200: "GsaDatabase", 400: None, 403: None, 404: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}", - "DELETE", + "/v1alpha/databases/{database-key}:lock", + "POST", path_params, query_params, header_params, @@ -1029,34 +342,25 @@ def _remove_database_with_http_info(self, database_key: "str", **kwargs: Any) -> response_type_map=response_type_map, ) - def reset_version_guid( - self, *, database_key: "str", version_guid: "Optional[str]" = None - ) -> "GsaSlimDatabase | None": - """Reset the database version guid. A version guid can optionally be specified, if not then a random guid is generated. + def reload_database(self, *, database_key: "str") -> "GsaSlimDatabase | None": + """Reloads a database. Only available to users in the System Administrator role. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - version_guid: str Returns ------- GsaSlimDatabase | None """ - data = self._reset_version_guid_with_http_info( - database_key, version_guid, _return_http_data_only=True - ) + data = self._reload_database_with_http_info(database_key, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _reset_version_guid_with_http_info( - self, database_key: "str", version_guid: "Optional[str]" = None, **kwargs: Any - ) -> Any: + def _reload_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: all_params = [ "database_key", - "version_guid", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -1066,14 +370,14 @@ def _reset_version_guid_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method reset_version_guid" + f"Got an unexpected keyword argument '{key}' to method reload_database" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'reset_version_guid'" + "Missing the required parameter 'database_key' when calling 'reload_database'" ) collection_formats: dict[str, Any] = {} @@ -1083,8 +387,6 @@ def _reset_version_guid_with_http_info( path_params["database-key"] = params["database_key"] query_params: list[Any] = [] - if "version_guid" in params and version_guid is not None: - query_params.append(("versionGuid", params["version_guid"])) header_params: dict[str, Any] = {} @@ -1103,7 +405,7 @@ def _reset_version_guid_with_http_info( } return self.api_client.call_api( - "/v1alpha/databases/{database-key}:resetVersionGuid", + "/v1alpha/databases/{database-key}:reload", "POST", path_params, query_params, @@ -1118,41 +420,49 @@ def _reset_version_guid_with_http_info( response_type_map=response_type_map, ) - def retarget_tabulars( - self, *, body: "Optional[GsaRetargetRequest]" = None - ) -> "GsaRetargetResultsInfo | None": - """Retargets tabulars from the current database to a new one. + def remove_database(self, *, database_key: "str") -> "None": + """Removes the database from the MI server. Only available to users in the System Administrator role. This method makes a synchronous HTTP request. Parameters ---------- - body: GsaRetargetRequest + database_key: str Returns ------- - GsaRetargetResultsInfo | None + None """ - data = self._retarget_tabulars_with_http_info(body, _return_http_data_only=True) + data = self._remove_database_with_http_info(database_key, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _retarget_tabulars_with_http_info( - self, body: "Optional[GsaRetargetRequest]" = None, **kwargs: Any - ) -> Any: - all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] + def _remove_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: + all_params = [ + "database_key", + "_return_http_data_only", + "_preload_content", + "_request_timeout", + ] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method retarget_tabulars" + f"Got an unexpected keyword argument '{key}' to method remove_database" ) params[key] = val del params["kwargs"] + # verify the required parameter "database_key" is set + if "database_key" not in params or params["database_key"] is None: + raise ValueError( + "Missing the required parameter 'database_key' when calling 'remove_database'" + ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} + if "database_key" in params and database_key is not None: + path_params["database-key"] = params["database_key"] query_params: list[Any] = [] @@ -1162,25 +472,17 @@ def _retarget_tabulars_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaRetargetResultsInfo", + 200: None, 400: None, + 403: None, 404: None, } return self.api_client.call_api( - "/v1alpha/databases:retarget", - "POST", + "/v1alpha/databases/{database-key}", + "DELETE", path_params, query_params, header_params, @@ -1287,7 +589,6 @@ def update_database( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaUpdateDatabase allow_reload: bool This must be set to true if any of the following properties are patched: DatabaseKey, DataSource, UseIntegratedSecurity, SqlUserName, SqlPassword, InitialCatalog, Language, Guid. The database will reload after the changes have been applied. @@ -1380,188 +681,7 @@ def _update_database_with_http_info( response_type_map=response_type_map, ) - def update_database_permission_category_access_controls( - self, - *, - database_key: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for the database. Sets the access control for the given permissions. - - Can also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation) - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_database_permission_category_access_controls_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_database_permission_category_access_controls_with_http_info( - self, - database_key: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_database_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_database_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_default_database( - self, *, body: "Optional[GsaUpdateDefaultDatabase]" = None - ) -> "GsaDatabase | None": - """Sets the default database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaUpdateDefaultDatabase - - Returns - ------- - GsaDatabase | None - """ - data = self._update_default_database_with_http_info(body, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _update_default_database_with_http_info( - self, body: "Optional[GsaUpdateDefaultDatabase]" = None, **kwargs: Any - ) -> Any: - all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_default_database" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabase", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/default", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def upgrade_database( - self, *, database_key: "str" - ) -> "GsaSlimDatabase | GsaUpgradeDatabaseException | None": + def upgrade_database(self, *, database_key: "str") -> "GsaSlimDatabase | None": """Upgrade a database to the latest schema version. Only available to users in the System Administrator role. This method makes a synchronous HTTP request. @@ -1569,11 +689,10 @@ def upgrade_database( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- - GsaSlimDatabase | GsaUpgradeDatabaseException | None + GsaSlimDatabase | None """ data = self._upgrade_database_with_http_info(database_key, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -1618,8 +737,8 @@ def _upgrade_database_with_http_info(self, database_key: "str", **kwargs: Any) - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaUpgradeDatabaseException", 200: "GsaSlimDatabase", + 400: None, 403: None, 404: None, } @@ -1641,19 +760,19 @@ def _upgrade_database_with_http_info(self, database_key: "str", **kwargs: Any) - ) def upgrade_database_not_added_to_mi( - self, *, body: "Optional[GsaInputConnectionDetails]" = None - ) -> "GsaUpgradeDatabaseException | None": + self, *, body: "Optional[GsaConnectionDetails]" = None + ) -> "None": """Upgrades an external database to the latest schema version. Only available to users in the System Administrator role. This method makes a synchronous HTTP request. Parameters ---------- - body: GsaInputConnectionDetails + body: GsaConnectionDetails Returns ------- - GsaUpgradeDatabaseException | None + None """ data = self._upgrade_database_not_added_to_mi_with_http_info( body, _return_http_data_only=True @@ -1661,7 +780,7 @@ def upgrade_database_not_added_to_mi( return data # type: ignore[no-any-return] def _upgrade_database_not_added_to_mi_with_http_info( - self, body: "Optional[GsaInputConnectionDetails]" = None, **kwargs: Any + self, body: "Optional[GsaConnectionDetails]" = None, **kwargs: Any ) -> Any: all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] @@ -1688,17 +807,14 @@ def _upgrade_database_not_added_to_mi_with_http_info( body_params = None if "body" in params and body is not None: body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( ["application/json-patch+json", "application/json", "text/json", "application/*+json"] ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaUpgradeDatabaseException", 200: None, + 400: None, 403: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types___discrete_values_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types___discrete_values_api.py index 0f5d4f83..d32c8635 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types___discrete_values_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types___discrete_values_api.py @@ -54,7 +54,7 @@ def create_discrete_value( database_key: "str", discrete_type_guid: "str", body: "Optional[GsaDiscreteValuesCreateDiscreteValue]" = None, - ) -> "GsaDiscreteValueCreationException | GsaDiscreteValuesDiscreteValue | None": + ) -> "GsaDiscreteValuesDiscreteValue | None": """Create new discrete value. It will be added at the end. This method makes a synchronous HTTP request. @@ -62,13 +62,12 @@ def create_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str body: GsaDiscreteValuesCreateDiscreteValue Returns ------- - GsaDiscreteValueCreationException | GsaDiscreteValuesDiscreteValue | None + GsaDiscreteValuesDiscreteValue | None """ data = self._create_discrete_value_with_http_info( database_key, discrete_type_guid, body, _return_http_data_only=True @@ -138,7 +137,7 @@ def _create_discrete_value_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaDiscreteValuesDiscreteValue", - 400: "GsaDiscreteValueCreationException", + 400: None, 403: None, 404: None, } @@ -161,7 +160,7 @@ def _create_discrete_value_with_http_info( def delete_discrete_value( self, *, database_key: "str", discrete_type_guid: "str", discrete_value_guid: "str" - ) -> "GsaDiscreteValueDeletionException | None": + ) -> "GsaDiscreteValueAggregateException | None": """Delete a single discrete value. It must not be used by any data, or the operation will fail. This method makes a synchronous HTTP request. @@ -169,13 +168,12 @@ def delete_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str discrete_value_guid: str Returns ------- - GsaDiscreteValueDeletionException | None + GsaDiscreteValueAggregateException | None """ data = self._delete_discrete_value_with_http_info( database_key, discrete_type_guid, discrete_value_guid, _return_http_data_only=True @@ -244,7 +242,7 @@ def _delete_discrete_value_with_http_info( header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaDiscreteValueDeletionException", + 400: "GsaDiscreteValueAggregateException", 200: None, 403: None, 404: None, @@ -276,7 +274,6 @@ def find_unused_discrete_values( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -369,7 +366,6 @@ def get_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str discrete_value_guid: str @@ -474,7 +470,6 @@ def get_discrete_values( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -562,21 +557,20 @@ def replace_discrete_values( database_key: "str", discrete_type_guid: "str", body: "Optional[GsaDiscreteValuesReplaceDiscreteValuesInfo]" = None, - ) -> "GsaDiscreteValuesDiscreteValuesInfo | GsaReplaceDiscreteValuesException | None": - """Replace the whole discrete value collection for a given discrete type. This will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails. If any 'update' discrete values are included in the request where the guid does not match an existing discrete value the operation will fail. If any 'create' discrete values are included in the request body where the name matches an existing discrete value the operation will fail. + ) -> "GsaDiscreteValuesDiscreteValuesInfo | None": + """Replace the whole discrete value collection for a given discrete type. This will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str body: GsaDiscreteValuesReplaceDiscreteValuesInfo Returns ------- - GsaDiscreteValuesDiscreteValuesInfo | GsaReplaceDiscreteValuesException | None + GsaDiscreteValuesDiscreteValuesInfo | None """ data = self._replace_discrete_values_with_http_info( database_key, discrete_type_guid, body, _return_http_data_only=True @@ -646,7 +640,7 @@ def _replace_discrete_values_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaDiscreteValuesDiscreteValuesInfo", - 400: "GsaReplaceDiscreteValuesException", + 400: None, 403: None, 404: None, } @@ -674,7 +668,7 @@ def update_discrete_value( discrete_type_guid: "str", discrete_value_guid: "str", body: "Optional[GsaDiscreteValuesUpdateDiscreteValue]" = None, - ) -> "GsaDiscreteValueUpdateException | GsaDiscreteValuesDiscreteValue | None": + ) -> "GsaDiscreteValuesDiscreteValue | None": """Update discrete value. This method makes a synchronous HTTP request. @@ -682,14 +676,13 @@ def update_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str discrete_value_guid: str body: GsaDiscreteValuesUpdateDiscreteValue Returns ------- - GsaDiscreteValueUpdateException | GsaDiscreteValuesDiscreteValue | None + GsaDiscreteValuesDiscreteValue | None """ data = self._update_discrete_value_with_http_info( database_key, discrete_type_guid, discrete_value_guid, body, _return_http_data_only=True @@ -768,7 +761,7 @@ def _update_discrete_value_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaDiscreteValuesDiscreteValue", - 400: "GsaDiscreteValueUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types_api.py index 1462b837..c377a929 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___discrete_types_api.py @@ -50,7 +50,7 @@ class SchemaDiscreteTypesApi(ApiBase): def create_discrete_type( self, *, database_key: "str", body: "Optional[GsaCreateDiscreteType]" = None - ) -> "GsaDiscreteType | GsaDiscreteTypeCreationException | None": + ) -> "GsaSlimDiscreteType | None": """Create a new discrete type. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateDiscreteType Returns ------- - GsaDiscreteType | GsaDiscreteTypeCreationException | None + GsaSlimDiscreteType | None """ data = self._create_discrete_type_with_http_info( database_key, body, _return_http_data_only=True @@ -120,8 +119,8 @@ def _create_discrete_type_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 201: "GsaDiscreteType", - 400: "GsaDiscreteTypeCreationException", + 201: "GsaSlimDiscreteType", + 400: None, 403: None, 404: None, } @@ -152,7 +151,6 @@ def delete_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -237,11 +235,7 @@ def _delete_discrete_type_with_http_info( ) def get_attributes_for_type( - self, - *, - database_key: "str", - discrete_type_guid: "str", - response_filters: "Optional[list[GsaDiscreteTypeUsageType]]" = None, + self, *, database_key: "str", discrete_type_guid: "str" ) -> "GsaDiscreteTypeUsage | None": """Gets objects that are using this discrete type. @@ -250,31 +244,23 @@ def get_attributes_for_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str - response_filters: list[GsaDiscreteTypeUsageType] - The discrete type usage types to include in the response. If none are provided, all types are included. Returns ------- GsaDiscreteTypeUsage | None """ data = self._get_attributes_for_type_with_http_info( - database_key, discrete_type_guid, response_filters, _return_http_data_only=True + database_key, discrete_type_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] def _get_attributes_for_type_with_http_info( - self, - database_key: "str", - discrete_type_guid: "str", - response_filters: "Optional[list[GsaDiscreteTypeUsageType]]" = None, - **kwargs: Any, + self, database_key: "str", discrete_type_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "discrete_type_guid", - "response_filters", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -308,9 +294,6 @@ def _get_attributes_for_type_with_http_info( path_params["discrete-type-guid"] = params["discrete_type_guid"] query_params: list[Any] = [] - if "response_filters" in params and response_filters is not None: - query_params.append(("response-filters", params["response_filters"])) - collection_formats["response-filters"] = "multi" header_params: dict[str, Any] = {} @@ -353,7 +336,6 @@ def get_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -443,7 +425,6 @@ def get_discrete_types(self, *, database_key: "str") -> "GsaDiscreteTypesInfo | Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -523,7 +504,6 @@ def query_discrete_types( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaQueryDiscreteTypesRequest Returns @@ -615,7 +595,7 @@ def update_discrete_type( database_key: "str", discrete_type_guid: "str", body: "Optional[GsaUpdateDiscreteType]" = None, - ) -> "GsaDiscreteType | GsaDiscreteTypeUpdateException | None": + ) -> "GsaSlimDiscreteType | None": """Update discrete type. This method makes a synchronous HTTP request. @@ -623,13 +603,12 @@ def update_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str body: GsaUpdateDiscreteType Returns ------- - GsaDiscreteType | GsaDiscreteTypeUpdateException | None + GsaSlimDiscreteType | None """ data = self._update_discrete_type_with_http_info( database_key, discrete_type_guid, body, _return_http_data_only=True @@ -698,8 +677,8 @@ def _update_discrete_type_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDiscreteType", - 400: "GsaDiscreteTypeUpdateException", + 200: "GsaSlimDiscreteType", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___display_names_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___display_names_api.py deleted file mode 100644 index a104d089..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___display_names_api.py +++ /dev/null @@ -1,236 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaDisplayNamesApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_all_display_names( - self, *, database_key: "str", language: "str" - ) -> "GsaDisplayNamesInfo | None": - """Gets display names for all localized entities in the database, in the given language. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - language: str - - Returns - ------- - GsaDisplayNamesInfo | None - """ - data = self._get_all_display_names_with_http_info( - database_key, language, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_all_display_names_with_http_info( - self, database_key: "str", language: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "language", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_display_names" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_all_display_names'" - ) - # verify the required parameter "language" is set - if "language" not in params or params["language"] is None: - raise ValueError( - "Missing the required parameter 'language' when calling 'get_all_display_names'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "language" in params and language is not None: - path_params["language"] = params["language"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDisplayNamesInfo", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/display-names/{language}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def import_display_names( - self, *, database_key: "str", body: "Optional[GsaUpdateDisplayNames]" = None - ) -> "GsaDisplayNamesImportException | GsaUpdateDisplayNamesResponse | None": - """Updates display names for localized entities in the database. Returns the number of entities updated. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaUpdateDisplayNames - - Returns - ------- - GsaDisplayNamesImportException | GsaUpdateDisplayNamesResponse | None - """ - data = self._import_display_names_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _import_display_names_with_http_info( - self, database_key: "str", body: "Optional[GsaUpdateDisplayNames]" = None, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method import_display_names" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'import_display_names'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaUpdateDisplayNamesResponse", - 400: "GsaDisplayNamesImportException", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/display-names", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___exporters_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___exporters_api.py index 1ac16572..abe38bed 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___exporters_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___exporters_api.py @@ -55,7 +55,7 @@ def create_exporters_file( folder_guid: "str", file: "Optional[BinaryIO | pathlib.Path]" = None, description: "Optional[str]" = None, - ) -> "GsaFileCreationException | GsaFileHeader | None": + ) -> "GsaFileHeader | None": """Create a new Exporter File. This method makes a synchronous HTTP request. @@ -63,14 +63,13 @@ def create_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file: BinaryIO | pathlib.Path description: str Returns ------- - GsaFileCreationException | GsaFileHeader | None + GsaFileHeader | None """ data = self._create_exporters_file_with_http_info( database_key, folder_guid, file, description, _return_http_data_only=True @@ -144,7 +143,7 @@ def _create_exporters_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFileHeader", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -167,7 +166,7 @@ def _create_exporters_file_with_http_info( def create_exporters_folder( self, *, database_key: "str", body: "Optional[GsaCreateFolder]" = None - ) -> "GsaFolder | GsaFolderCreationException | None": + ) -> "GsaFolder | None": """Create a new Exporters Folder. This method makes a synchronous HTTP request. @@ -175,12 +174,11 @@ def create_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateFolder Returns ------- - GsaFolder | GsaFolderCreationException | None + GsaFolder | None """ data = self._create_exporters_folder_with_http_info( database_key, body, _return_http_data_only=True @@ -240,7 +238,7 @@ def _create_exporters_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFolder", - 400: "GsaFolderCreationException", + 400: None, 403: None, 404: None, } @@ -271,7 +269,6 @@ def delete_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -361,9 +358,7 @@ def _delete_exporters_file_with_http_info( response_type_map=response_type_map, ) - def delete_exporters_folder( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFolderDeletionException | None": + def delete_exporters_folder(self, *, database_key: "str", folder_guid: "str") -> "None": """Delete an Exporter Folder. This method makes a synchronous HTTP request. @@ -371,12 +366,11 @@ def delete_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns ------- - GsaFolderDeletionException | None + None """ data = self._delete_exporters_folder_with_http_info( database_key, folder_guid, _return_http_data_only=True @@ -429,13 +423,8 @@ def _delete_exporters_folder_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaFolderDeletionException", 200: None, 403: None, 404: None, @@ -459,7 +448,7 @@ def _delete_exporters_folder_with_http_info( def export_exporters_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" - ) -> "None | str": + ) -> "None": """Get Exporter File as a file This method makes a synchronous HTTP request. @@ -467,13 +456,12 @@ def export_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str Returns ------- - None | str + None """ data = self._export_exporters_file_with_http_info( database_key, folder_guid, file_guid, _return_http_data_only=True @@ -534,11 +522,9 @@ def _export_exporters_file_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/octet-stream"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -558,190 +544,6 @@ def _export_exporters_file_with_http_info( response_type_map=response_type_map, ) - def export_exporters_folder(self, *, database_key: "str", folder_guid: "str") -> "None | str": - """Get Exporter folder and contents as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - None | str - """ - data = self._export_exporters_folder_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_exporters_folder_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_exporters_folder" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_exporters_folder'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'export_exporters_folder'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/zip"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_exporter_descendants( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all descendants of an Exporter folder. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_exporter_descendants_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_exporter_descendants_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_exporter_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_exporter_descendants'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'get_exporter_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_exporter_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" ) -> "GsaFileHeader | None": @@ -752,7 +554,6 @@ def get_exporter_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -855,7 +656,6 @@ def get_exporters_child_folders( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -949,7 +749,6 @@ def get_exporters_files( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1043,7 +842,6 @@ def get_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1135,7 +933,6 @@ def get_exporters_folders(self, *, database_key: "str") -> "GsaFoldersInfo | Non Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1214,7 +1011,6 @@ def get_exporters_root_folder(self, *, database_key: "str") -> "GsaFolder | None Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1294,7 +1090,7 @@ def move_exporters_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaMoveFile]" = None, - ) -> "GsaFileHeader | GsaFileMoveException | None": + ) -> "GsaFileHeader | None": """Move an existing Exporter File. This method makes a synchronous HTTP request. @@ -1302,14 +1098,13 @@ def move_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaMoveFile Returns ------- - GsaFileHeader | GsaFileMoveException | None + GsaFileHeader | None """ data = self._move_exporters_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1390,7 +1185,7 @@ def _move_exporters_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileMoveException", + 400: None, 403: None, 404: None, } @@ -1413,7 +1208,7 @@ def _move_exporters_file_with_http_info( def move_exporters_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaMoveFolder]" = None - ) -> "GsaFolder | GsaFolderMoveException | None": + ) -> "GsaFolder | None": """Move an existing Exporter Folder. This method makes a synchronous HTTP request. @@ -1421,13 +1216,12 @@ def move_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaMoveFolder Returns ------- - GsaFolder | GsaFolderMoveException | None + GsaFolder | None """ data = self._move_exporters_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1499,7 +1293,7 @@ def _move_exporters_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderMoveException", + 400: None, 403: None, 404: None, } @@ -1528,7 +1322,6 @@ def refetch_exporters(self, *, database_key: "str") -> "GsaExporterRefetchInfo | Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1608,7 +1401,7 @@ def update_exporters_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaUpdateFile]" = None, - ) -> "GsaFileHeader | GsaFileUpdateException | None": + ) -> "GsaFileHeader | None": """Update an existing Exporter File. This method makes a synchronous HTTP request. @@ -1616,14 +1409,13 @@ def update_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaUpdateFile Returns ------- - GsaFileHeader | GsaFileUpdateException | None + GsaFileHeader | None """ data = self._update_exporters_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1704,7 +1496,7 @@ def _update_exporters_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } @@ -1727,7 +1519,7 @@ def _update_exporters_file_with_http_info( def update_exporters_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaUpdateFolder]" = None - ) -> "GsaFolder | GsaFolderUpdateException | None": + ) -> "GsaFolder | None": """Update an existing Exporters Folder. This method makes a synchronous HTTP request. @@ -1735,13 +1527,12 @@ def update_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaUpdateFolder Returns ------- - GsaFolder | GsaFolderUpdateException | None + GsaFolder | None """ data = self._update_exporters_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1813,7 +1604,7 @@ def _update_exporters_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___expressions_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___expressions_api.py index 3c64b0b2..3a6251e3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___expressions_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___expressions_api.py @@ -62,9 +62,7 @@ def create_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateExpression Returns @@ -170,9 +168,7 @@ def delete_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) expression_guid: str Returns @@ -278,14 +274,12 @@ def get_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) expression_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -391,110 +385,6 @@ def _get_expression_with_http_info( response_type_map=response_type_map, ) - def get_expression_permission_category_access_controls( - self, *, database_key: "str", table_guid: "str", expression_guid: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given expression. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - expression_guid: str - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_expression_permission_category_access_controls_with_http_info( - database_key, table_guid, expression_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_expression_permission_category_access_controls_with_http_info( - self, database_key: "str", table_guid: "str", expression_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "expression_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_expression_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_expression_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_expression_permission_category_access_controls'" - ) - # verify the required parameter "expression_guid" is set - if "expression_guid" not in params or params["expression_guid"] is None: - raise ValueError( - "Missing the required parameter 'expression_guid' when calling 'get_expression_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "expression_guid" in params and expression_guid is not None: - path_params["expression-guid"] = params["expression_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_expressions( self, *, @@ -510,13 +400,11 @@ def get_expressions( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -623,9 +511,7 @@ def update_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) expression_guid: str body: GsaUpdateExpression @@ -730,128 +616,3 @@ def _update_expression_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def update_expression_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - expression_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given expression. Sets the access control for the given permissions. - - Can also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation) - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - expression_guid: str - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_expression_permission_category_access_controls_with_http_info( - database_key, table_guid, expression_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_expression_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - expression_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "expression_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_expression_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_expression_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_expression_permission_category_access_controls'" - ) - # verify the required parameter "expression_guid" is set - if "expression_guid" not in params or params["expression_guid"] is None: - raise ValueError( - "Missing the required parameter 'expression_guid' when calling 'update_expression_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "expression_guid" in params and expression_guid is not None: - path_params["expression-guid"] = params["expression_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___help_files_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___help_files_api.py index 70f2901f..c083196c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___help_files_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___help_files_api.py @@ -55,7 +55,7 @@ def create_help_file( folder_guid: "str", file: "Optional[BinaryIO | pathlib.Path]" = None, description: "Optional[str]" = None, - ) -> "GsaFileCreationException | GsaFileHeader | None": + ) -> "GsaFileHeader | None": """Create a new Help File. This method makes a synchronous HTTP request. @@ -63,14 +63,13 @@ def create_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file: BinaryIO | pathlib.Path description: str Returns ------- - GsaFileCreationException | GsaFileHeader | None + GsaFileHeader | None """ data = self._create_help_file_with_http_info( database_key, folder_guid, file, description, _return_http_data_only=True @@ -144,7 +143,7 @@ def _create_help_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFileHeader", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -167,7 +166,7 @@ def _create_help_file_with_http_info( def create_help_folder( self, *, database_key: "str", body: "Optional[GsaCreateFolder]" = None - ) -> "GsaFolder | GsaFolderCreationException | None": + ) -> "GsaFolder | None": """Create a new Help File Folder. This method makes a synchronous HTTP request. @@ -175,12 +174,11 @@ def create_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateFolder Returns ------- - GsaFolder | GsaFolderCreationException | None + GsaFolder | None """ data = self._create_help_folder_with_http_info( database_key, body, _return_http_data_only=True @@ -240,7 +238,7 @@ def _create_help_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFolder", - 400: "GsaFolderCreationException", + 400: None, 403: None, 404: None, } @@ -271,7 +269,6 @@ def delete_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -361,9 +358,7 @@ def _delete_help_file_with_http_info( response_type_map=response_type_map, ) - def delete_help_folder( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFolderDeletionException | None": + def delete_help_folder(self, *, database_key: "str", folder_guid: "str") -> "None": """Delete a Help File Folder. This method makes a synchronous HTTP request. @@ -371,12 +366,11 @@ def delete_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns ------- - GsaFolderDeletionException | None + None """ data = self._delete_help_folder_with_http_info( database_key, folder_guid, _return_http_data_only=True @@ -429,13 +423,8 @@ def _delete_help_folder_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaFolderDeletionException", 200: None, 403: None, 404: None, @@ -459,7 +448,7 @@ def _delete_help_folder_with_http_info( def export_help_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" - ) -> "None | str": + ) -> "None": """Get help file as a file This method makes a synchronous HTTP request. @@ -467,13 +456,12 @@ def export_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str Returns ------- - None | str + None """ data = self._export_help_file_with_http_info( database_key, folder_guid, file_guid, _return_http_data_only=True @@ -534,11 +522,9 @@ def _export_help_file_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/octet-stream"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -558,96 +544,6 @@ def _export_help_file_with_http_info( response_type_map=response_type_map, ) - def export_help_folder(self, *, database_key: "str", folder_guid: "str") -> "None | str": - """Get help folder and contents as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - None | str - """ - data = self._export_help_folder_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_help_folder_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_help_folder" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_help_folder'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'export_help_folder'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/zip"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_help_child_folders( self, *, database_key: "str", folder_guid: "str" ) -> "GsaFoldersInfo | None": @@ -658,7 +554,6 @@ def get_help_child_folders( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -752,7 +647,6 @@ def get_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -845,100 +739,6 @@ def _get_help_file_with_http_info( response_type_map=response_type_map, ) - def get_help_file_descendants( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all descendants of a Help File folder. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_help_file_descendants_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_help_file_descendants_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_help_file_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_help_file_descendants'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'get_help_file_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_help_files(self, *, database_key: "str", folder_guid: "str") -> "GsaFilesInfo | None": """Get Files in a Folder @@ -947,7 +747,6 @@ def get_help_files(self, *, database_key: "str", folder_guid: "str") -> "GsaFile Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1039,7 +838,6 @@ def get_help_folder(self, *, database_key: "str", folder_guid: "str") -> "GsaFol Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1131,7 +929,6 @@ def get_help_folders(self, *, database_key: "str") -> "GsaFoldersInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1210,7 +1007,6 @@ def get_help_root_folder(self, *, database_key: "str") -> "GsaFolder | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1266,7 +1062,7 @@ def _get_help_root_folder_with_http_info(self, database_key: "str", **kwargs: An } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders:root-folder", + "/v1alpha/databases/{database-key}/help-folders/:root-folder", "GET", path_params, query_params, @@ -1288,7 +1084,7 @@ def move_help_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaMoveFile]" = None, - ) -> "GsaFileHeader | GsaFileMoveException | None": + ) -> "GsaFileHeader | None": """Move an existing Help File. This method makes a synchronous HTTP request. @@ -1296,14 +1092,13 @@ def move_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaMoveFile Returns ------- - GsaFileHeader | GsaFileMoveException | None + GsaFileHeader | None """ data = self._move_help_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1384,7 +1179,7 @@ def _move_help_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileMoveException", + 400: None, 403: None, 404: None, } @@ -1407,7 +1202,7 @@ def _move_help_file_with_http_info( def move_help_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaMoveFolder]" = None - ) -> "GsaFolder | GsaFolderMoveException | None": + ) -> "GsaFolder | None": """Move an existing Help File Folder. This method makes a synchronous HTTP request. @@ -1415,13 +1210,12 @@ def move_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaMoveFolder Returns ------- - GsaFolder | GsaFolderMoveException | None + GsaFolder | None """ data = self._move_help_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1493,7 +1287,7 @@ def _move_help_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderMoveException", + 400: None, 403: None, 404: None, } @@ -1521,7 +1315,7 @@ def update_help_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaUpdateFile]" = None, - ) -> "GsaFileHeader | GsaFileUpdateException | None": + ) -> "GsaFileHeader | None": """Update an existing Help File. This method makes a synchronous HTTP request. @@ -1529,14 +1323,13 @@ def update_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaUpdateFile Returns ------- - GsaFileHeader | GsaFileUpdateException | None + GsaFileHeader | None """ data = self._update_help_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1617,7 +1410,7 @@ def _update_help_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } @@ -1640,7 +1433,7 @@ def _update_help_file_with_http_info( def update_help_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaUpdateFolder]" = None - ) -> "GsaFolder | GsaFolderUpdateException | None": + ) -> "GsaFolder | None": """Update an existing Help File Folder. This method makes a synchronous HTTP request. @@ -1648,13 +1441,12 @@ def update_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaUpdateFolder Returns ------- - GsaFolder | GsaFolderUpdateException | None + GsaFolder | None """ data = self._update_help_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1726,7 +1518,7 @@ def _update_help_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderUpdateException", + 400: None, 403: None, 404: None, } @@ -1746,85 +1538,3 @@ def _update_help_folder_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def validate_help_paths( - self, *, database_key: "str" - ) -> "GsaHelpPathsValidationResponse | None": - """Verify that help pages exist for all attributes and parameters that have help paths defined. Returns schema entity and help path if the help path does not match an existing help page. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaHelpPathsValidationResponse | None - """ - data = self._validate_help_paths_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _validate_help_paths_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method validate_help_paths" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'validate_help_paths'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaHelpPathsValidationResponse", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders:validate", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___home_pages_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___home_pages_api.py index f6bc7931..1edded7b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___home_pages_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___home_pages_api.py @@ -55,7 +55,7 @@ def create_home_page_file( folder_guid: "str", file: "Optional[BinaryIO | pathlib.Path]" = None, description: "Optional[str]" = None, - ) -> "GsaFileCreationException | GsaFileHeader | None": + ) -> "GsaFileHeader | None": """Create a new Home Page File. This method makes a synchronous HTTP request. @@ -63,14 +63,13 @@ def create_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file: BinaryIO | pathlib.Path description: str Returns ------- - GsaFileCreationException | GsaFileHeader | None + GsaFileHeader | None """ data = self._create_home_page_file_with_http_info( database_key, folder_guid, file, description, _return_http_data_only=True @@ -144,7 +143,7 @@ def _create_home_page_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFileHeader", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -167,7 +166,7 @@ def _create_home_page_file_with_http_info( def create_home_page_folder( self, *, database_key: "str", body: "Optional[GsaCreateFolder]" = None - ) -> "GsaFolder | GsaFolderCreationException | None": + ) -> "GsaFolder | None": """Create a new Home Page Folder. This method makes a synchronous HTTP request. @@ -175,12 +174,11 @@ def create_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateFolder Returns ------- - GsaFolder | GsaFolderCreationException | None + GsaFolder | None """ data = self._create_home_page_folder_with_http_info( database_key, body, _return_http_data_only=True @@ -240,7 +238,7 @@ def _create_home_page_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFolder", - 400: "GsaFolderCreationException", + 400: None, 403: None, 404: None, } @@ -271,7 +269,6 @@ def delete_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -361,9 +358,7 @@ def _delete_home_page_file_with_http_info( response_type_map=response_type_map, ) - def delete_home_page_folder( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFolderDeletionException | None": + def delete_home_page_folder(self, *, database_key: "str", folder_guid: "str") -> "None": """Delete a Home Page Folder. This method makes a synchronous HTTP request. @@ -371,12 +366,11 @@ def delete_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns ------- - GsaFolderDeletionException | None + None """ data = self._delete_home_page_folder_with_http_info( database_key, folder_guid, _return_http_data_only=True @@ -429,13 +423,8 @@ def _delete_home_page_folder_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaFolderDeletionException", 200: None, 403: None, 404: None, @@ -459,7 +448,7 @@ def _delete_home_page_folder_with_http_info( def export_home_page_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" - ) -> "None | str": + ) -> "None": """Get Home Page File as a file This method makes a synchronous HTTP request. @@ -467,13 +456,12 @@ def export_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str Returns ------- - None | str + None """ data = self._export_home_page_file_with_http_info( database_key, folder_guid, file_guid, _return_http_data_only=True @@ -534,11 +522,9 @@ def _export_home_page_file_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/octet-stream"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -558,96 +544,6 @@ def _export_home_page_file_with_http_info( response_type_map=response_type_map, ) - def export_home_page_folder(self, *, database_key: "str", folder_guid: "str") -> "None | str": - """Get Home Page folder and contents as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - None | str - """ - data = self._export_home_page_folder_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_home_page_folder_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_home_page_folder" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_home_page_folder'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'export_home_page_folder'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/zip"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_home_page_child_folders( self, *, database_key: "str", folder_guid: "str" ) -> "GsaFoldersInfo | None": @@ -658,7 +554,6 @@ def get_home_page_child_folders( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -742,100 +637,6 @@ def _get_home_page_child_folders_with_http_info( response_type_map=response_type_map, ) - def get_home_page_descendants( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all descendants of a Home Page folder. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_home_page_descendants_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_home_page_descendants_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_home_page_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_home_page_descendants'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'get_home_page_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_home_page_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" ) -> "GsaFileHeader | None": @@ -846,7 +647,6 @@ def get_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -949,7 +749,6 @@ def get_home_page_files( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1043,7 +842,6 @@ def get_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1135,7 +933,6 @@ def get_home_page_folders(self, *, database_key: "str") -> "GsaFoldersInfo | Non Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1214,7 +1011,6 @@ def get_home_page_root_folder(self, *, database_key: "str") -> "GsaFolder | None Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1294,7 +1090,7 @@ def move_home_page_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaMoveFile]" = None, - ) -> "GsaFileHeader | GsaFileMoveException | None": + ) -> "GsaFileHeader | None": """Move an existing Home Page File. This method makes a synchronous HTTP request. @@ -1302,14 +1098,13 @@ def move_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaMoveFile Returns ------- - GsaFileHeader | GsaFileMoveException | None + GsaFileHeader | None """ data = self._move_home_page_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1390,7 +1185,7 @@ def _move_home_page_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileMoveException", + 400: None, 403: None, 404: None, } @@ -1413,7 +1208,7 @@ def _move_home_page_file_with_http_info( def move_home_page_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaMoveFolder]" = None - ) -> "GsaFolder | GsaFolderMoveException | None": + ) -> "GsaFolder | None": """Move an existing Home Page Folder. This method makes a synchronous HTTP request. @@ -1421,13 +1216,12 @@ def move_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaMoveFolder Returns ------- - GsaFolder | GsaFolderMoveException | None + GsaFolder | None """ data = self._move_home_page_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1499,7 +1293,7 @@ def _move_home_page_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderMoveException", + 400: None, 403: None, 404: None, } @@ -1527,7 +1321,7 @@ def update_home_page_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaUpdateFile]" = None, - ) -> "GsaFileHeader | GsaFileUpdateException | None": + ) -> "GsaFileHeader | None": """Update an existing Home Page File. This method makes a synchronous HTTP request. @@ -1535,14 +1329,13 @@ def update_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaUpdateFile Returns ------- - GsaFileHeader | GsaFileUpdateException | None + GsaFileHeader | None """ data = self._update_home_page_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1623,7 +1416,7 @@ def _update_home_page_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } @@ -1646,7 +1439,7 @@ def _update_home_page_file_with_http_info( def update_home_page_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaUpdateFolder]" = None - ) -> "GsaFolder | GsaFolderUpdateException | None": + ) -> "GsaFolder | None": """Update an existing Home Page Folder. This method makes a synchronous HTTP request. @@ -1654,13 +1447,12 @@ def update_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaUpdateFolder Returns ------- - GsaFolder | GsaFolderUpdateException | None + GsaFolder | None """ data = self._update_home_page_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1732,7 +1524,7 @@ def _update_home_page_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layout_sections_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layout_sections_api.py index bd5d1901..5f050ffd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layout_sections_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layout_sections_api.py @@ -64,9 +64,7 @@ def create_layout_item( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str body: GsaNewLayoutItem @@ -197,9 +195,7 @@ def create_section( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str body: GsaCreateLayoutSection @@ -321,9 +317,7 @@ def delete_item( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str item_guid: str @@ -450,9 +444,7 @@ def delete_section( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str @@ -574,16 +566,14 @@ def get_layout_section( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str show_full_detail: bool mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -704,142 +694,6 @@ def _get_layout_section_with_http_info( response_type_map=response_type_map, ) - def get_layout_section_without_layout( - self, - *, - database_key: "str", - table_guid: "str", - section_guid: "str", - show_full_detail: "Optional[bool]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaLayoutSection | None": - """Get a layout section with a specified guid. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - section_guid: str - show_full_detail: bool - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaLayoutSection | None - """ - data = self._get_layout_section_without_layout_with_http_info( - database_key, - table_guid, - section_guid, - show_full_detail, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_layout_section_without_layout_with_http_info( - self, - database_key: "str", - table_guid: "str", - section_guid: "str", - show_full_detail: "Optional[bool]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "section_guid", - "show_full_detail", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_layout_section_without_layout" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_layout_section_without_layout'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_layout_section_without_layout'" - ) - # verify the required parameter "section_guid" is set - if "section_guid" not in params or params["section_guid"] is None: - raise ValueError( - "Missing the required parameter 'section_guid' when calling 'get_layout_section_without_layout'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "section_guid" in params and section_guid is not None: - path_params["section-guid"] = params["section_guid"] - - query_params: list[Any] = [] - if "show_full_detail" in params and show_full_detail is not None: - query_params.append(("showFullDetail", params["show_full_detail"])) - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLayoutSection", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections/{section-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_layout_sections( self, *, @@ -857,15 +711,13 @@ def get_layout_sections( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str show_full_detail: bool mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -976,150 +828,6 @@ def _get_layout_sections_with_http_info( response_type_map=response_type_map, ) - def query_layout_sections( - self, - *, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutSectionsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - ) -> "GsaQueryLayoutSectionsInfo | None": - """Query all layout sections for table, optionally filter layout sections returned - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - body: GsaQueryLayoutSectionsRequest - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - application: str - cascade_filter: bool - If cascadeFilter is true, we apply the filter to the returned layout items, as well as filtering the layout sections themselves. - - Returns - ------- - GsaQueryLayoutSectionsInfo | None - """ - data = self._query_layout_sections_with_http_info( - database_key, - table_guid, - body, - x_ansys_vc_mode, - mode, - application, - cascade_filter, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _query_layout_sections_with_http_info( - self, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutSectionsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "body", - "x_ansys_vc_mode", - "mode", - "application", - "cascade_filter", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_layout_sections" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_layout_sections'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'query_layout_sections'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - if "application" in params and application is not None: - query_params.append(("application", params["application"])) - if "cascade_filter" in params and cascade_filter is not None: - query_params.append(("cascadeFilter", params["cascade_filter"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryLayoutSectionsInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def reorder_sections( self, *, @@ -1135,9 +843,7 @@ def reorder_sections( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str body: GsaReorderSectionsInfo @@ -1242,260 +948,3 @@ def _reorder_sections_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def update_section( - self, - *, - database_key: "str", - table_guid: "str", - layout_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - ) -> "GsaFullLayoutSection | None": - """Update a layout section. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - layout_guid: str - section_guid: str - body: GsaUpdateLayoutSection - - Returns - ------- - GsaFullLayoutSection | None - """ - data = self._update_section_with_http_info( - database_key, table_guid, layout_guid, section_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_section_with_http_info( - self, - database_key: "str", - table_guid: "str", - layout_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "layout_guid", - "section_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_section" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_section'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_section'" - ) - # verify the required parameter "layout_guid" is set - if "layout_guid" not in params or params["layout_guid"] is None: - raise ValueError( - "Missing the required parameter 'layout_guid' when calling 'update_section'" - ) - # verify the required parameter "section_guid" is set - if "section_guid" not in params or params["section_guid"] is None: - raise ValueError( - "Missing the required parameter 'section_guid' when calling 'update_section'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "layout_guid" in params and layout_guid is not None: - path_params["layout-guid"] = params["layout_guid"] - if "section_guid" in params and section_guid is not None: - path_params["section-guid"] = params["section_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFullLayoutSection", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_section_without_layout( - self, - *, - database_key: "str", - table_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - ) -> "GsaFullLayoutSection | None": - """Update a layout section. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - section_guid: str - body: GsaUpdateLayoutSection - - Returns - ------- - GsaFullLayoutSection | None - """ - data = self._update_section_without_layout_with_http_info( - database_key, table_guid, section_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_section_without_layout_with_http_info( - self, - database_key: "str", - table_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "section_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_section_without_layout" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_section_without_layout'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_section_without_layout'" - ) - # verify the required parameter "section_guid" is set - if "section_guid" not in params or params["section_guid"] is None: - raise ValueError( - "Missing the required parameter 'section_guid' when calling 'update_section_without_layout'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "section_guid" in params and section_guid is not None: - path_params["section-guid"] = params["section_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFullLayoutSection", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections/{section-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layouts_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layouts_api.py index f066dc95..2c3f2610 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layouts_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___layouts_api.py @@ -58,9 +58,7 @@ def applications( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -152,9 +150,7 @@ def create_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateLayout Returns @@ -260,9 +256,7 @@ def delete_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str Returns @@ -369,15 +363,13 @@ def get_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str show_full_detail: bool mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -504,9 +496,9 @@ def get_layouts( database_key: str table_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. application: str Optionally filter by application that the layout is applicable to. @@ -607,279 +599,6 @@ def _get_layouts_with_http_info( response_type_map=response_type_map, ) - def get_searchable_items_in_layout( - self, - *, - database_key: "str", - table_guid: "str", - layout_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GrantaMISearchFreeTextIdentifiers | None": - """Return the identifiers of items that should be included in a free text search over a specific layout - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - layout_guid: str - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GrantaMISearchFreeTextIdentifiers | None - """ - data = self._get_searchable_items_in_layout_with_http_info( - database_key, - table_guid, - layout_guid, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_searchable_items_in_layout_with_http_info( - self, - database_key: "str", - table_guid: "str", - layout_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "layout_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_searchable_items_in_layout" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_searchable_items_in_layout'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_searchable_items_in_layout'" - ) - # verify the required parameter "layout_guid" is set - if "layout_guid" not in params or params["layout_guid"] is None: - raise ValueError( - "Missing the required parameter 'layout_guid' when calling 'get_searchable_items_in_layout'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "layout_guid" in params and layout_guid is not None: - path_params["layout-guid"] = params["layout_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GrantaMISearchFreeTextIdentifiers", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/searchable-items", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def query_layouts( - self, - *, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - ) -> "GsaQueryLayoutsInfo | None": - """Query all layouts for table, optionally filter layouts returned - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - body: GsaQueryLayoutsRequest - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - application: str - cascade_filter: bool - If cascadeFilter is true, we apply the filter to the returned layout sections and items, as well as filtering the layouts themselves. - - Returns - ------- - GsaQueryLayoutsInfo | None - """ - data = self._query_layouts_with_http_info( - database_key, - table_guid, - body, - x_ansys_vc_mode, - mode, - application, - cascade_filter, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _query_layouts_with_http_info( - self, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "body", - "x_ansys_vc_mode", - "mode", - "application", - "cascade_filter", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_layouts" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_layouts'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'query_layouts'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - if "application" in params and application is not None: - query_params.append(("application", params["application"])) - if "cascade_filter" in params and cascade_filter is not None: - query_params.append(("cascadeFilter", params["cascade_filter"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryLayoutsInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_layout( self, *, @@ -895,9 +614,7 @@ def update_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str body: GsaUpdateLayout diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___parameters_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___parameters_api.py index 7d038d0c..85073576 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___parameters_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___parameters_api.py @@ -50,7 +50,7 @@ class SchemaParametersApi(ApiBase): def create_parameter( self, *, database_key: "str", body: "Optional[GsaCreateParameter]" = None - ) -> "GsaParameter | GsaParameterCreationException | None": + ) -> "GsaParameter | None": """Create a new parameter. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateParameter Returns ------- - GsaParameter | GsaParameterCreationException | None + GsaParameter | None """ data = self._create_parameter_with_http_info( database_key, body, _return_http_data_only=True @@ -121,7 +120,7 @@ def _create_parameter_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaParameter", - 400: "GsaParameterCreationException", + 400: None, 403: None, 404: None, } @@ -148,7 +147,7 @@ def create_parameter_value( database_key: "str", parameter_guid: "str", body: "Optional[GsaCreateParameterValue]" = None, - ) -> "GsaParameterValue | GsaParameterValueCreationException | None": + ) -> "GsaParameterValue | None": """Create a new parameter value. This method makes a synchronous HTTP request. @@ -156,13 +155,12 @@ def create_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str body: GsaCreateParameterValue Returns ------- - GsaParameterValue | GsaParameterValueCreationException | None + GsaParameterValue | None """ data = self._create_parameter_value_with_http_info( database_key, parameter_guid, body, _return_http_data_only=True @@ -232,7 +230,7 @@ def _create_parameter_value_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaParameterValue", - 400: "GsaParameterValueCreationException", + 400: None, 403: None, 404: None, } @@ -263,7 +261,6 @@ def delete_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str Returns @@ -357,7 +354,6 @@ def delete_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str parameter_value_guid: str @@ -460,7 +456,6 @@ def get_objects_using_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str Returns @@ -550,7 +545,6 @@ def get_parameter(self, *, database_key: "str", parameter_guid: "str") -> "GsaPa Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str Returns @@ -642,7 +636,6 @@ def get_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str parameter_value_guid: str @@ -741,7 +734,6 @@ def get_parameters(self, *, database_key: "str") -> "GsaParametersInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -816,7 +808,7 @@ def update_parameter( database_key: "str", parameter_guid: "str", body: "Optional[GsaUpdateParameter]" = None, - ) -> "GsaParameter | GsaParameterUpdateException | None": + ) -> "GsaParameter | None": """Update a parameter. This method makes a synchronous HTTP request. @@ -824,13 +816,12 @@ def update_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str body: GsaUpdateParameter Returns ------- - GsaParameter | GsaParameterUpdateException | None + GsaParameter | None """ data = self._update_parameter_with_http_info( database_key, parameter_guid, body, _return_http_data_only=True @@ -900,7 +891,7 @@ def _update_parameter_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaParameter", - 400: "GsaParameterUpdateException", + 400: None, 403: None, 404: None, } @@ -928,7 +919,7 @@ def update_parameter_value( parameter_guid: "str", parameter_value_guid: "str", body: "Optional[GsaUpdateParameterValue]" = None, - ) -> "GsaParameterValue | GsaParameterValueUpdateException | None": + ) -> "GsaParameterValue | None": """Update a parameter value. This method makes a synchronous HTTP request. @@ -936,14 +927,13 @@ def update_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str parameter_value_guid: str body: GsaUpdateParameterValue Returns ------- - GsaParameterValue | GsaParameterValueUpdateException | None + GsaParameterValue | None """ data = self._update_parameter_value_with_http_info( database_key, parameter_guid, parameter_value_guid, body, _return_http_data_only=True @@ -1022,7 +1012,7 @@ def _update_parameter_value_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaParameterValue", - 400: "GsaParameterValueUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___record_link_groups_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___record_link_groups_api.py index ca39dc8b..716b7901 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___record_link_groups_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___record_link_groups_api.py @@ -54,7 +54,7 @@ def create_record_link_group( database_key: "str", table_guid: "str", body: "Optional[GsaCreateRecordLinkGroup]" = None, - ) -> "GsaRecordLinkGroup | GsaRecordLinkGroupCreationException | None": + ) -> "GsaRecordLinkGroup | None": """Create a new record link group. This method makes a synchronous HTTP request. @@ -62,14 +62,12 @@ def create_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateRecordLinkGroup Returns ------- - GsaRecordLinkGroup | GsaRecordLinkGroupCreationException | None + GsaRecordLinkGroup | None """ data = self._create_record_link_group_with_http_info( database_key, table_guid, body, _return_http_data_only=True @@ -139,7 +137,7 @@ def _create_record_link_group_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaRecordLinkGroup", - 400: "GsaRecordLinkGroupCreationException", + 400: None, 403: None, 404: None, } @@ -175,12 +173,10 @@ def delete_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_link_group_guid: str record_link_group_type: str - The record link group type as entered. + The record link group type. Returns ------- @@ -302,16 +298,14 @@ def get_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_link_group_guid: str record_link_group_type: str - The record link group type as entered. + The record link group type. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -442,13 +436,11 @@ def get_record_link_groups( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -547,7 +539,7 @@ def update_record_link_group( table_guid: "str", record_link_group_guid: "str", body: "Optional[GsaUpdateRecordLinkGroup]" = None, - ) -> "GsaRecordLinkGroup | GsaRecordLinkGroupUpdateException | None": + ) -> "GsaRecordLinkGroup | None": """Update record link group. This method makes a synchronous HTTP request. @@ -555,15 +547,13 @@ def update_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_link_group_guid: str body: GsaUpdateRecordLinkGroup Returns ------- - GsaRecordLinkGroup | GsaRecordLinkGroupUpdateException | None + GsaRecordLinkGroup | None """ data = self._update_record_link_group_with_http_info( database_key, table_guid, record_link_group_guid, body, _return_http_data_only=True @@ -642,7 +632,7 @@ def _update_record_link_group_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaRecordLinkGroup", - 400: "GsaRecordLinkGroupUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_masks_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_masks_api.py deleted file mode 100644 index 1faa34a4..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_masks_api.py +++ /dev/null @@ -1,262 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaSearchMasksApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_search_mask( - self, - *, - database_key: "str", - search_mask_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchMask | None": - """Get a specific search mask by GUID. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - search_mask_guid: str - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchMask | None - """ - data = self._get_search_mask_with_http_info( - database_key, search_mask_guid, mode, x_ansys_vc_mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_mask_with_http_info( - self, - database_key: "str", - search_mask_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "search_mask_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_mask" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_mask'" - ) - # verify the required parameter "search_mask_guid" is set - if "search_mask_guid" not in params or params["search_mask_guid"] is None: - raise ValueError( - "Missing the required parameter 'search_mask_guid' when calling 'get_search_mask'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "search_mask_guid" in params and search_mask_guid is not None: - path_params["search-mask-guid"] = params["search_mask_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchMask", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/search-masks/{search-mask-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_search_masks( - self, - *, - database_key: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchMaskInfo | None": - """Get all search masks. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchMaskInfo | None - """ - data = self._get_search_masks_with_http_info( - database_key, mode, x_ansys_vc_mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_masks_with_http_info( - self, - database_key: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_masks" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_masks'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchMaskInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/search-masks", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_templates_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_templates_api.py deleted file mode 100644 index 973c8329..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___search_templates_api.py +++ /dev/null @@ -1,291 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaSearchTemplatesApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_search_template( - self, - *, - database_key: "str", - table_guid: "str", - search_template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchTemplate | None": - """Get a specific search template by GUID. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - search_template_guid: str - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchTemplate | None - """ - data = self._get_search_template_with_http_info( - database_key, - table_guid, - search_template_guid, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_search_template_with_http_info( - self, - database_key: "str", - table_guid: "str", - search_template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "search_template_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_template" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_template'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_search_template'" - ) - # verify the required parameter "search_template_guid" is set - if "search_template_guid" not in params or params["search_template_guid"] is None: - raise ValueError( - "Missing the required parameter 'search_template_guid' when calling 'get_search_template'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "search_template_guid" in params and search_template_guid is not None: - path_params["search-template-guid"] = params["search_template_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchTemplate", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates/{search-template-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_search_templates( - self, - *, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchTemplateInfo | None": - """Get all search templates for a table. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchTemplateInfo | None - """ - data = self._get_search_templates_with_http_info( - database_key, table_guid, mode, x_ansys_vc_mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_templates_with_http_info( - self, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_templates" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_templates'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_search_templates'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchTemplateInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___standard_names_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___standard_names_api.py index 8ac51629..0af24457 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___standard_names_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___standard_names_api.py @@ -50,7 +50,7 @@ class SchemaStandardNamesApi(ApiBase): def create_standard_name( self, *, database_key: "str", body: "Optional[GsaCreateStandardName]" = None - ) -> "GsaStandardName | GsaStandardNameCreationException | None": + ) -> "GsaStandardName | None": """Create a new standard name This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateStandardName Returns ------- - GsaStandardName | GsaStandardNameCreationException | None + GsaStandardName | None """ data = self._create_standard_name_with_http_info( database_key, body, _return_http_data_only=True @@ -121,7 +120,7 @@ def _create_standard_name_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaStandardName", - 400: "GsaStandardNameCreationException", + 400: None, 403: None, 404: None, } @@ -142,13 +141,7 @@ def _create_standard_name_with_http_info( response_type_map=response_type_map, ) - def delete_standard_name( - self, - *, - database_key: "str", - standard_name_guid: "str", - force_non_custom: "Optional[bool]" = False, - ) -> "GsaStandardNameDeletionException | None": + def delete_standard_name(self, *, database_key: "str", standard_name_guid: "str") -> "None": """Delete a standard name. This method makes a synchronous HTTP request. @@ -156,31 +149,23 @@ def delete_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) standard_name_guid: str - force_non_custom: bool - Optionally force the deletion for non-custom standard names. Returns ------- - GsaStandardNameDeletionException | None + None """ data = self._delete_standard_name_with_http_info( - database_key, standard_name_guid, force_non_custom, _return_http_data_only=True + database_key, standard_name_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] def _delete_standard_name_with_http_info( - self, - database_key: "str", - standard_name_guid: "str", - force_non_custom: "Optional[bool]" = False, - **kwargs: Any, + self, database_key: "str", standard_name_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "standard_name_guid", - "force_non_custom", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -214,8 +199,6 @@ def _delete_standard_name_with_http_info( path_params["standard-name-guid"] = params["standard_name_guid"] query_params: list[Any] = [] - if "force_non_custom" in params and force_non_custom is not None: - query_params.append(("forceNonCustom", params["force_non_custom"])) header_params: dict[str, Any] = {} @@ -223,12 +206,10 @@ def _delete_standard_name_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaStandardNameDeletionException", 200: None, + 400: None, 403: None, 404: None, } @@ -259,7 +240,6 @@ def get_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) standard_name_guid: str Returns @@ -349,7 +329,6 @@ def get_standard_names(self, *, database_key: "str") -> "GsaStandardNamesInfo | Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -424,8 +403,7 @@ def update_standard_name( database_key: "str", standard_name_guid: "str", body: "Optional[GsaUpdateStandardName]" = None, - force_non_custom: "Optional[bool]" = False, - ) -> "GsaStandardName | GsaStandardNameUpdateException | None": + ) -> "GsaStandardName | None": """Edit a standard name This method makes a synchronous HTTP request. @@ -433,18 +411,15 @@ def update_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) standard_name_guid: str body: GsaUpdateStandardName - force_non_custom: bool - Optionally force the update for non-custom standard names. Returns ------- - GsaStandardName | GsaStandardNameUpdateException | None + GsaStandardName | None """ data = self._update_standard_name_with_http_info( - database_key, standard_name_guid, body, force_non_custom, _return_http_data_only=True + database_key, standard_name_guid, body, _return_http_data_only=True ) return data # type: ignore[no-any-return] @@ -453,14 +428,12 @@ def _update_standard_name_with_http_info( database_key: "str", standard_name_guid: "str", body: "Optional[GsaUpdateStandardName]" = None, - force_non_custom: "Optional[bool]" = False, **kwargs: Any, ) -> Any: all_params = [ "database_key", "standard_name_guid", "body", - "force_non_custom", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -494,8 +467,6 @@ def _update_standard_name_with_http_info( path_params["standard-name-guid"] = params["standard_name_guid"] query_params: list[Any] = [] - if "force_non_custom" in params and force_non_custom is not None: - query_params.append(("forceNonCustom", params["force_non_custom"])) header_params: dict[str, Any] = {} @@ -515,7 +486,7 @@ def _update_standard_name_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaStandardName", - 400: "GsaStandardNameUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___subsets_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___subsets_api.py index 55124078..73549b55 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___subsets_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___subsets_api.py @@ -63,9 +63,7 @@ def add_to_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str body: GsaAddRecordHistoryToSubset @@ -178,9 +176,7 @@ def create_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateSubset Returns @@ -286,9 +282,7 @@ def delete_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str Returns @@ -394,14 +388,12 @@ def get_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -520,13 +512,11 @@ def get_subsets( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -631,9 +621,7 @@ def remove_from_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str body: GsaRemoveRecordHistoryFromSubset @@ -751,9 +739,7 @@ def update_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str body: GsaUpdateSubset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___tables_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___tables_api.py index 081ca935..39b41e94 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___tables_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___tables_api.py @@ -50,7 +50,7 @@ class SchemaTablesApi(ApiBase): def create_table( self, *, database_key: "str", body: "Optional[GsaCreateTable]" = None - ) -> "GsaTable | GsaTableCreationException | None": + ) -> "GsaTable | None": """Create a new table. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateTable Returns ------- - GsaTable | GsaTableCreationException | None + GsaTable | None """ data = self._create_table_with_http_info(database_key, body, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -119,7 +118,7 @@ def _create_table_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaTable", - 400: "GsaTableCreationException", + 400: None, 403: None, 404: None, } @@ -150,9 +149,7 @@ def delete_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -245,9 +242,7 @@ def enable_version_control( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -341,21 +336,18 @@ def get_inbound_links( ) -> "GsaLinksInfo | None": """Get all record link groups and tabular attributes pointing towards the table. - Note that all accessible databases will be checked. If write mode is requested, the user must have write access to all accessible databases. To use the latest versions available, don't set the version control mode. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) type: list[GsaLinkAttributeType] The link types to include in the response. If not provided, all link types are included. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -467,13 +459,11 @@ def get_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -561,101 +551,6 @@ def _get_table_with_http_info( response_type_map=response_type_map, ) - def get_table_permission_category_access_controls( - self, *, database_key: "str", table_guid: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given table. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_table_permission_category_access_controls_with_http_info( - database_key, table_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_table_permission_category_access_controls_with_http_info( - self, database_key: "str", table_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_table_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_table_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_table_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_tables( self, *, @@ -670,11 +565,10 @@ def get_tables( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- @@ -770,12 +664,11 @@ def query_tables( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaQueryTablesRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -878,9 +771,7 @@ def release_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -963,100 +854,9 @@ def _release_table_with_http_info( response_type_map=response_type_map, ) - def reorder_tables( - self, *, database_key: "str", body: "Optional[GsaReorderTablesRequest]" = None - ) -> "GsaReorderTablesException | GsaTablesInfo | None": - """Reorders the tables for a given database. No tables are added, deleted or modified. All the existing tables must be included in the request body. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaReorderTablesRequest - - Returns - ------- - GsaReorderTablesException | GsaTablesInfo | None - """ - data = self._reorder_tables_with_http_info(database_key, body, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _reorder_tables_with_http_info( - self, database_key: "str", body: "Optional[GsaReorderTablesRequest]" = None, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method reorder_tables" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'reorder_tables'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaTablesInfo", - 400: "GsaReorderTablesException", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables:reorder", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_table( self, *, database_key: "str", table_guid: "str", body: "Optional[GsaUpdateTable]" = None - ) -> "GsaTable | GsaTableUpdateException | None": + ) -> "GsaTable | None": """Update a table. This method makes a synchronous HTTP request. @@ -1064,14 +864,12 @@ def update_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaUpdateTable Returns ------- - GsaTable | GsaTableUpdateException | None + GsaTable | None """ data = self._update_table_with_http_info( database_key, table_guid, body, _return_http_data_only=True @@ -1141,7 +939,7 @@ def _update_table_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaTable", - 400: "GsaTableUpdateException", + 400: None, 403: None, 404: None, } @@ -1161,117 +959,3 @@ def _update_table_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def update_table_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given table. Sets the access control for the given permissions. - - Can also be run as a long-running operation at [Access Control - Permission-Based/UpdatePermissionCategoryAccessControlsOperation](#/Access%20Control%20-%20Permission-Based/UpdatePermissionCategoryAccessControlsOperation) - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_table_permission_category_access_controls_with_http_info( - database_key, table_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_table_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_table_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_table_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_table_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___unit_equivalents_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___unit_equivalents_api.py deleted file mode 100644 index 9815bdaf..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___unit_equivalents_api.py +++ /dev/null @@ -1,247 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaUnitEquivalentsApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_unit_equivalents( - self, - *, - database_key: "str", - unit_guid: "Optional[list[str]]" = None, - unit_system_guid: "Optional[list[str]]" = None, - ) -> "GsaGetUnitEquivalentsException | GsaUnitEquivalentsInfo | None": - """Get unit equivalents - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - unit_guid: list[str] - The GUIDs of the units to include in the response. If none are provided, all units are included. - unit_system_guid: list[str] - The GUIDs of the unit systems to include in the response. If none are provided, all unit systems are included. - - Returns - ------- - GsaGetUnitEquivalentsException | GsaUnitEquivalentsInfo | None - """ - data = self._get_unit_equivalents_with_http_info( - database_key, unit_guid, unit_system_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_unit_equivalents_with_http_info( - self, - database_key: "str", - unit_guid: "Optional[list[str]]" = None, - unit_system_guid: "Optional[list[str]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "unit_guid", - "unit_system_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_unit_equivalents" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_unit_equivalents'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "unit_guid" in params and unit_guid is not None: - query_params.append(("unit-guid", params["unit_guid"])) - collection_formats["unit-guid"] = "multi" - if "unit_system_guid" in params and unit_system_guid is not None: - query_params.append(("unit-system-guid", params["unit_system_guid"])) - collection_formats["unit-system-guid"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaUnitEquivalentsInfo", - 400: "GsaGetUnitEquivalentsException", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/unit-equivalents", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def set_unit_equivalents( - self, *, database_key: "str", body: "Optional[GsaSetUnitEquivalentsInfo]" = None - ) -> "GsaSetUnitEquivalentsException | GsaUnitEquivalentsInfo | None": - """Update one or more unit equivalents. Returns the unit equivalents that have been updated. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaSetUnitEquivalentsInfo - - Returns - ------- - GsaSetUnitEquivalentsException | GsaUnitEquivalentsInfo | None - """ - data = self._set_unit_equivalents_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _set_unit_equivalents_with_http_info( - self, database_key: "str", body: "Optional[GsaSetUnitEquivalentsInfo]" = None, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method set_unit_equivalents" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'set_unit_equivalents'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaUnitEquivalentsInfo", - 400: "GsaSetUnitEquivalentsException", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/unit-equivalents:update", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___units_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___units_api.py index aa17c2e5..dfc3263b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___units_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___units_api.py @@ -50,7 +50,7 @@ class SchemaUnitsApi(ApiBase): def create_unit( self, *, database_key: "str", body: "Optional[GsaCreateUnit]" = None - ) -> "GsaUnit | GsaUnitCreationException | None": + ) -> "GsaUnit | None": """Create a new unit. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_unit( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateUnit Returns ------- - GsaUnit | GsaUnitCreationException | None + GsaUnit | None """ data = self._create_unit_with_http_info(database_key, body, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -117,7 +116,7 @@ def _create_unit_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaUnit", - 400: "GsaUnitCreationException", + 400: None, 403: None, 404: None, } @@ -148,7 +147,6 @@ def create_unit_system( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateUnitSystem Returns @@ -232,9 +230,7 @@ def _create_unit_system_with_http_info( response_type_map=response_type_map, ) - def delete_unit( - self, *, database_key: "str", unit_guid: "str" - ) -> "GsaUnitDeletionException | None": + def delete_unit(self, *, database_key: "str", unit_guid: "str") -> "None": """Delete unit. This method makes a synchronous HTTP request. @@ -242,12 +238,11 @@ def delete_unit( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str Returns ------- - GsaUnitDeletionException | None + None """ data = self._delete_unit_with_http_info( database_key, unit_guid, _return_http_data_only=True @@ -298,12 +293,10 @@ def _delete_unit_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaUnitDeletionException", 200: None, + 400: None, 403: None, 404: None, } @@ -332,7 +325,6 @@ def delete_unit_system(self, *, database_key: "str", unit_system_guid: "str") -> Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_system_guid: str Returns @@ -424,7 +416,6 @@ def get_compatible_units( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str Returns @@ -514,7 +505,6 @@ def get_unit(self, *, database_key: "str", unit_guid: "str") -> "GsaUnit | None" Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str Returns @@ -590,7 +580,7 @@ def _get_unit_with_http_info(self, database_key: "str", unit_guid: "str", **kwar def get_unit_conversions( self, *, database_key: "str", body: "Optional[GsaGetUnitConversionsRequest]" = None - ) -> "GsaUnitConversionsInfo | None": + ) -> "GsaUnitConversionsInfo": """Gets all the equivalent units and their conversion factors for the specified source units, including any errors that occurred. This method makes a synchronous HTTP request. @@ -598,12 +588,11 @@ def get_unit_conversions( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaGetUnitConversionsRequest Returns ------- - GsaUnitConversionsInfo | None + GsaUnitConversionsInfo """ data = self._get_unit_conversions_with_http_info( database_key, body, _return_http_data_only=True @@ -664,7 +653,6 @@ def _get_unit_conversions_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaUnitConversionsInfo", - 400: None, } return self.api_client.call_api( @@ -683,6 +671,97 @@ def _get_unit_conversions_with_http_info( response_type_map=response_type_map, ) + def get_unit_equivalents( + self, *, database_key: "str", unit_guid: "str" + ) -> "GsaUnitEquivalentsInfo | None": + """Get equivalent units (one per unit system) + + This method makes a synchronous HTTP request. + + Parameters + ---------- + database_key: str + unit_guid: str + + Returns + ------- + GsaUnitEquivalentsInfo | None + """ + data = self._get_unit_equivalents_with_http_info( + database_key, unit_guid, _return_http_data_only=True + ) + return data # type: ignore[no-any-return] + + def _get_unit_equivalents_with_http_info( + self, database_key: "str", unit_guid: "str", **kwargs: Any + ) -> Any: + all_params = [ + "database_key", + "unit_guid", + "_return_http_data_only", + "_preload_content", + "_request_timeout", + ] + + params = locals() + for key, val in params["kwargs"].items(): + if key not in all_params: + raise TypeError( + f"Got an unexpected keyword argument '{key}' to method get_unit_equivalents" + ) + params[key] = val + del params["kwargs"] + # verify the required parameter "database_key" is set + if "database_key" not in params or params["database_key"] is None: + raise ValueError( + "Missing the required parameter 'database_key' when calling 'get_unit_equivalents'" + ) + # verify the required parameter "unit_guid" is set + if "unit_guid" not in params or params["unit_guid"] is None: + raise ValueError( + "Missing the required parameter 'unit_guid' when calling 'get_unit_equivalents'" + ) + + collection_formats: dict[str, Any] = {} + + path_params: dict[str, Any] = {} + if "database_key" in params and database_key is not None: + path_params["database-key"] = params["database_key"] + if "unit_guid" in params and unit_guid is not None: + path_params["unit-guid"] = params["unit_guid"] + + query_params: list[Any] = [] + + header_params: dict[str, Any] = {} + + form_params: list[Any] = [] + local_var_files: dict[str, Any] = {} + + body_params = None + # HTTP header 'Accept' + header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + + response_type_map: dict[int, Optional[str]] = { + 200: "GsaUnitEquivalentsInfo", + 404: None, + } + + return self.api_client.call_api( + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units", + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + _return_http_data_only=params.get("_return_http_data_only"), + _preload_content=params.get("_preload_content", True), + _request_timeout=params.get("_request_timeout"), + collection_formats=collection_formats, + response_type_map=response_type_map, + ) + def get_unit_system( self, *, database_key: "str", unit_system_guid: "str" ) -> "GsaUnitSystem | None": @@ -693,7 +772,6 @@ def get_unit_system( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_system_guid: str Returns @@ -783,7 +861,6 @@ def get_unit_systems(self, *, database_key: "str") -> "GsaUnitSystemsInfo | None Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -852,13 +929,7 @@ def _get_unit_systems_with_http_info(self, database_key: "str", **kwargs: Any) - response_type_map=response_type_map, ) - def get_unit_usages( - self, - *, - database_key: "str", - unit_guid: "str", - response_filters: "Optional[list[GsaUnitUsageType]]" = None, - ) -> "GsaUnitUsage | None": + def get_unit_usages(self, *, database_key: "str", unit_guid: "str") -> "GsaUnitUsage | None": """Get all usages of unit This method makes a synchronous HTTP request. @@ -866,31 +937,23 @@ def get_unit_usages( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str - response_filters: list[GsaUnitUsageType] - The unit usage types to include in the response. If none are provided, all types are included. Returns ------- GsaUnitUsage | None """ data = self._get_unit_usages_with_http_info( - database_key, unit_guid, response_filters, _return_http_data_only=True + database_key, unit_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] def _get_unit_usages_with_http_info( - self, - database_key: "str", - unit_guid: "str", - response_filters: "Optional[list[GsaUnitUsageType]]" = None, - **kwargs: Any, + self, database_key: "str", unit_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "unit_guid", - "response_filters", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -924,9 +987,6 @@ def _get_unit_usages_with_http_info( path_params["unit-guid"] = params["unit_guid"] query_params: list[Any] = [] - if "response_filters" in params and response_filters is not None: - query_params.append(("response-filters", params["response_filters"])) - collection_formats["response-filters"] = "multi" header_params: dict[str, Any] = {} @@ -966,7 +1026,6 @@ def get_units(self, *, database_key: "str") -> "GsaUnitsInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1033,32 +1092,51 @@ def _get_units_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_units_grouped_by_compatibility( - self, *, database_key: "str" - ) -> "GsaUnitsGroupingInfo | None": - """Get units grouped by compatibility, each grouping contains only compatible units + def set_unit_equivalent( + self, + *, + database_key: "str", + unit_guid: "str", + unit_system_guid: "str", + equivalent_unit_guid: "str", + ) -> "None": + """Set the equivalent unit for a given unit system This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) + unit_guid: str + unit_system_guid: str + equivalent_unit_guid: str Returns ------- - GsaUnitsGroupingInfo | None + None """ - data = self._get_units_grouped_by_compatibility_with_http_info( - database_key, _return_http_data_only=True + data = self._set_unit_equivalent_with_http_info( + database_key, + unit_guid, + unit_system_guid, + equivalent_unit_guid, + _return_http_data_only=True, ) return data # type: ignore[no-any-return] - def _get_units_grouped_by_compatibility_with_http_info( - self, database_key: "str", **kwargs: Any + def _set_unit_equivalent_with_http_info( + self, + database_key: "str", + unit_guid: "str", + unit_system_guid: "str", + equivalent_unit_guid: "str", + **kwargs: Any, ) -> Any: all_params = [ "database_key", + "unit_guid", + "unit_system_guid", + "equivalent_unit_guid", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -1068,14 +1146,29 @@ def _get_units_grouped_by_compatibility_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_units_grouped_by_compatibility" + f"Got an unexpected keyword argument '{key}' to method set_unit_equivalent" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_units_grouped_by_compatibility'" + "Missing the required parameter 'database_key' when calling 'set_unit_equivalent'" + ) + # verify the required parameter "unit_guid" is set + if "unit_guid" not in params or params["unit_guid"] is None: + raise ValueError( + "Missing the required parameter 'unit_guid' when calling 'set_unit_equivalent'" + ) + # verify the required parameter "unit_system_guid" is set + if "unit_system_guid" not in params or params["unit_system_guid"] is None: + raise ValueError( + "Missing the required parameter 'unit_system_guid' when calling 'set_unit_equivalent'" + ) + # verify the required parameter "equivalent_unit_guid" is set + if "equivalent_unit_guid" not in params or params["equivalent_unit_guid"] is None: + raise ValueError( + "Missing the required parameter 'equivalent_unit_guid' when calling 'set_unit_equivalent'" ) collection_formats: dict[str, Any] = {} @@ -1083,6 +1176,12 @@ def _get_units_grouped_by_compatibility_with_http_info( path_params: dict[str, Any] = {} if "database_key" in params and database_key is not None: path_params["database-key"] = params["database_key"] + if "unit_guid" in params and unit_guid is not None: + path_params["unit-guid"] = params["unit_guid"] + if "unit_system_guid" in params and unit_system_guid is not None: + path_params["unit-system-guid"] = params["unit_system_guid"] + if "equivalent_unit_guid" in params and equivalent_unit_guid is not None: + path_params["equivalent-unit-guid"] = params["equivalent_unit_guid"] query_params: list[Any] = [] @@ -1092,17 +1191,15 @@ def _get_units_grouped_by_compatibility_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaUnitsGroupingInfo", + 200: None, 404: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/units-grouped-by-compatibility", - "GET", + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units/unit-system/{unit-system-guid}/equivalent-unit/{equivalent-unit-guid}:set-equivalent-unit", + "POST", path_params, query_params, header_params, @@ -1118,7 +1215,7 @@ def _get_units_grouped_by_compatibility_with_http_info( def update_unit( self, *, database_key: "str", unit_guid: "str", body: "Optional[GsaUpdateUnit]" = None - ) -> "GsaUnit | GsaUnitUpdateException | None": + ) -> "GsaUnit | None": """Update unit. This method makes a synchronous HTTP request. @@ -1126,13 +1223,12 @@ def update_unit( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str body: GsaUpdateUnit Returns ------- - GsaUnit | GsaUnitUpdateException | None + GsaUnit | None """ data = self._update_unit_with_http_info( database_key, unit_guid, body, _return_http_data_only=True @@ -1200,7 +1296,7 @@ def _update_unit_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaUnit", - 400: "GsaUnitUpdateException", + 400: None, 403: None, 404: None, } @@ -1235,7 +1331,6 @@ def update_unit_system( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_system_guid: str body: GsaUpdateUnitSystem @@ -1331,99 +1426,3 @@ def _update_unit_system_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def validate_unit_equation( - self, *, database_key: "str", body: "Optional[GsaValidateUnitEquationRequest]" = None - ) -> "GsaValidateUnitEquationResponse | None": - """Check whether the unit equation is valid. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaValidateUnitEquationRequest - - Returns - ------- - GsaValidateUnitEquationResponse | None - """ - data = self._validate_unit_equation_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _validate_unit_equation_with_http_info( - self, - database_key: "str", - body: "Optional[GsaValidateUnitEquationRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method validate_unit_equation" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'validate_unit_equation'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaValidateUnitEquationResponse", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/units:validate-equation", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___xy_chart_templates_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___xy_chart_templates_api.py deleted file mode 100644 index 733951b8..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___xy_chart_templates_api.py +++ /dev/null @@ -1,309 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaXYChartTemplatesApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_template( - self, - *, - database_key: "str", - table_guid: "str", - template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaXYChartTemplate | None": - """Get XY chart template in database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - template_guid: str - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaXYChartTemplate | None - """ - data = self._get_template_with_http_info( - database_key, - table_guid, - template_guid, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_template_with_http_info( - self, - database_key: "str", - table_guid: "str", - template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "template_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_template" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_template'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_template'" - ) - # verify the required parameter "template_guid" is set - if "template_guid" not in params or params["template_guid"] is None: - raise ValueError( - "Missing the required parameter 'template_guid' when calling 'get_template'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["tableGuid"] = params["table_guid"] - if "template_guid" in params and template_guid is not None: - path_params["templateGuid"] = params["template_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaXYChartTemplate", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates/{templateGuid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_templates( - self, - *, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - page_size: "Optional[int]" = 10, - page: "Optional[int]" = 1, - ) -> "GsaXYChartTemplatesInfo | None": - """Get XY chart templates in database - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - page_size: int - page: int - - Returns - ------- - GsaXYChartTemplatesInfo | None - """ - data = self._get_templates_with_http_info( - database_key, - table_guid, - mode, - x_ansys_vc_mode, - page_size, - page, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_templates_with_http_info( - self, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - page_size: "Optional[int]" = 10, - page: "Optional[int]" = 1, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "mode", - "x_ansys_vc_mode", - "page_size", - "page", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_templates" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_templates'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_templates'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["tableGuid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - if "page_size" in params and page_size is not None: - query_params.append(("pageSize", params["page_size"])) - if "page" in params and page is not None: - query_params.append(("page", params["page"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaXYChartTemplatesInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema_api.py index d4b64d6f..66eaae76 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema_api.py @@ -48,25 +48,27 @@ class SchemaApi(ApiBase): Ref: https://github.com/swagger-api/swagger-codegen """ - def get_version(self) -> "GsaMiVersion": - """Returns the currently running MI version to the caller. + def get_security_attribute_groupings(self) -> "dict[str, list[GsaSecurityAttributeGrouping]]": + """Gets all security attribute groupings for a given database. This method makes a synchronous HTTP request. Returns ------- - GsaMiVersion + dict[str, list[GsaSecurityAttributeGrouping]] """ - data = self._get_version_with_http_info(_return_http_data_only=True) + data = self._get_security_attribute_groupings_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_version_with_http_info(self, **kwargs: Any) -> Any: + def _get_security_attribute_groupings_with_http_info(self, **kwargs: Any) -> Any: all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_version") + raise TypeError( + f"Got an unexpected keyword argument '{key}' to method get_security_attribute_groupings" + ) params[key] = val del params["kwargs"] @@ -86,11 +88,11 @@ def _get_version_with_http_info(self, **kwargs: Any) -> Any: header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaMiVersion", + 200: "dict(str, list[GsaSecurityAttributeGrouping])", } return self.api_client.call_api( - "/v1alpha/schema/mi-version", + "/v1alpha/security-attribute-groupings", "GET", path_params, query_params, @@ -105,57 +107,25 @@ def _get_version_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def resolve_link_targets( - self, - *, - body: "Optional[GsaResolveLinkTargetsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaResolveLinkTargetsInfo | None": - """Gets all target tables that match the provided link target, for each target. There could be several matches or no matches for each link target. For example if two databases are loaded with the same databaseGuid and the databaseVersionGuid isn't specified, or if the databaseGuid and databaseVersionGuid are not specified and the tableGuid matches in several databases. There could be no matches if the target database is not loaded. + def get_version(self) -> "GsaMiVersion": + """Returns the currently running MI version to the caller. - Note that all accessible databases will be checked. If write mode is requested, the user must have write access to all accessible databases. To use the latest versions available, don't set the version control mode. This method makes a synchronous HTTP request. - Parameters - ---------- - body: GsaResolveLinkTargetsRequest - x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - Returns ------- - GsaResolveLinkTargetsInfo | None + GsaMiVersion """ - data = self._resolve_link_targets_with_http_info( - body, x_ansys_vc_mode, mode, _return_http_data_only=True - ) + data = self._get_version_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _resolve_link_targets_with_http_info( - self, - body: "Optional[GsaResolveLinkTargetsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] + def _get_version_with_http_info(self, **kwargs: Any) -> Any: + all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method resolve_link_targets" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_version") params[key] = val del params["kwargs"] @@ -164,35 +134,23 @@ def _resolve_link_targets_with_http_info( path_params: dict[str, Any] = {} query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] form_params: list[Any] = [] local_var_files: dict[str, Any] = {} body_params = None - if "body" in params and body is not None: - body_params = params["body"] # HTTP header 'Accept' header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - response_type_map: dict[int, Optional[str]] = { - 200: "GsaResolveLinkTargetsInfo", - 400: None, + 200: "GsaMiVersion", } return self.api_client.call_api( - "/v1alpha/schema:resolve-link-targets", - "POST", + "/v1alpha/schema/mi-version", + "GET", path_params, query_params, header_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/search_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/search_api.py index a333c94a..41df9149 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/search_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/search_api.py @@ -63,12 +63,11 @@ def database_search( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaSearchRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -177,14 +176,12 @@ def database_search_in_table_with_guid( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaSearchRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- @@ -302,13 +299,12 @@ def database_search_in_table_with_identity( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_identity: int body: GsaSearchRequest x_ansys_vc_mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. mode: str - The version control mode. - If set to read, uses the latest version of records and tables available in read mode. - If set to write, uses the latest version of records and tables available in write mode, and will error if the user does not have write access to the database. - If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. + The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. Returns ------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___security_groups_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/selection_searches_api.py similarity index 64% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___security_groups_api.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/selection_searches_api.py index 7bef3224..f27981d9 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/schema___security_groups_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/selection_searches_api.py @@ -41,68 +41,48 @@ from ..models import * -class SchemaSecurityGroupsApi(ApiBase): +class SelectionSearchesApi(ApiBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen """ - def add_database_security_groups( - self, *, database_key: "str", body: "Optional[GsaAddDatabaseSecurityGroups]" = None - ) -> "GsaDatabaseSecurityGroups | None": - """Adds security groups for a specific database. + def create_search( + self, *, body: "Optional[GsaCreateSearchRequest]" = None + ) -> "GsaSelectionSearch | None": + """Creates a new search with the specified properties. This method makes a synchronous HTTP request. Parameters ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaAddDatabaseSecurityGroups + body: GsaCreateSearchRequest Returns ------- - GsaDatabaseSecurityGroups | None + GsaSelectionSearch | None """ - data = self._add_database_security_groups_with_http_info( - database_key, body, _return_http_data_only=True - ) + data = self._create_search_with_http_info(body, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _add_database_security_groups_with_http_info( - self, - database_key: "str", - body: "Optional[GsaAddDatabaseSecurityGroups]" = None, - **kwargs: Any, + def _create_search_with_http_info( + self, body: "Optional[GsaCreateSearchRequest]" = None, **kwargs: Any ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] + all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method add_database_security_groups" + f"Got an unexpected keyword argument '{key}' to method create_search" ) params[key] = val del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'add_database_security_groups'" - ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] query_params: list[Any] = [] @@ -115,7 +95,9 @@ def _add_database_security_groups_with_http_info( if "body" in params and body is not None: body_params = params["body"] # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( @@ -123,15 +105,13 @@ def _add_database_security_groups_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabaseSecurityGroups", - 201: None, + 201: "GsaSelectionSearch", 400: None, 403: None, - 409: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases/{databaseKey}", + "/v1alpha/selection-searches", "POST", path_params, query_params, @@ -146,33 +126,49 @@ def _add_database_security_groups_with_http_info( response_type_map=response_type_map, ) - def get_database_security_groups(self) -> "GsaDatabaseSecurityGroupsInfo | None": - """Returns the prevailing security groups defined for each database. + def delete_search(self, *, search_identifier: "str") -> "None": + """Delete an existing selection search. This method makes a synchronous HTTP request. + Parameters + ---------- + search_identifier: str + Returns ------- - GsaDatabaseSecurityGroupsInfo | None + None """ - data = self._get_database_security_groups_with_http_info(_return_http_data_only=True) + data = self._delete_search_with_http_info(search_identifier, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_database_security_groups_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] + def _delete_search_with_http_info(self, search_identifier: "str", **kwargs: Any) -> Any: + all_params = [ + "search_identifier", + "_return_http_data_only", + "_preload_content", + "_request_timeout", + ] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_database_security_groups" + f"Got an unexpected keyword argument '{key}' to method delete_search" ) params[key] = val del params["kwargs"] + # verify the required parameter "search_identifier" is set + if "search_identifier" not in params or params["search_identifier"] is None: + raise ValueError( + "Missing the required parameter 'search_identifier' when calling 'delete_search'" + ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} + if "search_identifier" in params and search_identifier is not None: + path_params["searchIdentifier"] = params["search_identifier"] query_params: list[Any] = [] @@ -182,17 +178,16 @@ def _get_database_security_groups_with_http_info(self, **kwargs: Any) -> Any: local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabaseSecurityGroupsInfo", + 200: None, 403: None, + 404: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases", - "GET", + "/v1alpha/selection-searches/search/{searchIdentifier}", + "DELETE", path_params, query_params, header_params, @@ -206,29 +201,25 @@ def _get_database_security_groups_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_default_fallback_security_groups(self) -> "GsaDefaultFallbackSecurityGroups | None": - """Returns the default fallback (global) security groups. + def get_all(self) -> "None | list[GsaSelectionSearch]": + """Returns all searches visible to the calling user. This method makes a synchronous HTTP request. Returns ------- - GsaDefaultFallbackSecurityGroups | None + None | list[GsaSelectionSearch] """ - data = self._get_default_fallback_security_groups_with_http_info( - _return_http_data_only=True - ) + data = self._get_all_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_default_fallback_security_groups_with_http_info(self, **kwargs: Any) -> Any: + def _get_all_with_http_info(self, **kwargs: Any) -> Any: all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_fallback_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_all") params[key] = val del params["kwargs"] @@ -245,15 +236,17 @@ def _get_default_fallback_security_groups_with_http_info(self, **kwargs: Any) -> body_params = None # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDefaultFallbackSecurityGroups", + 200: "list[GsaSelectionSearch]", 403: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/defaultFallback", + "/v1alpha/selection-searches", "GET", path_params, query_params, @@ -268,30 +261,25 @@ def _get_default_fallback_security_groups_with_http_info(self, **kwargs: Any) -> response_type_map=response_type_map, ) - def remove_database_security_groups(self, *, database_key: "str") -> "None": - """Deletes the security groups defined for a specific database. + def get_search(self, *, search_identifier: "str") -> "GsaSelectionSearch | None": + """Returns the given search if it exists and the calling user has access to it This method makes a synchronous HTTP request. Parameters ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) + search_identifier: str Returns ------- - None + GsaSelectionSearch | None """ - data = self._remove_database_security_groups_with_http_info( - database_key, _return_http_data_only=True - ) + data = self._get_search_with_http_info(search_identifier, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _remove_database_security_groups_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: + def _get_search_with_http_info(self, search_identifier: "str", **kwargs: Any) -> Any: all_params = [ - "database_key", + "search_identifier", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -300,22 +288,20 @@ def _remove_database_security_groups_with_http_info( params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method remove_database_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_search") params[key] = val del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: + # verify the required parameter "search_identifier" is set + if "search_identifier" not in params or params["search_identifier"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'remove_database_security_groups'" + "Missing the required parameter 'search_identifier' when calling 'get_search'" ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] + if "search_identifier" in params and search_identifier is not None: + path_params["searchIdentifier"] = params["search_identifier"] query_params: list[Any] = [] @@ -325,17 +311,21 @@ def _remove_database_security_groups_with_http_info( local_var_files: dict[str, Any] = {} body_params = None + # HTTP header 'Accept' + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: None, - 204: None, + 200: "GsaSelectionSearch", 403: None, 404: None, + 410: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases/{databaseKey}", - "DELETE", + "/v1alpha/selection-searches/search/{searchIdentifier}", + "GET", path_params, query_params, header_params, @@ -349,36 +339,32 @@ def _remove_database_security_groups_with_http_info( response_type_map=response_type_map, ) - def update_database_security_groups( - self, *, database_key: "str", body: "Optional[GsaUpdateDatabaseSecurityGroups]" = None - ) -> "GsaDatabaseSecurityGroups | None": - """Updates the security groups for a specific database. + def save_search( + self, *, search_identifier: "str", body: "Optional[GsaSaveSearchRequest]" = None + ) -> "None": + """If the search exists, updates the properties of the search. This will overwrite all current properties. If the search does not exist or the calling user does not have access to it, returns '404 not found' response. This method makes a synchronous HTTP request. Parameters ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaUpdateDatabaseSecurityGroups + search_identifier: str + body: GsaSaveSearchRequest Returns ------- - GsaDatabaseSecurityGroups | None + None """ - data = self._update_database_security_groups_with_http_info( - database_key, body, _return_http_data_only=True + data = self._save_search_with_http_info( + search_identifier, body, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _update_database_security_groups_with_http_info( - self, - database_key: "str", - body: "Optional[GsaUpdateDatabaseSecurityGroups]" = None, - **kwargs: Any, + def _save_search_with_http_info( + self, search_identifier: "str", body: "Optional[GsaSaveSearchRequest]" = None, **kwargs: Any ) -> Any: all_params = [ - "database_key", + "search_identifier", "body", "_return_http_data_only", "_preload_content", @@ -388,22 +374,20 @@ def _update_database_security_groups_with_http_info( params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_database_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method save_search") params[key] = val del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: + # verify the required parameter "search_identifier" is set + if "search_identifier" not in params or params["search_identifier"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_database_security_groups'" + "Missing the required parameter 'search_identifier' when calling 'save_search'" ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] + if "search_identifier" in params and search_identifier is not None: + path_params["searchIdentifier"] = params["search_identifier"] query_params: list[Any] = [] @@ -415,24 +399,21 @@ def _update_database_security_groups_with_http_info( body_params = None if "body" in params and body is not None: body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( ["application/json-patch+json", "application/json", "text/json", "application/*+json"] ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabaseSecurityGroups", + 200: None, 400: None, 403: None, 404: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases/{databaseKey}", - "PATCH", + "/v1alpha/selection-searches/search/{searchIdentifier}", + "PUT", path_params, query_params, header_params, @@ -446,37 +427,33 @@ def _update_database_security_groups_with_http_info( response_type_map=response_type_map, ) - def update_default_fallback_security_groups( - self, *, body: "Optional[GsaUpdateDefaultFallbackSecurityGroups]" = None - ) -> "GsaDefaultFallbackSecurityGroups | None": - """Updates the default fallback (global) security groups. + def search( + self, *, body: "Optional[GsaFindSearchRequest]" = None + ) -> "GsaSelectionSearch | None": + """Retrieves a collection of searches that match the specified criteria. This method makes a synchronous HTTP request. Parameters ---------- - body: GsaUpdateDefaultFallbackSecurityGroups + body: GsaFindSearchRequest Returns ------- - GsaDefaultFallbackSecurityGroups | None + GsaSelectionSearch | None """ - data = self._update_default_fallback_security_groups_with_http_info( - body, _return_http_data_only=True - ) + data = self._search_with_http_info(body, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _update_default_fallback_security_groups_with_http_info( - self, body: "Optional[GsaUpdateDefaultFallbackSecurityGroups]" = None, **kwargs: Any + def _search_with_http_info( + self, body: "Optional[GsaFindSearchRequest]" = None, **kwargs: Any ) -> Any: all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_default_fallback_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method search") params[key] = val del params["kwargs"] @@ -495,7 +472,9 @@ def _update_default_fallback_security_groups_with_http_info( if "body" in params and body is not None: body_params = params["body"] # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( @@ -503,14 +482,14 @@ def _update_default_fallback_security_groups_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDefaultFallbackSecurityGroups", + 200: "GsaSelectionSearch", 400: None, 403: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/defaultFallback", - "PATCH", + "/v1alpha/selection-searches/search", + "POST", path_params, query_params, header_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/currencies_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/server_manager_api.py similarity index 71% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/currencies_api.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/server_manager_api.py index 97709a8e..267d5509 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/currencies_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/server_manager_api.py @@ -41,33 +41,33 @@ from ..models import * -class CurrenciesApi(ApiBase): +class ServerManagerApi(ApiBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen """ - def get_currencies(self) -> "GsaCurrenciesInfo | None": - """All the currencies configured on the server. + def get_smtp_properties(self) -> "GsaSmtpProperties": + """get_smtp_properties This method makes a synchronous HTTP request. Returns ------- - GsaCurrenciesInfo | None + GsaSmtpProperties """ - data = self._get_currencies_with_http_info(_return_http_data_only=True) + data = self._get_smtp_properties_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_currencies_with_http_info(self, **kwargs: Any) -> Any: + def _get_smtp_properties_with_http_info(self, **kwargs: Any) -> Any: all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_currencies" + f"Got an unexpected keyword argument '{key}' to method get_smtp_properties" ) params[key] = val del params["kwargs"] @@ -85,15 +85,16 @@ def _get_currencies_with_http_info(self, **kwargs: Any) -> Any: body_params = None # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaCurrenciesInfo", - 403: None, + 200: "GsaSmtpProperties", } return self.api_client.call_api( - "/v1alpha/currencies", + "/v1alpha/serverManager/email", "GET", path_params, query_params, @@ -108,49 +109,35 @@ def _get_currencies_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_currency(self, *, currency_code: "str") -> "GsaCurrency | None": - """Gets the currency with the specified code. + def put(self, *, body: "Optional[GsaSmtpProperties]" = None) -> "None": + """put This method makes a synchronous HTTP request. Parameters ---------- - currency_code: str + body: GsaSmtpProperties Returns ------- - GsaCurrency | None + None """ - data = self._get_currency_with_http_info(currency_code, _return_http_data_only=True) + data = self._put_with_http_info(body, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_currency_with_http_info(self, currency_code: "str", **kwargs: Any) -> Any: - all_params = [ - "currency_code", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] + def _put_with_http_info(self, body: "Optional[GsaSmtpProperties]" = None, **kwargs: Any) -> Any: + all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_currency" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method put") params[key] = val del params["kwargs"] - # verify the required parameter "currency_code" is set - if "currency_code" not in params or params["currency_code"] is None: - raise ValueError( - "Missing the required parameter 'currency_code' when calling 'get_currency'" - ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "currency_code" in params and currency_code is not None: - path_params["currencyCode"] = params["currency_code"] query_params: list[Any] = [] @@ -160,18 +147,20 @@ def _get_currency_with_http_info(self, currency_code: "str", **kwargs: Any) -> A local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + if "body" in params and body is not None: + body_params = params["body"] + # HTTP header 'Content-Type' + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json-patch+json", "application/json", "text/json", "application/*+json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaCurrency", - 403: None, - 404: None, + 200: None, } return self.api_client.call_api( - "/v1alpha/currencies/{currencyCode}", - "GET", + "/v1alpha/serverManager/email", + "PUT", path_params, query_params, header_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/status_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/status_api.py index 03ea6d62..1a9c5abc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/status_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/api/status_api.py @@ -111,7 +111,6 @@ def get_database_status(self, *, database_key: "str") -> "GsaDatabaseStatusInfor Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -242,157 +241,6 @@ def _get_search_cluster_status_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_search_index_status_async( - self, *, database_key: "str", include_error_details: "Optional[bool]" = True - ) -> "GsaSearchIndexStatus | None": - """Returns information about the Search Index status - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - include_error_details: bool - - Returns - ------- - GsaSearchIndexStatus | None - """ - data = self._get_search_index_status_async_with_http_info( - database_key, include_error_details, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_index_status_async_with_http_info( - self, database_key: "str", include_error_details: "Optional[bool]" = True, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "include_error_details", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_index_status_async" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_index_status_async'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] - - query_params: list[Any] = [] - if "include_error_details" in params and include_error_details is not None: - query_params.append(("includeErrorDetails", params["include_error_details"])) - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchIndexStatus", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/status/databases/{databaseKey}/searchIndexStatus", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_search_service_status_async(self) -> "GsaSearchServiceStatus | None": - """Returns information about the Search Service status - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaSearchServiceStatus | None - """ - data = self._get_search_service_status_async_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_search_service_status_async_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_service_status_async" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchServiceStatus", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/status/searchServiceStatus", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_status(self) -> "list[GsaDatabaseStatusInformation]": """Returns status information for all databases diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/__init__.py index 1dcb93a7..606f2dd8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/__init__.py @@ -51,60 +51,14 @@ from .granta_mi_record_property_fake_attribute_identities import ( GrantaMIRecordPropertyFakeAttributeIdentities, ) -from .granta_mi_search_free_text_identifiers import GrantaMISearchFreeTextIdentifiers from .gsa_about_attribute_cannot_be_meta_attribute_error_detail import ( GsaAboutAttributeCannotBeMetaAttributeErrorDetail, ) -from .gsa_access_control_categories_info import GsaAccessControlCategoriesInfo -from .gsa_access_control_category import GsaAccessControlCategory -from .gsa_access_control_category_creation_exception import ( - GsaAccessControlCategoryCreationException, -) -from .gsa_access_control_category_error_detail import GsaAccessControlCategoryErrorDetail -from .gsa_access_control_category_error_reason import GsaAccessControlCategoryErrorReason -from .gsa_access_control_category_include import GsaAccessControlCategoryInclude -from .gsa_access_control_category_no_such_entity_type import ( - GsaAccessControlCategoryNoSuchEntityType, -) -from .gsa_access_control_category_table_mapping import GsaAccessControlCategoryTableMapping -from .gsa_access_control_category_update_exception import GsaAccessControlCategoryUpdateException -from .gsa_access_control_database_user_capabilities import GsaAccessControlDatabaseUserCapabilities -from .gsa_access_control_entities_aggregation_error_detail import ( - GsaAccessControlEntitiesAggregationErrorDetail, -) -from .gsa_access_control_entities_error_detail import GsaAccessControlEntitiesErrorDetail -from .gsa_access_control_entities_update_operations_error_detail import ( - GsaAccessControlEntitiesUpdateOperationsErrorDetail, -) -from .gsa_access_control_entity import GsaAccessControlEntity -from .gsa_access_control_entity_type import GsaAccessControlEntityType -from .gsa_access_control_info import GsaAccessControlInfo -from .gsa_access_control_mode import GsaAccessControlMode -from .gsa_access_control_user_capabilities import GsaAccessControlUserCapabilities -from .gsa_activity_log_application_name_filter import GsaActivityLogApplicationNameFilter -from .gsa_activity_log_application_names_collection_filter import ( - GsaActivityLogApplicationNamesCollectionFilter, -) -from .gsa_activity_log_collection_match_type import GsaActivityLogCollectionMatchType -from .gsa_activity_log_database_key_filter import GsaActivityLogDatabaseKeyFilter -from .gsa_activity_log_date_filter import GsaActivityLogDateFilter -from .gsa_activity_log_entries_filter import GsaActivityLogEntriesFilter -from .gsa_activity_log_entries_info import GsaActivityLogEntriesInfo -from .gsa_activity_log_entry import GsaActivityLogEntry -from .gsa_activity_log_match_type import GsaActivityLogMatchType -from .gsa_activity_log_usage_mode import GsaActivityLogUsageMode -from .gsa_activity_log_usage_mode_filter import GsaActivityLogUsageModeFilter -from .gsa_activity_log_username_filter import GsaActivityLogUsernameFilter from .gsa_add_database import GsaAddDatabase from .gsa_add_database_issue_type import GsaAddDatabaseIssueType -from .gsa_add_database_security_groups import GsaAddDatabaseSecurityGroups from .gsa_add_database_validation_issue import GsaAddDatabaseValidationIssue from .gsa_add_database_validation_result import GsaAddDatabaseValidationResult from .gsa_add_record_history_to_subset import GsaAddRecordHistoryToSubset -from .gsa_additional_sql_parameters import GsaAdditionalSqlParameters -from .gsa_aggregate_permission_access_controls_request import ( - GsaAggregatePermissionAccessControlsRequest, -) from .gsa_aggregation import GsaAggregation from .gsa_aggregation_criterion import GsaAggregationCriterion from .gsa_aggregation_datum import GsaAggregationDatum @@ -127,27 +81,16 @@ from .gsa_append_point_values import GsaAppendPointValues from .gsa_applicable_datum import GsaApplicableDatum from .gsa_applications_info import GsaApplicationsInfo -from .gsa_apply_options import GsaApplyOptions -from .gsa_association_chain_create_put_layout_item import GsaAssociationChainCreatePutLayoutItem from .gsa_attribute import GsaAttribute -from .gsa_attribute_access_control_entity import GsaAttributeAccessControlEntity from .gsa_attribute_aggregation import GsaAttributeAggregation from .gsa_attribute_aggregation_criterion import GsaAttributeAggregationCriterion from .gsa_attribute_aggregation_exists_criterion import GsaAttributeAggregationExistsCriterion from .gsa_attribute_aggregation_type import GsaAttributeAggregationType from .gsa_attribute_aggregation_value_criterion import GsaAttributeAggregationValueCriterion -from .gsa_attribute_already_specified_smart_attributes_error_detail import ( - GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail, -) -from .gsa_attribute_based_access_control_info import GsaAttributeBasedAccessControlInfo -from .gsa_attribute_create_put_layout_item import GsaAttributeCreatePutLayoutItem from .gsa_attribute_creation_exception import GsaAttributeCreationException from .gsa_attribute_criterion import GsaAttributeCriterion from .gsa_attribute_criterion_type import GsaAttributeCriterionType from .gsa_attribute_deletion_exception import GsaAttributeDeletionException -from .gsa_attribute_discrete_type_mismatch_error_detail import ( - GsaAttributeDiscreteTypeMismatchErrorDetail, -) from .gsa_attribute_error_detail import GsaAttributeErrorDetail from .gsa_attribute_error_reason import GsaAttributeErrorReason from .gsa_attribute_exists_aggregation import GsaAttributeExistsAggregation @@ -159,24 +102,12 @@ from .gsa_attribute_matches_criterion import GsaAttributeMatchesCriterion from .gsa_attribute_no_such_entity_type import GsaAttributeNoSuchEntityType from .gsa_attribute_not_applicable_criterion import GsaAttributeNotApplicableCriterion -from .gsa_attribute_not_on_table_error_detail import GsaAttributeNotOnTableErrorDetail -from .gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail, -) -from .gsa_attribute_pair_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairTypeMismatchSmartAttributesErrorDetail, -) from .gsa_attribute_reference import GsaAttributeReference from .gsa_attribute_scale_type import GsaAttributeScaleType from .gsa_attribute_sort_criterion import GsaAttributeSortCriterion from .gsa_attribute_threshold_type import GsaAttributeThresholdType from .gsa_attribute_to_export import GsaAttributeToExport from .gsa_attribute_type import GsaAttributeType -from .gsa_attribute_type_attribute_error_detail import GsaAttributeTypeAttributeErrorDetail -from .gsa_attribute_type_not_supported_smart_attributes_error_detail import ( - GsaAttributeTypeNotSupportedSmartAttributesErrorDetail, -) -from .gsa_attribute_update_exception import GsaAttributeUpdateException from .gsa_attribute_usage_data_modification_error_detail import ( GsaAttributeUsageDataModificationErrorDetail, ) @@ -184,77 +115,31 @@ from .gsa_attribute_value_aggregation import GsaAttributeValueAggregation from .gsa_attributes_info import GsaAttributesInfo from .gsa_axis_name import GsaAxisName -from .gsa_blob_info_dto import GsaBlobInfoDto from .gsa_boolean_criterion import GsaBooleanCriterion from .gsa_boost_by_guid import GsaBoostByGuid from .gsa_boost_by_identity import GsaBoostByIdentity -from .gsa_bracket_mismatch_unit_equation_error_detail import ( - GsaBracketMismatchUnitEquationErrorDetail, -) -from .gsa_breadcrumb import GsaBreadcrumb -from .gsa_breadcrumb_type import GsaBreadcrumbType -from .gsa_breadcrumbs_property import GsaBreadcrumbsProperty from .gsa_bulk_info import GsaBulkInfo from .gsa_bulk_request import GsaBulkRequest from .gsa_bulk_request_http_method import GsaBulkRequestHttpMethod from .gsa_bulk_request_item import GsaBulkRequestItem from .gsa_bulk_response_item import GsaBulkResponseItem from .gsa_calendar_interval import GsaCalendarInterval -from .gsa_cannot_change_discrete_type_attribute_error_detail import ( - GsaCannotChangeDiscreteTypeAttributeErrorDetail, -) -from .gsa_cannot_create_unavailable_tabular_column_attribute_error_detail import ( - GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail, -) -from .gsa_cannot_delete_tabular_column_attribute_error_detail import ( - GsaCannotDeleteTabularColumnAttributeErrorDetail, -) -from .gsa_cannot_remove_parameter_in_use_attribute_error_detail import ( - GsaCannotRemoveParameterInUseAttributeErrorDetail, -) -from .gsa_category_replace_permission_category_error_detail import ( - GsaCategoryReplacePermissionCategoryErrorDetail, -) -from .gsa_chart_data import GsaChartData -from .gsa_chart_data_type import GsaChartDataType -from .gsa_circular_reference_folder_move_error_detail import ( - GsaCircularReferenceFolderMoveErrorDetail, -) -from .gsa_code_missing_currency_error_detail import GsaCodeMissingCurrencyErrorDetail -from .gsa_code_whitespace_currency_error_detail import GsaCodeWhitespaceCurrencyErrorDetail -from .gsa_config_invalid_json_file_error_detail import GsaConfigInvalidJsonFileErrorDetail from .gsa_configuration import GsaConfiguration -from .gsa_configuration_details import GsaConfigurationDetails from .gsa_configurations_info import GsaConfigurationsInfo from .gsa_connection_details import GsaConnectionDetails from .gsa_constant import GsaConstant -from .gsa_constant_creation_exception import GsaConstantCreationException from .gsa_constant_deletion_exception import GsaConstantDeletionException -from .gsa_constant_error_detail import GsaConstantErrorDetail -from .gsa_constant_error_reason import GsaConstantErrorReason -from .gsa_constant_update_exception import GsaConstantUpdateException -from .gsa_constant_usage_data_modification_error_detail import ( - GsaConstantUsageDataModificationErrorDetail, -) from .gsa_constants_info import GsaConstantsInfo -from .gsa_continuous_quality_system import GsaContinuousQualitySystem from .gsa_continuous_range import GsaContinuousRange from .gsa_copy_record_history import GsaCopyRecordHistory -from .gsa_create_access_control_category import GsaCreateAccessControlCategory -from .gsa_create_access_control_category_table_mapping import ( - GsaCreateAccessControlCategoryTableMapping, -) from .gsa_create_attribute import GsaCreateAttribute from .gsa_create_attribute_link_pair import GsaCreateAttributeLinkPair from .gsa_create_axis_name import GsaCreateAxisName from .gsa_create_configuration import GsaCreateConfiguration from .gsa_create_constant import GsaCreateConstant -from .gsa_create_continuous_quality_system import GsaCreateContinuousQualitySystem from .gsa_create_continuous_range import GsaCreateContinuousRange -from .gsa_create_cross_database_link_target import GsaCreateCrossDatabaseLinkTarget from .gsa_create_cross_database_record_link_group import GsaCreateCrossDatabaseRecordLinkGroup from .gsa_create_data_rule import GsaCreateDataRule -from .gsa_create_data_update_server_api_request import GsaCreateDataUpdateServerApiRequest from .gsa_create_date_time_attribute import GsaCreateDateTimeAttribute from .gsa_create_discrete_attribute import GsaCreateDiscreteAttribute from .gsa_create_discrete_functional_attribute import GsaCreateDiscreteFunctionalAttribute @@ -270,9 +155,9 @@ from .gsa_create_discrete_parameter import GsaCreateDiscreteParameter from .gsa_create_discrete_parameter_content import GsaCreateDiscreteParameterContent from .gsa_create_discrete_parameter_value import GsaCreateDiscreteParameterValue -from .gsa_create_discrete_quality_system import GsaCreateDiscreteQualitySystem from .gsa_create_discrete_range import GsaCreateDiscreteRange from .gsa_create_discrete_type import GsaCreateDiscreteType +from .gsa_create_dynamic_record_link_group import GsaCreateDynamicRecordLinkGroup from .gsa_create_expression import GsaCreateExpression from .gsa_create_file_attribute import GsaCreateFileAttribute from .gsa_create_float_functional_attribute import GsaCreateFloatFunctionalAttribute @@ -316,51 +201,31 @@ from .gsa_create_parameter import GsaCreateParameter from .gsa_create_parameter_content import GsaCreateParameterContent from .gsa_create_parameter_value import GsaCreateParameterValue -from .gsa_create_permission import GsaCreatePermission -from .gsa_create_permission_category import GsaCreatePermissionCategory from .gsa_create_picture_attribute import GsaCreatePictureAttribute from .gsa_create_point_attribute import GsaCreatePointAttribute from .gsa_create_profile import GsaCreateProfile from .gsa_create_profile_table import GsaCreateProfileTable -from .gsa_create_put_discrete_value import GsaCreatePutDiscreteValue -from .gsa_create_put_layout_item import GsaCreatePutLayoutItem -from .gsa_create_put_permission import GsaCreatePutPermission -from .gsa_create_put_permission_category import GsaCreatePutPermissionCategory -from .gsa_create_quality_discrete_value import GsaCreateQualityDiscreteValue -from .gsa_create_quality_system import GsaCreateQualitySystem from .gsa_create_range_attribute import GsaCreateRangeAttribute from .gsa_create_record_history import GsaCreateRecordHistory from .gsa_create_record_link_group import GsaCreateRecordLinkGroup from .gsa_create_record_list import GsaCreateRecordList from .gsa_create_record_list_items_info import GsaCreateRecordListItemsInfo from .gsa_create_replacement_string import GsaCreateReplacementString +from .gsa_create_search_request import GsaCreateSearchRequest from .gsa_create_short_text_attribute import GsaCreateShortTextAttribute -from .gsa_create_smart_link_target import GsaCreateSmartLinkTarget -from .gsa_create_smart_record_link_group import GsaCreateSmartRecordLinkGroup from .gsa_create_standard_name import GsaCreateStandardName -from .gsa_create_static_link_target import GsaCreateStaticLinkTarget from .gsa_create_static_record_link_group import GsaCreateStaticRecordLinkGroup -from .gsa_create_static_record_link_group_mapping import GsaCreateStaticRecordLinkGroupMapping from .gsa_create_subset import GsaCreateSubset from .gsa_create_table import GsaCreateTable from .gsa_create_tabular_attribute import GsaCreateTabularAttribute from .gsa_create_tabular_column import GsaCreateTabularColumn from .gsa_create_unit import GsaCreateUnit -from .gsa_create_unit_mapping import GsaCreateUnitMapping from .gsa_create_unit_system import GsaCreateUnitSystem from .gsa_created_by_user_property import GsaCreatedByUserProperty from .gsa_created_date_property import GsaCreatedDateProperty from .gsa_criterion import GsaCriterion from .gsa_criterion_type import GsaCriterionType -from .gsa_cross_database_link import GsaCrossDatabaseLink -from .gsa_cross_database_link_create_put_layout_item import GsaCrossDatabaseLinkCreatePutLayoutItem -from .gsa_cross_database_record_link import GsaCrossDatabaseRecordLink from .gsa_cross_database_record_link_group import GsaCrossDatabaseRecordLinkGroup -from .gsa_cross_database_record_link_result import GsaCrossDatabaseRecordLinkResult -from .gsa_currencies_info import GsaCurrenciesInfo -from .gsa_currency import GsaCurrency -from .gsa_currency_error_detail import GsaCurrencyErrorDetail -from .gsa_currency_error_reason import GsaCurrencyErrorReason from .gsa_current_user import GsaCurrentUser from .gsa_data_export_applicable_datum import GsaDataExportApplicableDatum from .gsa_data_export_binary_data import GsaDataExportBinaryData @@ -412,29 +277,11 @@ from .gsa_data_modification_error_reason import GsaDataModificationErrorReason from .gsa_data_rule import GsaDataRule from .gsa_data_rules_info import GsaDataRulesInfo -from .gsa_data_source import GsaDataSource -from .gsa_data_update import GsaDataUpdate -from .gsa_data_update_deletion_exception import GsaDataUpdateDeletionException -from .gsa_data_update_header import GsaDataUpdateHeader -from .gsa_data_update_run_info import GsaDataUpdateRunInfo -from .gsa_data_update_token import GsaDataUpdateToken -from .gsa_data_updater_job import GsaDataUpdaterJob -from .gsa_data_updater_job_status import GsaDataUpdaterJobStatus -from .gsa_data_updater_job_type import GsaDataUpdaterJobType -from .gsa_data_updater_project import GsaDataUpdaterProject from .gsa_data_usage_data_modification_error_detail import GsaDataUsageDataModificationErrorDetail from .gsa_database import GsaDatabase -from .gsa_database_access_control_entity import GsaDatabaseAccessControlEntity -from .gsa_database_currency_unit_usage_data_modification_error_detail import ( - GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail, -) -from .gsa_database_issues import GsaDatabaseIssues from .gsa_database_key_property import GsaDatabaseKeyProperty -from .gsa_database_security_groups import GsaDatabaseSecurityGroups -from .gsa_database_security_groups_info import GsaDatabaseSecurityGroupsInfo from .gsa_database_status import GsaDatabaseStatus from .gsa_database_status_information import GsaDatabaseStatusInformation -from .gsa_database_user_capabilities import GsaDatabaseUserCapabilities from .gsa_databases_info import GsaDatabasesInfo from .gsa_date_time_aggregation import GsaDateTimeAggregation from .gsa_date_time_aggregation_datum_criterion import GsaDateTimeAggregationDatumCriterion @@ -470,34 +317,15 @@ from .gsa_default_expression_not_found_maths_functional_error_detail import ( GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail, ) -from .gsa_default_fallback_security_groups import GsaDefaultFallbackSecurityGroups from .gsa_default_free_parameter_not_found_maths_functional_error_detail import ( GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail, ) -from .gsa_default_layout_guid_error_detail import GsaDefaultLayoutGuidErrorDetail -from .gsa_default_parameter_value_guid_parameter_error_detail import ( - GsaDefaultParameterValueGuidParameterErrorDetail, -) -from .gsa_default_parameter_value_index_and_guid_parameter_error_detail import ( - GsaDefaultParameterValueIndexAndGuidParameterErrorDetail, -) -from .gsa_default_parameter_value_index_parameter_error_detail import ( - GsaDefaultParameterValueIndexParameterErrorDetail, -) -from .gsa_default_parameter_value_index_without_values_parameter_error_detail import ( - GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail, -) from .gsa_default_parameter_value_usage_data_modification_error_detail import ( GsaDefaultParameterValueUsageDataModificationErrorDetail, ) -from .gsa_default_subset_guid_error_detail import GsaDefaultSubsetGuidErrorDetail from .gsa_delete_record_list_item import GsaDeleteRecordListItem from .gsa_delete_record_list_items import GsaDeleteRecordListItems -from .gsa_deletion_entity_type import GsaDeletionEntityType -from .gsa_deletion_exception import GsaDeletionException -from .gsa_description_length_file_error_detail import GsaDescriptionLengthFileErrorDetail from .gsa_discrete_attribute import GsaDiscreteAttribute -from .gsa_discrete_chart_data import GsaDiscreteChartData from .gsa_discrete_datum import GsaDiscreteDatum from .gsa_discrete_datum_exists_criterion import GsaDiscreteDatumExistsCriterion from .gsa_discrete_functional_attribute import GsaDiscreteFunctionalAttribute @@ -532,7 +360,6 @@ from .gsa_discrete_parameter_name_constraint import GsaDiscreteParameterNameConstraint from .gsa_discrete_parameter_value import GsaDiscreteParameterValue from .gsa_discrete_parameter_value_constraint import GsaDiscreteParameterValueConstraint -from .gsa_discrete_quality_system import GsaDiscreteQualitySystem from .gsa_discrete_range import GsaDiscreteRange from .gsa_discrete_range_datum_criterion import GsaDiscreteRangeDatumCriterion from .gsa_discrete_series import GsaDiscreteSeries @@ -544,57 +371,24 @@ from .gsa_discrete_text_prefix_datum_criterion import GsaDiscreteTextPrefixDatumCriterion from .gsa_discrete_text_values_datum_criterion import GsaDiscreteTextValuesDatumCriterion from .gsa_discrete_type import GsaDiscreteType -from .gsa_discrete_type_creation_exception import GsaDiscreteTypeCreationException from .gsa_discrete_type_deletion_exception import GsaDiscreteTypeDeletionException -from .gsa_discrete_type_error_detail import GsaDiscreteTypeErrorDetail -from .gsa_discrete_type_error_reason import GsaDiscreteTypeErrorReason -from .gsa_discrete_type_update_exception import GsaDiscreteTypeUpdateException from .gsa_discrete_type_usage import GsaDiscreteTypeUsage -from .gsa_discrete_type_usage_type import GsaDiscreteTypeUsageType from .gsa_discrete_types_info import GsaDiscreteTypesInfo from .gsa_discrete_value import GsaDiscreteValue -from .gsa_discrete_value_creation_exception import GsaDiscreteValueCreationException -from .gsa_discrete_value_deletion_exception import GsaDiscreteValueDeletionException -from .gsa_discrete_value_error_detail import GsaDiscreteValueErrorDetail -from .gsa_discrete_value_error_reason import GsaDiscreteValueErrorReason -from .gsa_discrete_value_not_in_discrete_type_error_detail import ( - GsaDiscreteValueNotInDiscreteTypeErrorDetail, -) -from .gsa_discrete_value_update_exception import GsaDiscreteValueUpdateException -from .gsa_discrete_value_used_in_data_error_detail import GsaDiscreteValueUsedInDataErrorDetail +from .gsa_discrete_value_aggregate_error_reason import GsaDiscreteValueAggregateErrorReason +from .gsa_discrete_value_aggregate_exception import GsaDiscreteValueAggregateException from .gsa_discrete_values_create_discrete_value import GsaDiscreteValuesCreateDiscreteValue from .gsa_discrete_values_discrete_value import GsaDiscreteValuesDiscreteValue from .gsa_discrete_values_discrete_values_info import GsaDiscreteValuesDiscreteValuesInfo -from .gsa_discrete_values_error_detail import GsaDiscreteValuesErrorDetail from .gsa_discrete_values_replace_discrete_values_info import ( GsaDiscreteValuesReplaceDiscreteValuesInfo, ) from .gsa_discrete_values_update_discrete_value import GsaDiscreteValuesUpdateDiscreteValue from .gsa_disk_status import GsaDiskStatus -from .gsa_display_name_empty_error_detail import GsaDisplayNameEmptyErrorDetail -from .gsa_display_name_language_not_provided_error_detail import ( - GsaDisplayNameLanguageNotProvidedErrorDetail, -) -from .gsa_display_name_language_not_supported_error_detail import ( - GsaDisplayNameLanguageNotSupportedErrorDetail, -) -from .gsa_display_names_import_error_detail import GsaDisplayNamesImportErrorDetail -from .gsa_display_names_import_error_reason import GsaDisplayNamesImportErrorReason -from .gsa_display_names_import_exception import GsaDisplayNamesImportException -from .gsa_display_names_info import GsaDisplayNamesInfo -from .gsa_divide_by_zero_unit_equation_error_detail import GsaDivideByZeroUnitEquationErrorDetail from .gsa_double_sorting_value import GsaDoubleSortingValue -from .gsa_duplicate_categories_replace_permission_category_error_detail import ( - GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail, -) -from .gsa_duplicate_category_guids_access_control_error_detail import ( - GsaDuplicateCategoryGuidsAccessControlErrorDetail, -) -from .gsa_duplicate_code_currency_error_detail import GsaDuplicateCodeCurrencyErrorDetail from .gsa_duplicate_database_add_database_validation_issue import ( GsaDuplicateDatabaseAddDatabaseValidationIssue, ) -from .gsa_duplicate_discrete_value_error_detail import GsaDuplicateDiscreteValueErrorDetail from .gsa_duplicate_expression_guids_maths_functional_error_detail import ( GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail, ) @@ -604,33 +398,9 @@ from .gsa_duplicate_key_add_database_validation_issue import ( GsaDuplicateKeyAddDatabaseValidationIssue, ) -from .gsa_duplicate_mapped_attribute_guids_error_detail import ( - GsaDuplicateMappedAttributeGuidsErrorDetail, -) -from .gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail import ( - GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .gsa_duplicate_mapped_parameter_guids_error_detail import ( - GsaDuplicateMappedParameterGuidsErrorDetail, -) -from .gsa_duplicate_mapped_record_link_group_guids_error_detail import ( - GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail, -) -from .gsa_duplicate_name_currency_error_detail import GsaDuplicateNameCurrencyErrorDetail from .gsa_duplicate_parameter_guids_attribute_error_detail import ( GsaDuplicateParameterGuidsAttributeErrorDetail, ) -from .gsa_duplicate_permission_guids_access_control_error_detail import ( - GsaDuplicatePermissionGuidsAccessControlErrorDetail, -) -from .gsa_duplicate_permissions_permission_category_error_detail import ( - GsaDuplicatePermissionsPermissionCategoryErrorDetail, -) -from .gsa_duplicate_symbol_unit_error_detail import GsaDuplicateSymbolUnitErrorDetail -from .gsa_duplicate_table_error_detail import GsaDuplicateTableErrorDetail -from .gsa_duplicate_tables_reorder_tables_error_detail import ( - GsaDuplicateTablesReorderTablesErrorDetail, -) from .gsa_duplicate_tabular_column_guids_error_detail import ( GsaDuplicateTabularColumnGuidsErrorDetail, ) @@ -640,33 +410,23 @@ from .gsa_duplicate_version_guid_add_database_validation_issue import ( GsaDuplicateVersionGuidAddDatabaseValidationIssue, ) +from .gsa_dynamic_link_group_usage_data_modification_error_detail import ( + GsaDynamicLinkGroupUsageDataModificationErrorDetail, +) +from .gsa_dynamic_record_link_group import GsaDynamicRecordLinkGroup from .gsa_empty_axis_name_attribute_error_detail import GsaEmptyAxisNameAttributeErrorDetail -from .gsa_empty_symbol_unit_error_detail import GsaEmptySymbolUnitErrorDetail -from .gsa_empty_table_type_error_detail import GsaEmptyTableTypeErrorDetail from .gsa_enabled_licenses_info import GsaEnabledLicensesInfo from .gsa_entity_already_exists_error_detail import GsaEntityAlreadyExistsErrorDetail from .gsa_entity_identifier_already_specified_error_detail import ( GsaEntityIdentifierAlreadySpecifiedErrorDetail, ) -from .gsa_entity_type import GsaEntityType -from .gsa_equation_unit_error_detail import GsaEquationUnitErrorDetail -from .gsa_error_code import GsaErrorCode -from .gsa_error_detail_of_record_history_error_reason import ( - GsaErrorDetailOfRecordHistoryErrorReason, -) -from .gsa_error_detail_of_upgrade_database_failure_reason import ( - GsaErrorDetailOfUpgradeDatabaseFailureReason, -) -from .gsa_error_response import GsaErrorResponse -from .gsa_exception_information import GsaExceptionInformation +from .gsa_error_detail import GsaErrorDetail from .gsa_exclude_values_specifier import GsaExcludeValuesSpecifier from .gsa_existing_tabular_column_guid_error_detail import GsaExistingTabularColumnGuidErrorDetail from .gsa_export_failure import GsaExportFailure from .gsa_export_failure_type import GsaExportFailureType from .gsa_exporter_refetch_info import GsaExporterRefetchInfo from .gsa_expression import GsaExpression -from .gsa_expression_access_control_entity import GsaExpressionAccessControlEntity -from .gsa_expression_deletion_exception import GsaExpressionDeletionException from .gsa_expression_maths_functional_error_detail import GsaExpressionMathsFunctionalErrorDetail from .gsa_expression_usage_data_modification_error_detail import ( GsaExpressionUsageDataModificationErrorDetail, @@ -675,28 +435,14 @@ GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail, ) from .gsa_expressions_info import GsaExpressionsInfo -from .gsa_file_already_exists_file_move_error_detail import GsaFileAlreadyExistsFileMoveErrorDetail from .gsa_file_attribute import GsaFileAttribute -from .gsa_file_creation_exception import GsaFileCreationException from .gsa_file_datum import GsaFileDatum from .gsa_file_datum_criterion import GsaFileDatumCriterion from .gsa_file_datum_exists_criterion import GsaFileDatumExistsCriterion -from .gsa_file_error_detail import GsaFileErrorDetail -from .gsa_file_error_reason import GsaFileErrorReason from .gsa_file_header import GsaFileHeader -from .gsa_file_header_info import GsaFileHeaderInfo -from .gsa_file_move_error_detail import GsaFileMoveErrorDetail -from .gsa_file_move_error_reason import GsaFileMoveErrorReason -from .gsa_file_move_exception import GsaFileMoveException -from .gsa_file_name_file_error_detail import GsaFileNameFileErrorDetail -from .gsa_file_name_folder_error_detail import GsaFileNameFolderErrorDetail from .gsa_file_prefix_datum_criterion import GsaFilePrefixDatumCriterion -from .gsa_file_update_exception import GsaFileUpdateException from .gsa_files_info import GsaFilesInfo -from .gsa_find_similar_request import GsaFindSimilarRequest -from .gsa_find_similar_response import GsaFindSimilarResponse -from .gsa_find_similar_result import GsaFindSimilarResult -from .gsa_find_similar_search_criterion import GsaFindSimilarSearchCriterion +from .gsa_find_search_request import GsaFindSearchRequest from .gsa_find_standard_names import GsaFindStandardNames from .gsa_float_functional_aggregation import GsaFloatFunctionalAggregation from .gsa_float_functional_aggregation_datum_criterion import ( @@ -724,24 +470,7 @@ from .gsa_float_series_graph import GsaFloatSeriesGraph from .gsa_float_series_point import GsaFloatSeriesPoint from .gsa_folder import GsaFolder -from .gsa_folder_already_exists_folder_move_error_detail import ( - GsaFolderAlreadyExistsFolderMoveErrorDetail, -) -from .gsa_folder_creation_exception import GsaFolderCreationException -from .gsa_folder_deletion_error_detail import GsaFolderDeletionErrorDetail -from .gsa_folder_deletion_error_reason import GsaFolderDeletionErrorReason -from .gsa_folder_deletion_exception import GsaFolderDeletionException -from .gsa_folder_error_detail import GsaFolderErrorDetail -from .gsa_folder_error_reason import GsaFolderErrorReason -from .gsa_folder_move_error_detail import GsaFolderMoveErrorDetail -from .gsa_folder_move_error_reason import GsaFolderMoveErrorReason -from .gsa_folder_move_exception import GsaFolderMoveException -from .gsa_folder_type import GsaFolderType -from .gsa_folder_update_exception import GsaFolderUpdateException from .gsa_folders_info import GsaFoldersInfo -from .gsa_forbid_orphans_record_link_group_error_detail import ( - GsaForbidOrphansRecordLinkGroupErrorDetail, -) from .gsa_free_text_aggregation import GsaFreeTextAggregation from .gsa_free_text_aggregation_criterion import GsaFreeTextAggregationCriterion from .gsa_free_text_criterion import GsaFreeTextCriterion @@ -749,24 +478,18 @@ from .gsa_full_layout_section import GsaFullLayoutSection from .gsa_full_name_property import GsaFullNameProperty from .gsa_func_no_params_attribute_error_detail import GsaFuncNoParamsAttributeErrorDetail -from .gsa_functional_data_default_usage_data_modification_error_detail import ( - GsaFunctionalDataDefaultUsageDataModificationErrorDetail, -) from .gsa_functional_datum_parameter_info import GsaFunctionalDatumParameterInfo from .gsa_functional_parameter_setting import GsaFunctionalParameterSetting from .gsa_functional_type import GsaFunctionalType -from .gsa_general_unit_equation_error_detail import GsaGeneralUnitEquationErrorDetail from .gsa_generated_integration_schema_of_object_identifier import ( GsaGeneratedIntegrationSchemaOfObjectIdentifier, ) -from .gsa_get_find_similar_results_response import GsaGetFindSimilarResultsResponse from .gsa_get_jobs_response import GsaGetJobsResponse from .gsa_get_jobs_summary_response import GsaGetJobsSummaryResponse from .gsa_get_modifiable_record_version_control_exception import ( GsaGetModifiableRecordVersionControlException, ) from .gsa_get_unit_conversions_request import GsaGetUnitConversionsRequest -from .gsa_get_unit_equivalents_exception import GsaGetUnitEquivalentsException from .gsa_graph import GsaGraph from .gsa_graph_decoration_type import GsaGraphDecorationType from .gsa_graph_evaluation_settings import GsaGraphEvaluationSettings @@ -775,7 +498,6 @@ from .gsa_graph_type import GsaGraphType from .gsa_graph_value import GsaGraphValue from .gsa_graph_value_type import GsaGraphValueType -from .gsa_grid import GsaGrid from .gsa_grid_graph import GsaGridGraph from .gsa_guid_only_attribute import GsaGuidOnlyAttribute from .gsa_guid_only_discrete_type import GsaGuidOnlyDiscreteType @@ -786,7 +508,6 @@ from .gsa_guid_only_layout import GsaGuidOnlyLayout from .gsa_guid_only_mapping_of_object_identifier import GsaGuidOnlyMappingOfObjectIdentifier from .gsa_guid_only_source_of_object_identifier import GsaGuidOnlySourceOfObjectIdentifier -from .gsa_help_paths_validation_response import GsaHelpPathsValidationResponse from .gsa_histogram import GsaHistogram from .gsa_histogram_bucket import GsaHistogramBucket from .gsa_hyperlink_attribute import GsaHyperlinkAttribute @@ -795,18 +516,12 @@ from .gsa_hyperlink_datum_exists_criterion import GsaHyperlinkDatumExistsCriterion from .gsa_hyperlink_prefix_datum_criterion import GsaHyperlinkPrefixDatumCriterion from .gsa_hyperlink_target import GsaHyperlinkTarget -from .gsa_in_use_parameter_value_error_detail import GsaInUseParameterValueErrorDetail -from .gsa_inclusiveness import GsaInclusiveness -from .gsa_incompatible_units_error_detail import GsaIncompatibleUnitsErrorDetail from .gsa_index_record_failure import GsaIndexRecordFailure from .gsa_indirect_links import GsaIndirectLinks -from .gsa_input_connection_details import GsaInputConnectionDetails from .gsa_input_validation_error_detail import GsaInputValidationErrorDetail -from .gsa_input_validation_error_reason import GsaInputValidationErrorReason from .gsa_integer_aggregation import GsaIntegerAggregation from .gsa_integer_aggregation_datum_criterion import GsaIntegerAggregationDatumCriterion from .gsa_integer_attribute import GsaIntegerAttribute -from .gsa_integer_chart_data import GsaIntegerChartData from .gsa_integer_datum import GsaIntegerDatum from .gsa_integer_datum_criterion import GsaIntegerDatumCriterion from .gsa_integer_datum_exists_criterion import GsaIntegerDatumExistsCriterion @@ -827,10 +542,6 @@ ) from .gsa_integration_schema_of_object_identifier import GsaIntegrationSchemaOfObjectIdentifier from .gsa_integration_schema_status import GsaIntegrationSchemaStatus -from .gsa_invalid_equivalence_target_error_detail import GsaInvalidEquivalenceTargetErrorDetail -from .gsa_invalid_exchange_rate_currency_error_detail import ( - GsaInvalidExchangeRateCurrencyErrorDetail, -) from .gsa_invalid_key_add_database_validation_issue import GsaInvalidKeyAddDatabaseValidationIssue from .gsa_invalid_parent_state_error_detail import GsaInvalidParentStateErrorDetail from .gsa_invalid_version_state_error_detail import GsaInvalidVersionStateErrorDetail @@ -850,7 +561,6 @@ from .gsa_layout_sections_info import GsaLayoutSectionsInfo from .gsa_layout_tabular_column import GsaLayoutTabularColumn from .gsa_layouts_info import GsaLayoutsInfo -from .gsa_link import GsaLink from .gsa_link_aggregation import GsaLinkAggregation from .gsa_link_aggregation_datum_criterion import GsaLinkAggregationDatumCriterion from .gsa_link_attribute_to_export import GsaLinkAttributeToExport @@ -903,33 +613,19 @@ from .gsa_local_range_tabular_column import GsaLocalRangeTabularColumn from .gsa_local_rows_behavior import GsaLocalRowsBehavior from .gsa_local_short_text_tabular_column import GsaLocalShortTextTabularColumn -from .gsa_log_scale_negative_parameter_value_error_detail import ( - GsaLogScaleNegativeParameterValueErrorDetail, -) from .gsa_logical_aggregation import GsaLogicalAggregation from .gsa_logical_aggregation_datum_criterion import GsaLogicalAggregationDatumCriterion from .gsa_logical_attribute import GsaLogicalAttribute -from .gsa_logical_chart_data import GsaLogicalChartData from .gsa_logical_datum import GsaLogicalDatum from .gsa_logical_datum_criterion import GsaLogicalDatumCriterion from .gsa_logical_datum_exists_criterion import GsaLogicalDatumExistsCriterion -from .gsa_long_running_operation import GsaLongRunningOperation -from .gsa_long_running_operation_include import GsaLongRunningOperationInclude -from .gsa_long_running_operation_invalid_status_exception import ( - GsaLongRunningOperationInvalidStatusException, -) -from .gsa_long_running_status import GsaLongRunningStatus from .gsa_long_sorting_value import GsaLongSortingValue from .gsa_long_text_attribute import GsaLongTextAttribute from .gsa_long_text_datum import GsaLongTextDatum from .gsa_long_text_datum_criterion import GsaLongTextDatumCriterion from .gsa_long_text_datum_exists_criterion import GsaLongTextDatumExistsCriterion from .gsa_long_text_prefix_datum_criterion import GsaLongTextPrefixDatumCriterion -from .gsa_many_to_many_forbid_orphans_record_link_group_error_detail import ( - GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail, -) from .gsa_mapping_of_object_identifier import GsaMappingOfObjectIdentifier -from .gsa_match_mode import GsaMatchMode from .gsa_maths_content import GsaMathsContent from .gsa_maths_functional_attribute import GsaMathsFunctionalAttribute from .gsa_maths_functional_attribute_error_detail import GsaMathsFunctionalAttributeErrorDetail @@ -937,12 +633,6 @@ from .gsa_maths_functional_datum_exists_criterion import GsaMathsFunctionalDatumExistsCriterion from .gsa_maths_functional_error_detail import GsaMathsFunctionalErrorDetail from .gsa_maths_functional_error_reason import GsaMathsFunctionalErrorReason -from .gsa_max_permissions_reached_permission_error_detail import ( - GsaMaxPermissionsReachedPermissionErrorDetail, -) -from .gsa_meta_attribute_cannot_have_meta_attribute_error_detail import ( - GsaMetaAttributeCannotHaveMetaAttributeErrorDetail, -) from .gsa_mfa_expression_error_detail import GsaMfaExpressionErrorDetail from .gsa_mfa_expression_error_reason import GsaMfaExpressionErrorReason from .gsa_mi_version import GsaMiVersion @@ -955,56 +645,12 @@ from .gsa_move_file import GsaMoveFile from .gsa_move_folder import GsaMoveFolder from .gsa_move_record_history import GsaMoveRecordHistory -from .gsa_multi_valued_attribute_error_detail import GsaMultiValuedAttributeErrorDetail -from .gsa_multi_valued_point_data_usage_data_modification_error_detail import ( - GsaMultiValuedPointDataUsageDataModificationErrorDetail, -) -from .gsa_multi_valued_reason import GsaMultiValuedReason -from .gsa_multi_valued_smart_attributes_error_detail import GsaMultiValuedSmartAttributesErrorDetail -from .gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail import ( - GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail, -) -from .gsa_name_already_exists_as_reverse_record_link_group_error_detail import ( - GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail, -) from .gsa_name_already_exists_error_detail import GsaNameAlreadyExistsErrorDetail -from .gsa_name_already_specified_error_detail import GsaNameAlreadySpecifiedErrorDetail -from .gsa_name_missing_currency_error_detail import GsaNameMissingCurrencyErrorDetail from .gsa_name_not_provided_error_detail import GsaNameNotProvidedErrorDetail -from .gsa_name_same_as_reverse_name_record_link_group_error_detail import ( - GsaNameSameAsReverseNameRecordLinkGroupErrorDetail, -) -from .gsa_name_whitespace_currency_error_detail import GsaNameWhitespaceCurrencyErrorDetail -from .gsa_name_whitespace_parameter_value_error_detail import ( - GsaNameWhitespaceParameterValueErrorDetail, -) from .gsa_named_criterion import GsaNamedCriterion -from .gsa_named_entity_access_control_category_error_detail import ( - GsaNamedEntityAccessControlCategoryErrorDetail, -) from .gsa_named_entity_attribute_error_detail import GsaNamedEntityAttributeErrorDetail -from .gsa_named_entity_constant_error_detail import GsaNamedEntityConstantErrorDetail -from .gsa_named_entity_discrete_type_error_detail import GsaNamedEntityDiscreteTypeErrorDetail -from .gsa_named_entity_discrete_value_error_detail import GsaNamedEntityDiscreteValueErrorDetail from .gsa_named_entity_error_detail import GsaNamedEntityErrorDetail from .gsa_named_entity_error_reason import GsaNamedEntityErrorReason -from .gsa_named_entity_file_error_detail import GsaNamedEntityFileErrorDetail -from .gsa_named_entity_folder_error_detail import GsaNamedEntityFolderErrorDetail -from .gsa_named_entity_parameter_error_detail import GsaNamedEntityParameterErrorDetail -from .gsa_named_entity_parameter_value_error_detail import GsaNamedEntityParameterValueErrorDetail -from .gsa_named_entity_permission_category_error_detail import ( - GsaNamedEntityPermissionCategoryErrorDetail, -) -from .gsa_named_entity_permission_error_detail import GsaNamedEntityPermissionErrorDetail -from .gsa_named_entity_quality_discrete_value_error_detail import ( - GsaNamedEntityQualityDiscreteValueErrorDetail, -) -from .gsa_named_entity_quality_system_error_detail import GsaNamedEntityQualitySystemErrorDetail -from .gsa_named_entity_record_link_group_error_detail import ( - GsaNamedEntityRecordLinkGroupErrorDetail, -) -from .gsa_named_entity_table_error_detail import GsaNamedEntityTableErrorDetail -from .gsa_named_entity_unit_error_detail import GsaNamedEntityUnitErrorDetail from .gsa_new_layout_association_chain_item import GsaNewLayoutAssociationChainItem from .gsa_new_layout_association_chain_link import GsaNewLayoutAssociationChainLink from .gsa_new_layout_attribute_item import GsaNewLayoutAttributeItem @@ -1013,92 +659,29 @@ from .gsa_new_layout_item_type import GsaNewLayoutItemType from .gsa_new_layout_record_link_item import GsaNewLayoutRecordLinkItem from .gsa_new_layout_smart_link_item import GsaNewLayoutSmartLinkItem -from .gsa_no_attribute_pairs_smart_attributes_error_detail import ( - GsaNoAttributePairsSmartAttributesErrorDetail, -) -from .gsa_no_data_file_error_detail import GsaNoDataFileErrorDetail from .gsa_no_expressions_maths_functional_error_detail import ( GsaNoExpressionsMathsFunctionalErrorDetail, ) -from .gsa_no_file_file_error_detail import GsaNoFileFileErrorDetail -from .gsa_no_parameter_values_parameter_error_detail import GsaNoParameterValuesParameterErrorDetail -from .gsa_no_permissions_permission_category_error_detail import ( - GsaNoPermissionsPermissionCategoryErrorDetail, -) -from .gsa_no_quality_discrete_values_error_detail import GsaNoQualityDiscreteValuesErrorDetail -from .gsa_no_such_attribute_smart_attributes_error_detail import ( - GsaNoSuchAttributeSmartAttributesErrorDetail, -) -from .gsa_no_such_categories_replace_permission_category_error_detail import ( - GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail, -) -from .gsa_no_such_category_access_control_error_detail import ( - GsaNoSuchCategoryAccessControlErrorDetail, -) -from .gsa_no_such_discrete_value_in_discrete_type_error_detail import ( - GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail, -) -from .gsa_no_such_entities_access_control_entities_error_detail import ( - GsaNoSuchEntitiesAccessControlEntitiesErrorDetail, -) -from .gsa_no_such_entity_access_control_category_error_detail import ( - GsaNoSuchEntityAccessControlCategoryErrorDetail, -) from .gsa_no_such_entity_attribute_error_detail import GsaNoSuchEntityAttributeErrorDetail from .gsa_no_such_entity_tabular_column_error_detail import GsaNoSuchEntityTabularColumnErrorDetail from .gsa_no_such_expressions_maths_functional_error_detail import ( GsaNoSuchExpressionsMathsFunctionalErrorDetail, ) -from .gsa_no_such_new_parent_file_move_error_detail import GsaNoSuchNewParentFileMoveErrorDetail -from .gsa_no_such_new_parent_folder_move_error_detail import GsaNoSuchNewParentFolderMoveErrorDetail from .gsa_no_such_parameter_value_parameter_content_error_detail import ( GsaNoSuchParameterValueParameterContentErrorDetail, ) -from .gsa_no_such_permission_access_control_error_detail import ( - GsaNoSuchPermissionAccessControlErrorDetail, -) -from .gsa_no_such_permissions_permission_category_error_detail import ( - GsaNoSuchPermissionsPermissionCategoryErrorDetail, -) -from .gsa_no_such_subset_access_control_entities_error_detail import ( - GsaNoSuchSubsetAccessControlEntitiesErrorDetail, -) -from .gsa_no_such_table_mapping_error_detail import GsaNoSuchTableMappingErrorDetail -from .gsa_no_such_tables_reorder_tables_error_detail import GsaNoSuchTablesReorderTablesErrorDetail -from .gsa_no_such_tabular_column_attribute_error_detail import ( - GsaNoSuchTabularColumnAttributeErrorDetail, -) -from .gsa_no_such_target_table_record_link_group_error_detail import ( - GsaNoSuchTargetTableRecordLinkGroupErrorDetail, -) -from .gsa_no_such_unit_constant_error_detail import GsaNoSuchUnitConstantErrorDetail -from .gsa_no_such_unit_parameter_error_detail import GsaNoSuchUnitParameterErrorDetail -from .gsa_no_such_unit_system_unit_equivalent_error_detail import ( - GsaNoSuchUnitSystemUnitEquivalentErrorDetail, -) -from .gsa_no_such_unit_unit_equivalent_error_detail import GsaNoSuchUnitUnitEquivalentErrorDetail from .gsa_no_value_exists_graph_value import GsaNoValueExistsGraphValue from .gsa_no_values_specifier import GsaNoValuesSpecifier -from .gsa_non_custom_standard_name_cannot_be_changed_error_detail import ( - GsaNonCustomStandardNameCannotBeChangedErrorDetail, -) from .gsa_not_applicable_datum import GsaNotApplicableDatum from .gsa_not_the_latest_version_error_detail import GsaNotTheLatestVersionErrorDetail from .gsa_not_versioned_error_detail import GsaNotVersionedErrorDetail -from .gsa_number_parsing_unit_equation_error_detail import GsaNumberParsingUnitEquationErrorDetail from .gsa_numeric_graph_parameter_value import GsaNumericGraphParameterValue from .gsa_numeric_parameter import GsaNumericParameter from .gsa_numeric_parameter_constraint import GsaNumericParameterConstraint from .gsa_numeric_parameter_content import GsaNumericParameterContent from .gsa_numeric_parameter_data_value import GsaNumericParameterDataValue from .gsa_numeric_parameter_value import GsaNumericParameterValue -from .gsa_numeric_restricted_interpolation_parameter_error_detail import ( - GsaNumericRestrictedInterpolationParameterErrorDetail, -) from .gsa_object_identifier import GsaObjectIdentifier -from .gsa_paginated_item_type import GsaPaginatedItemType -from .gsa_paginated_response_of import GsaPaginatedResponseOf -from .gsa_pagination_links import GsaPaginationLinks from .gsa_paging_options import GsaPagingOptions from .gsa_parameter import GsaParameter from .gsa_parameter_constraint import GsaParameterConstraint @@ -1116,11 +699,8 @@ from .gsa_parameter_content_unknown_parameters_maths_functional_error_detail import ( GsaParameterContentUnknownParametersMathsFunctionalErrorDetail, ) -from .gsa_parameter_creation_exception import GsaParameterCreationException from .gsa_parameter_data_value import GsaParameterDataValue from .gsa_parameter_deletion_exception import GsaParameterDeletionException -from .gsa_parameter_error_detail import GsaParameterErrorDetail -from .gsa_parameter_error_reason import GsaParameterErrorReason from .gsa_parameter_info import GsaParameterInfo from .gsa_parameter_info_interpolation_type import GsaParameterInfoInterpolationType from .gsa_parameter_info_parameter_type import GsaParameterInfoParameterType @@ -1132,88 +712,14 @@ from .gsa_parameter_type_parameter_content_error_detail import ( GsaParameterTypeParameterContentErrorDetail, ) -from .gsa_parameter_type_parameter_error_detail import GsaParameterTypeParameterErrorDetail -from .gsa_parameter_update_exception import GsaParameterUpdateException -from .gsa_parameter_usage_data_modification_error_detail import ( - GsaParameterUsageDataModificationErrorDetail, -) from .gsa_parameter_value import GsaParameterValue -from .gsa_parameter_value_creation_exception import GsaParameterValueCreationException from .gsa_parameter_value_deletion_exception import GsaParameterValueDeletionException -from .gsa_parameter_value_error_detail import GsaParameterValueErrorDetail -from .gsa_parameter_value_error_reason import GsaParameterValueErrorReason -from .gsa_parameter_value_parameter_error_detail import GsaParameterValueParameterErrorDetail from .gsa_parameter_value_type import GsaParameterValueType -from .gsa_parameter_value_type_parameter_value_error_detail import ( - GsaParameterValueTypeParameterValueErrorDetail, -) -from .gsa_parameter_value_update_exception import GsaParameterValueUpdateException -from .gsa_parameter_value_used_by_type import GsaParameterValueUsedByType from .gsa_parameter_with_data_value import GsaParameterWithDataValue from .gsa_parameters_info import GsaParametersInfo from .gsa_permission import GsaPermission -from .gsa_permission_access_control import GsaPermissionAccessControl -from .gsa_permission_access_control_aggregate import GsaPermissionAccessControlAggregate -from .gsa_permission_based_access_control_aggregation_error_detail import ( - GsaPermissionBasedAccessControlAggregationErrorDetail, -) -from .gsa_permission_based_access_control_aggregation_error_reason import ( - GsaPermissionBasedAccessControlAggregationErrorReason, -) -from .gsa_permission_based_access_control_aggregation_exception import ( - GsaPermissionBasedAccessControlAggregationException, -) -from .gsa_permission_based_access_control_entities_error_reason import ( - GsaPermissionBasedAccessControlEntitiesErrorReason, -) -from .gsa_permission_based_access_control_info import GsaPermissionBasedAccessControlInfo -from .gsa_permission_based_access_control_update_operation_exception import ( - GsaPermissionBasedAccessControlUpdateOperationException, -) -from .gsa_permission_based_access_control_update_operations_error_detail import ( - GsaPermissionBasedAccessControlUpdateOperationsErrorDetail, -) -from .gsa_permission_based_access_control_update_operations_error_reason import ( - GsaPermissionBasedAccessControlUpdateOperationsErrorReason, -) -from .gsa_permission_categories_access_control_error_detail import ( - GsaPermissionCategoriesAccessControlErrorDetail, -) -from .gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) -from .gsa_permission_categories_access_control_update_exception import ( - GsaPermissionCategoriesAccessControlUpdateException, -) from .gsa_permission_categories_info import GsaPermissionCategoriesInfo -from .gsa_permission_categories_update_operations_error_detail import ( - GsaPermissionCategoriesUpdateOperationsErrorDetail, -) from .gsa_permission_category import GsaPermissionCategory -from .gsa_permission_category_access_control import GsaPermissionCategoryAccessControl -from .gsa_permission_category_access_control_aggregate import ( - GsaPermissionCategoryAccessControlAggregate, -) -from .gsa_permission_category_access_control_aggregate_info import ( - GsaPermissionCategoryAccessControlAggregateInfo, -) -from .gsa_permission_category_access_control_info import GsaPermissionCategoryAccessControlInfo -from .gsa_permission_category_creation_exception import GsaPermissionCategoryCreationException -from .gsa_permission_category_error_detail import GsaPermissionCategoryErrorDetail -from .gsa_permission_category_error_reason import GsaPermissionCategoryErrorReason -from .gsa_permission_category_replace_exception import GsaPermissionCategoryReplaceException -from .gsa_permission_category_update_exception import GsaPermissionCategoryUpdateException -from .gsa_permission_creation_exception import GsaPermissionCreationException -from .gsa_permission_deletion_error_detail import GsaPermissionDeletionErrorDetail -from .gsa_permission_deletion_error_reason import GsaPermissionDeletionErrorReason -from .gsa_permission_deletion_exception import GsaPermissionDeletionException -from .gsa_permission_error_detail import GsaPermissionErrorDetail -from .gsa_permission_error_reason import GsaPermissionErrorReason -from .gsa_permission_permission_category_error_detail import ( - GsaPermissionPermissionCategoryErrorDetail, -) -from .gsa_permission_update_exception import GsaPermissionUpdateException -from .gsa_permissions_in_use_info import GsaPermissionsInUseInfo from .gsa_permissions_info import GsaPermissionsInfo from .gsa_picture_attribute import GsaPictureAttribute from .gsa_picture_datum import GsaPictureDatum @@ -1222,7 +728,6 @@ from .gsa_point_aggregation import GsaPointAggregation from .gsa_point_aggregation_datum_criterion import GsaPointAggregationDatumCriterion from .gsa_point_attribute import GsaPointAttribute -from .gsa_point_chart_data import GsaPointChartData from .gsa_point_data_value import GsaPointDataValue from .gsa_point_datum import GsaPointDatum from .gsa_point_datum_criterion import GsaPointDatumCriterion @@ -1242,23 +747,6 @@ from .gsa_profile_table import GsaProfileTable from .gsa_profile_tables_info import GsaProfileTablesInfo from .gsa_property import GsaProperty -from .gsa_put_discrete_value import GsaPutDiscreteValue -from .gsa_put_layout_item import GsaPutLayoutItem -from .gsa_put_permission import GsaPutPermission -from .gsa_put_permission_category import GsaPutPermissionCategory -from .gsa_put_type import GsaPutType -from .gsa_quality_discrete_value import GsaQualityDiscreteValue -from .gsa_quality_discrete_value_error_detail import GsaQualityDiscreteValueErrorDetail -from .gsa_quality_discrete_value_error_reason import GsaQualityDiscreteValueErrorReason -from .gsa_quality_discrete_values_error_detail import GsaQualityDiscreteValuesErrorDetail -from .gsa_quality_system import GsaQualitySystem -from .gsa_quality_system_creation_exception import GsaQualitySystemCreationException -from .gsa_quality_system_deletion_exception import GsaQualitySystemDeletionException -from .gsa_quality_system_error_detail import GsaQualitySystemErrorDetail -from .gsa_quality_system_error_reason import GsaQualitySystemErrorReason -from .gsa_quality_system_guid_error_detail import GsaQualitySystemGuidErrorDetail -from .gsa_quality_system_type import GsaQualitySystemType -from .gsa_quality_systems_info import GsaQualitySystemsInfo from .gsa_query_attribute import GsaQueryAttribute from .gsa_query_attribute_filter import GsaQueryAttributeFilter from .gsa_query_attribute_info import GsaQueryAttributeInfo @@ -1275,25 +763,9 @@ from .gsa_query_discrete_type_properties import GsaQueryDiscreteTypeProperties from .gsa_query_discrete_types_info import GsaQueryDiscreteTypesInfo from .gsa_query_discrete_types_request import GsaQueryDiscreteTypesRequest -from .gsa_query_layout import GsaQueryLayout -from .gsa_query_layout_filter import GsaQueryLayoutFilter -from .gsa_query_layout_item import GsaQueryLayoutItem -from .gsa_query_layout_item_filter import GsaQueryLayoutItemFilter -from .gsa_query_layout_item_properties import GsaQueryLayoutItemProperties -from .gsa_query_layout_properties import GsaQueryLayoutProperties -from .gsa_query_layout_section import GsaQueryLayoutSection -from .gsa_query_layout_section_filter import GsaQueryLayoutSectionFilter -from .gsa_query_layout_section_properties import GsaQueryLayoutSectionProperties -from .gsa_query_layout_sections_info import GsaQueryLayoutSectionsInfo -from .gsa_query_layout_sections_request import GsaQueryLayoutSectionsRequest -from .gsa_query_layouts_info import GsaQueryLayoutsInfo -from .gsa_query_layouts_request import GsaQueryLayoutsRequest from .gsa_query_slim_discrete_type import GsaQuerySlimDiscreteType from .gsa_query_slim_discrete_type_properties import GsaQuerySlimDiscreteTypeProperties -from .gsa_query_slim_entity import GsaQuerySlimEntity -from .gsa_query_slim_entity_properties import GsaQuerySlimEntityProperties from .gsa_query_slim_named_entity import GsaQuerySlimNamedEntity -from .gsa_query_slim_named_entity_filter import GsaQuerySlimNamedEntityFilter from .gsa_query_slim_named_entity_properties import GsaQuerySlimNamedEntityProperties from .gsa_query_slim_typed_attribute import GsaQuerySlimTypedAttribute from .gsa_query_slim_typed_attribute_properties import GsaQuerySlimTypedAttributeProperties @@ -1304,18 +776,14 @@ from .gsa_query_tables_request import GsaQueryTablesRequest from .gsa_query_tabular_attribute_target import GsaQueryTabularAttributeTarget from .gsa_query_tabular_attribute_target_properties import GsaQueryTabularAttributeTargetProperties -from .gsa_query_tabular_column import GsaQueryTabularColumn -from .gsa_query_tabular_column_properties import GsaQueryTabularColumnProperties from .gsa_query_unit import GsaQueryUnit from .gsa_query_unit_properties import GsaQueryUnitProperties from .gsa_range_aggregation import GsaRangeAggregation from .gsa_range_aggregation_datum_criterion import GsaRangeAggregationDatumCriterion from .gsa_range_attribute import GsaRangeAttribute -from .gsa_range_chart_data import GsaRangeChartData from .gsa_range_datum import GsaRangeDatum from .gsa_range_datum_criterion import GsaRangeDatumCriterion from .gsa_range_datum_exists_criterion import GsaRangeDatumExistsCriterion -from .gsa_range_endpoint import GsaRangeEndpoint from .gsa_range_fixed_width_histogram_aggregation_datum_criterion import ( GsaRangeFixedWidthHistogramAggregationDatumCriterion, ) @@ -1326,32 +794,19 @@ ) from .gsa_record_ancestor_criterion import GsaRecordAncestorCriterion from .gsa_record_ancestor_history_criterion import GsaRecordAncestorHistoryCriterion -from .gsa_record_and_attribute_selection_type import GsaRecordAndAttributeSelectionType +from .gsa_record_capabilities import GsaRecordCapabilities from .gsa_record_color import GsaRecordColor from .gsa_record_color_property import GsaRecordColorProperty from .gsa_record_export_failure import GsaRecordExportFailure from .gsa_record_guid_property import GsaRecordGuidProperty from .gsa_record_history import GsaRecordHistory from .gsa_record_history_copy_exception import GsaRecordHistoryCopyException -from .gsa_record_history_descendants_access_control_entity import ( - GsaRecordHistoryDescendantsAccessControlEntity, -) -from .gsa_record_history_error_reason import GsaRecordHistoryErrorReason from .gsa_record_history_guid_property import GsaRecordHistoryGuidProperty from .gsa_record_history_move_exception import GsaRecordHistoryMoveException from .gsa_record_history_reference import GsaRecordHistoryReference -from .gsa_record_link import GsaRecordLink -from .gsa_record_link_base import GsaRecordLinkBase -from .gsa_record_link_create_put_layout_item import GsaRecordLinkCreatePutLayoutItem from .gsa_record_link_group import GsaRecordLinkGroup -from .gsa_record_link_group_creation_exception import GsaRecordLinkGroupCreationException -from .gsa_record_link_group_error_detail import GsaRecordLinkGroupErrorDetail -from .gsa_record_link_group_error_reason import GsaRecordLinkGroupErrorReason from .gsa_record_link_group_type import GsaRecordLinkGroupType -from .gsa_record_link_group_update_exception import GsaRecordLinkGroupUpdateException from .gsa_record_link_groups_info import GsaRecordLinkGroupsInfo -from .gsa_record_link_result import GsaRecordLinkResult -from .gsa_record_link_results import GsaRecordLinkResults from .gsa_record_list_header import GsaRecordListHeader from .gsa_record_list_headers_info import GsaRecordListHeadersInfo from .gsa_record_list_items_info import GsaRecordListItemsInfo @@ -1371,69 +826,30 @@ from .gsa_record_reference_type import GsaRecordReferenceType from .gsa_record_subset_criterion import GsaRecordSubsetCriterion from .gsa_record_type import GsaRecordType -from .gsa_record_type_criterion import GsaRecordTypeCriterion from .gsa_record_type_property import GsaRecordTypeProperty -from .gsa_record_user_capabilities import GsaRecordUserCapabilities from .gsa_record_version import GsaRecordVersion -from .gsa_record_version_access_control_entity import GsaRecordVersionAccessControlEntity from .gsa_record_version_reference import GsaRecordVersionReference from .gsa_record_with_data import GsaRecordWithData from .gsa_referenced_by_type import GsaReferencedByType from .gsa_referential_integrity_model import GsaReferentialIntegrityModel -from .gsa_referential_integrity_model_record_link_group_error_detail import ( - GsaReferentialIntegrityModelRecordLinkGroupErrorDetail, -) -from .gsa_register_update_request import GsaRegisterUpdateRequest from .gsa_release_record_version_control_exception import GsaReleaseRecordVersionControlException from .gsa_release_table_version_control_exception import GsaReleaseTableVersionControlException from .gsa_released_date_property import GsaReleasedDateProperty from .gsa_relevance_sort_criterion import GsaRelevanceSortCriterion from .gsa_remove_record_history_from_subset import GsaRemoveRecordHistoryFromSubset from .gsa_reorder_sections_info import GsaReorderSectionsInfo -from .gsa_reorder_tables_error_detail import GsaReorderTablesErrorDetail -from .gsa_reorder_tables_error_reason import GsaReorderTablesErrorReason -from .gsa_reorder_tables_exception import GsaReorderTablesException -from .gsa_reorder_tables_request import GsaReorderTablesRequest -from .gsa_replace_discrete_values_exception import GsaReplaceDiscreteValuesException -from .gsa_replace_permission_categories_request import GsaReplacePermissionCategoriesRequest -from .gsa_replace_permission_category_error_detail import GsaReplacePermissionCategoryErrorDetail -from .gsa_replace_permission_category_error_reason import GsaReplacePermissionCategoryErrorReason from .gsa_replacement_string import GsaReplacementString from .gsa_replacement_strings_info import GsaReplacementStringsInfo -from .gsa_resolve_link_targets_info import GsaResolveLinkTargetsInfo -from .gsa_resolve_link_targets_request import GsaResolveLinkTargetsRequest -from .gsa_resolved_breadcrumb import GsaResolvedBreadcrumb +from .gsa_resolved_link import GsaResolvedLink +from .gsa_resolved_link_info import GsaResolvedLinkInfo from .gsa_resolved_link_target import GsaResolvedLinkTarget -from .gsa_resolved_target_attribute import GsaResolvedTargetAttribute from .gsa_response_options import GsaResponseOptions from .gsa_resubmit_job_request import GsaResubmitJobRequest -from .gsa_retarget_potential_request import GsaRetargetPotentialRequest -from .gsa_retarget_request import GsaRetargetRequest -from .gsa_retarget_result import GsaRetargetResult -from .gsa_retarget_result_type import GsaRetargetResultType -from .gsa_retarget_results_info import GsaRetargetResultsInfo -from .gsa_reverse_name_already_exists_as_name_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail, -) -from .gsa_reverse_name_already_exists_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail, -) -from .gsa_reverse_name_not_provided_record_link_group_error_detail import ( - GsaReverseNameNotProvidedRecordLinkGroupErrorDetail, -) from .gsa_rich_text_type import GsaRichTextType from .gsa_rich_text_value import GsaRichTextValue -from .gsa_role_not_provided_permission_error_detail import GsaRoleNotProvidedPermissionErrorDetail from .gsa_rollup_export_failure import GsaRollupExportFailure from .gsa_rollup_reference import GsaRollupReference -from .gsa_root_folder_move_error_detail import GsaRootFolderMoveErrorDetail -from .gsa_root_record_not_available_to_rename_error_detail import ( - GsaRootRecordNotAvailableToRenameErrorDetail, -) -from .gsa_rule_engine import GsaRuleEngine -from .gsa_same_parent_file_move_error_detail import GsaSameParentFileMoveErrorDetail -from .gsa_same_parent_folder_move_error_detail import GsaSameParentFolderMoveErrorDetail -from .gsa_schema_generation_warning_reason import GsaSchemaGenerationWarningReason +from .gsa_save_search_request import GsaSaveSearchRequest from .gsa_schema_too_new_add_database_validation_issue import ( GsaSchemaTooNewAddDatabaseValidationIssue, ) @@ -1441,9 +857,8 @@ GsaSchemaTooOldAddDatabaseValidationIssue, ) from .gsa_search_cluster_status import GsaSearchClusterStatus +from .gsa_search_detail import GsaSearchDetail from .gsa_search_index_status import GsaSearchIndexStatus -from .gsa_search_mask import GsaSearchMask -from .gsa_search_mask_info import GsaSearchMaskInfo from .gsa_search_mask_usage_data_modification_error_detail import ( GsaSearchMaskUsageDataModificationErrorDetail, ) @@ -1451,20 +866,13 @@ from .gsa_search_response import GsaSearchResponse from .gsa_search_result import GsaSearchResult from .gsa_search_results_request import GsaSearchResultsRequest -from .gsa_search_service_status import GsaSearchServiceStatus -from .gsa_search_template import GsaSearchTemplate -from .gsa_search_template_attribute_item import GsaSearchTemplateAttributeItem -from .gsa_search_template_info import GsaSearchTemplateInfo -from .gsa_search_template_item import GsaSearchTemplateItem -from .gsa_search_template_item_type import GsaSearchTemplateItemType -from .gsa_search_template_link_item import GsaSearchTemplateLinkItem -from .gsa_search_template_tabular_column_item import GsaSearchTemplateTabularColumnItem from .gsa_searchable_record_property import GsaSearchableRecordProperty +from .gsa_security_attribute_grouping import GsaSecurityAttributeGrouping from .gsa_security_attribute_usage_data_modification_error_detail import ( GsaSecurityAttributeUsageDataModificationErrorDetail, ) from .gsa_security_groups import GsaSecurityGroups -from .gsa_selection import GsaSelection +from .gsa_selection_search import GsaSelectionSearch from .gsa_series_graph import GsaSeriesGraph from .gsa_set_date_time_datum import GsaSetDateTimeDatum from .gsa_set_datum import GsaSetDatum @@ -1484,9 +892,6 @@ from .gsa_set_short_text_datum import GsaSetShortTextDatum from .gsa_set_tabular_datum import GsaSetTabularDatum from .gsa_set_tabular_datum_row import GsaSetTabularDatumRow -from .gsa_set_unit_equivalent import GsaSetUnitEquivalent -from .gsa_set_unit_equivalents_exception import GsaSetUnitEquivalentsException -from .gsa_set_unit_equivalents_info import GsaSetUnitEquivalentsInfo from .gsa_short_name_property import GsaShortNameProperty from .gsa_short_text_aggregation import GsaShortTextAggregation from .gsa_short_text_aggregation_datum_criterion import GsaShortTextAggregationDatumCriterion @@ -1496,16 +901,11 @@ from .gsa_short_text_datum_exists_criterion import GsaShortTextDatumExistsCriterion from .gsa_short_text_prefix_datum_criterion import GsaShortTextPrefixDatumCriterion from .gsa_significant_figures_info import GsaSignificantFiguresInfo -from .gsa_similarity_setting import GsaSimilaritySetting -from .gsa_similarity_settings import GsaSimilaritySettings -from .gsa_similarity_sort_criterion import GsaSimilaritySortCriterion from .gsa_simple_attribute_to_export import GsaSimpleAttributeToExport -from .gsa_slim_access_control_info import GsaSlimAccessControlInfo from .gsa_slim_attribute import GsaSlimAttribute -from .gsa_slim_attribute_with_help_path import GsaSlimAttributeWithHelpPath from .gsa_slim_configuration import GsaSlimConfiguration +from .gsa_slim_constant import GsaSlimConstant from .gsa_slim_database import GsaSlimDatabase -from .gsa_slim_database_access_control_info import GsaSlimDatabaseAccessControlInfo from .gsa_slim_discrete_type import GsaSlimDiscreteType from .gsa_slim_entity import GsaSlimEntity from .gsa_slim_expression import GsaSlimExpression @@ -1513,96 +913,45 @@ from .gsa_slim_identified_entity import GsaSlimIdentifiedEntity from .gsa_slim_layout import GsaSlimLayout from .gsa_slim_layout_section import GsaSlimLayoutSection -from .gsa_slim_localized_entity import GsaSlimLocalizedEntity from .gsa_slim_named_entity import GsaSlimNamedEntity +from .gsa_slim_named_unit import GsaSlimNamedUnit from .gsa_slim_objects import GsaSlimObjects from .gsa_slim_parameter import GsaSlimParameter -from .gsa_slim_parameter_with_help_path import GsaSlimParameterWithHelpPath +from .gsa_slim_permission import GsaSlimPermission +from .gsa_slim_permission_category import GsaSlimPermissionCategory from .gsa_slim_profile import GsaSlimProfile from .gsa_slim_profile_table import GsaSlimProfileTable from .gsa_slim_record_history import GsaSlimRecordHistory from .gsa_slim_record_link_group import GsaSlimRecordLinkGroup from .gsa_slim_record_version import GsaSlimRecordVersion from .gsa_slim_replacement_string import GsaSlimReplacementString -from .gsa_slim_search_mask import GsaSlimSearchMask -from .gsa_slim_search_template import GsaSlimSearchTemplate from .gsa_slim_subset import GsaSlimSubset from .gsa_slim_table import GsaSlimTable from .gsa_slim_typed_attribute import GsaSlimTypedAttribute from .gsa_slim_unit import GsaSlimUnit -from .gsa_smart_attributes_error_detail import GsaSmartAttributesErrorDetail -from .gsa_smart_attributes_error_reason import GsaSmartAttributesErrorReason -from .gsa_smart_attributes_record_link_group_error_detail import ( - GsaSmartAttributesRecordLinkGroupErrorDetail, -) -from .gsa_smart_link import GsaSmartLink -from .gsa_smart_link_create_put_layout_item import GsaSmartLinkCreatePutLayoutItem -from .gsa_smart_link_group_usage_data_modification_error_detail import ( - GsaSmartLinkGroupUsageDataModificationErrorDetail, -) -from .gsa_smart_record_link_group import GsaSmartRecordLinkGroup -from .gsa_smart_record_link_result import GsaSmartRecordLinkResult +from .gsa_slim_unit_system import GsaSlimUnitSystem +from .gsa_smtp_properties import GsaSmtpProperties from .gsa_sort_criterion import GsaSortCriterion from .gsa_sort_criterion_type import GsaSortCriterionType from .gsa_sort_direction import GsaSortDirection from .gsa_sort_type import GsaSortType from .gsa_sorting_value import GsaSortingValue from .gsa_sorting_value_type import GsaSortingValueType -from .gsa_source_cannot_be_target_smart_attributes_error_detail import ( - GsaSourceCannotBeTargetSmartAttributesErrorDetail, -) from .gsa_source_of_object_identifier import GsaSourceOfObjectIdentifier from .gsa_specific_values_specifier import GsaSpecificValuesSpecifier -from .gsa_sql_credentials import GsaSqlCredentials from .gsa_standard_name import GsaStandardName -from .gsa_standard_name_already_exists_error_detail import GsaStandardNameAlreadyExistsErrorDetail -from .gsa_standard_name_creation_exception import GsaStandardNameCreationException -from .gsa_standard_name_deletion_error_detail import GsaStandardNameDeletionErrorDetail -from .gsa_standard_name_deletion_error_reason import GsaStandardNameDeletionErrorReason -from .gsa_standard_name_deletion_exception import GsaStandardNameDeletionException -from .gsa_standard_name_error_detail import GsaStandardNameErrorDetail -from .gsa_standard_name_error_reason import GsaStandardNameErrorReason -from .gsa_standard_name_update_exception import GsaStandardNameUpdateException from .gsa_standard_names_info import GsaStandardNamesInfo -from .gsa_static_record_link import GsaStaticRecordLink from .gsa_static_record_link_group import GsaStaticRecordLinkGroup -from .gsa_static_record_link_group_mapping import GsaStaticRecordLinkGroupMapping -from .gsa_static_record_link_result import GsaStaticRecordLinkResult from .gsa_string_sorting_value import GsaStringSortingValue from .gsa_subset import GsaSubset from .gsa_subsets_info import GsaSubsetsInfo -from .gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail import ( - GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail, -) -from .gsa_symbol_cannot_contain_comma_unit_error_detail import ( - GsaSymbolCannotContainCommaUnitErrorDetail, -) -from .gsa_t_item import GsaTItem from .gsa_table import GsaTable -from .gsa_table_access_control_entity import GsaTableAccessControlEntity -from .gsa_table_creation_exception import GsaTableCreationException from .gsa_table_deletion_exception import GsaTableDeletionException -from .gsa_table_descendants_access_control_entity import GsaTableDescendantsAccessControlEntity -from .gsa_table_error_detail import GsaTableErrorDetail -from .gsa_table_error_reason import GsaTableErrorReason from .gsa_table_guid_property import GsaTableGuidProperty from .gsa_table_identity_property import GsaTableIdentityProperty from .gsa_table_name_property import GsaTableNameProperty -from .gsa_table_search_behaviour import GsaTableSearchBehaviour -from .gsa_table_type_contains_comma_error_detail import GsaTableTypeContainsCommaErrorDetail -from .gsa_table_type_error_detail import GsaTableTypeErrorDetail -from .gsa_table_type_error_reason import GsaTableTypeErrorReason -from .gsa_table_types_error_detail import GsaTableTypesErrorDetail -from .gsa_table_types_info import GsaTableTypesInfo -from .gsa_table_update_exception import GsaTableUpdateException -from .gsa_table_usage_data_modification_error_detail import GsaTableUsageDataModificationErrorDetail -from .gsa_table_version_state_access_control_category_error_detail import ( - GsaTableVersionStateAccessControlCategoryErrorDetail, -) from .gsa_tables_info import GsaTablesInfo -from .gsa_tables_missing_reorder_tables_error_detail import GsaTablesMissingReorderTablesErrorDetail from .gsa_tabular_attribute import GsaTabularAttribute -from .gsa_tabular_attribute_link import GsaTabularAttributeLink from .gsa_tabular_attribute_target import GsaTabularAttributeTarget from .gsa_tabular_attribute_usage_data_modification_error_detail import ( GsaTabularAttributeUsageDataModificationErrorDetail, @@ -1615,9 +964,6 @@ ) from .gsa_tabular_column_no_such_entity_type import GsaTabularColumnNoSuchEntityType from .gsa_tabular_column_roll_up_type import GsaTabularColumnRollUpType -from .gsa_tabular_column_usage_data_modification_error_detail import ( - GsaTabularColumnUsageDataModificationErrorDetail, -) from .gsa_tabular_datum import GsaTabularDatum from .gsa_tabular_datum_cell import GsaTabularDatumCell from .gsa_tabular_datum_exists_criterion import GsaTabularDatumExistsCriterion @@ -1626,103 +972,42 @@ from .gsa_tabular_datum_summary_row import GsaTabularDatumSummaryRow from .gsa_tabular_linking_value_criterion import GsaTabularLinkingValueCriterion from .gsa_tabular_row_export_behavior import GsaTabularRowExportBehavior -from .gsa_target_attribute import GsaTargetAttribute from .gsa_target_attribute_not_in_table_attribute_error_detail import ( GsaTargetAttributeNotInTableAttributeErrorDetail, ) -from .gsa_target_attribute_type import GsaTargetAttributeType from .gsa_target_attribute_type_attribute_error_detail import ( GsaTargetAttributeTypeAttributeErrorDetail, ) -from .gsa_target_not_fully_specified_attribute_error_detail import ( - GsaTargetNotFullySpecifiedAttributeErrorDetail, -) from .gsa_term_with_count import GsaTermWithCount from .gsa_text_match_behavior import GsaTextMatchBehavior from .gsa_threshold_type_attribute_error_detail import GsaThresholdTypeAttributeErrorDetail -from .gsa_threshold_value_name_empty_error_detail import GsaThresholdValueNameEmptyErrorDetail -from .gsa_threshold_value_name_invalid_error_detail import GsaThresholdValueNameInvalidErrorDetail -from .gsa_too_long_code_currency_error_detail import GsaTooLongCodeCurrencyErrorDetail -from .gsa_too_many_attribute_pairs_smart_attributes_error_detail import ( - GsaTooManyAttributePairsSmartAttributesErrorDetail, -) -from .gsa_too_many_permissions_permission_category_error_detail import ( - GsaTooManyPermissionsPermissionCategoryErrorDetail, -) -from .gsa_too_many_permissions_replace_permission_category_error_detail import ( - GsaTooManyPermissionsReplacePermissionCategoryErrorDetail, -) -from .gsa_translate_between_guids_and_identities_response import ( - GsaTranslateBetweenGuidsAndIdentitiesResponse, -) from .gsa_translate_guids_to_identities_request import GsaTranslateGuidsToIdentitiesRequest -from .gsa_translate_identities_to_guids_request import GsaTranslateIdentitiesToGuidsRequest +from .gsa_translate_guids_to_identities_response import GsaTranslateGuidsToIdentitiesResponse from .gsa_unable_to_connect_add_database_validation_issue import ( GsaUnableToConnectAddDatabaseValidationIssue, ) from .gsa_unavailable_tabular_column import GsaUnavailableTabularColumn from .gsa_unit import GsaUnit -from .gsa_unit_as_exponent_unit_equation_error_detail import ( - GsaUnitAsExponentUnitEquationErrorDetail, -) from .gsa_unit_conversion_set import GsaUnitConversionSet from .gsa_unit_conversion_set_request import GsaUnitConversionSetRequest from .gsa_unit_conversions_info import GsaUnitConversionsInfo -from .gsa_unit_creation_exception import GsaUnitCreationException -from .gsa_unit_deletion_exception import GsaUnitDeletionException -from .gsa_unit_equation_error_detail import GsaUnitEquationErrorDetail -from .gsa_unit_equation_error_reason import GsaUnitEquationErrorReason from .gsa_unit_equivalent import GsaUnitEquivalent -from .gsa_unit_equivalent_error_detail import GsaUnitEquivalentErrorDetail -from .gsa_unit_equivalent_error_reason import GsaUnitEquivalentErrorReason from .gsa_unit_equivalents_info import GsaUnitEquivalentsInfo -from .gsa_unit_error_detail import GsaUnitErrorDetail -from .gsa_unit_error_reason import GsaUnitErrorReason from .gsa_unit_mapping import GsaUnitMapping from .gsa_unit_system import GsaUnitSystem from .gsa_unit_systems_info import GsaUnitSystemsInfo -from .gsa_unit_update_exception import GsaUnitUpdateException from .gsa_unit_usage import GsaUnitUsage -from .gsa_unit_usage_data_modification_error_detail import GsaUnitUsageDataModificationErrorDetail -from .gsa_unit_usage_type import GsaUnitUsageType -from .gsa_units_grouping_info import GsaUnitsGroupingInfo from .gsa_units_info import GsaUnitsInfo -from .gsa_unknown_unit_symbol_unit_equation_error_detail import ( - GsaUnknownUnitSymbolUnitEquationErrorDetail, -) -from .gsa_unresolved_attribute_guids_error_detail import GsaUnresolvedAttributeGuidsErrorDetail -from .gsa_unresolved_breadcrumb import GsaUnresolvedBreadcrumb -from .gsa_unresolved_cross_database_record_link_group_guids_error_detail import ( - GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .gsa_unresolved_parameter_guids_error_detail import GsaUnresolvedParameterGuidsErrorDetail -from .gsa_unresolved_record_link_group_guids_error_detail import ( - GsaUnresolvedRecordLinkGroupGuidsErrorDetail, -) -from .gsa_unresolved_reverse_record_link_groups_error_detail import ( - GsaUnresolvedReverseRecordLinkGroupsErrorDetail, -) -from .gsa_unresolved_target_attribute import GsaUnresolvedTargetAttribute -from .gsa_update_access_control import GsaUpdateAccessControl -from .gsa_update_access_control_category import GsaUpdateAccessControlCategory -from .gsa_update_access_control_category_table_mapping import ( - GsaUpdateAccessControlCategoryTableMapping, -) from .gsa_update_all_profiles_info import GsaUpdateAllProfilesInfo from .gsa_update_attribute import GsaUpdateAttribute -from .gsa_update_attribute_based_access_control import GsaUpdateAttributeBasedAccessControl from .gsa_update_axis_name import GsaUpdateAxisName from .gsa_update_configuration import GsaUpdateConfiguration from .gsa_update_constant import GsaUpdateConstant from .gsa_update_continuous_range import GsaUpdateContinuousRange from .gsa_update_cross_database_record_link_group import GsaUpdateCrossDatabaseRecordLinkGroup -from .gsa_update_current_rule_engine import GsaUpdateCurrentRuleEngine from .gsa_update_data_rule import GsaUpdateDataRule from .gsa_update_database import GsaUpdateDatabase -from .gsa_update_database_security_groups import GsaUpdateDatabaseSecurityGroups from .gsa_update_date_time_attribute import GsaUpdateDateTimeAttribute -from .gsa_update_default_database import GsaUpdateDefaultDatabase -from .gsa_update_default_fallback_security_groups import GsaUpdateDefaultFallbackSecurityGroups from .gsa_update_default_profile import GsaUpdateDefaultProfile from .gsa_update_discrete_attribute import GsaUpdateDiscreteAttribute from .gsa_update_discrete_functional_attribute import GsaUpdateDiscreteFunctionalAttribute @@ -1740,8 +1025,7 @@ from .gsa_update_discrete_parameter_value import GsaUpdateDiscreteParameterValue from .gsa_update_discrete_range import GsaUpdateDiscreteRange from .gsa_update_discrete_type import GsaUpdateDiscreteType -from .gsa_update_display_names import GsaUpdateDisplayNames -from .gsa_update_display_names_response import GsaUpdateDisplayNamesResponse +from .gsa_update_dynamic_record_link_group import GsaUpdateDynamicRecordLinkGroup from .gsa_update_expression import GsaUpdateExpression from .gsa_update_file import GsaUpdateFile from .gsa_update_file_attribute import GsaUpdateFileAttribute @@ -1760,7 +1044,6 @@ from .gsa_update_integer_attribute import GsaUpdateIntegerAttribute from .gsa_update_job_request import GsaUpdateJobRequest from .gsa_update_layout import GsaUpdateLayout -from .gsa_update_layout_section import GsaUpdateLayoutSection from .gsa_update_linked_attribute_tabular_column import GsaUpdateLinkedAttributeTabularColumn from .gsa_update_linked_column_tabular_column import GsaUpdateLinkedColumnTabularColumn from .gsa_update_linked_record_tabular_column import GsaUpdateLinkedRecordTabularColumn @@ -1785,88 +1068,50 @@ from .gsa_update_parameter import GsaUpdateParameter from .gsa_update_parameter_content import GsaUpdateParameterContent from .gsa_update_parameter_value import GsaUpdateParameterValue -from .gsa_update_permission import GsaUpdatePermission -from .gsa_update_permission_access_control import GsaUpdatePermissionAccessControl -from .gsa_update_permission_based_access_control import GsaUpdatePermissionBasedAccessControl -from .gsa_update_permission_category import GsaUpdatePermissionCategory -from .gsa_update_permission_category_access_control import GsaUpdatePermissionCategoryAccessControl -from .gsa_update_permission_category_access_control_request import ( - GsaUpdatePermissionCategoryAccessControlRequest, -) -from .gsa_update_permission_category_access_controls_operation_request import ( - GsaUpdatePermissionCategoryAccessControlsOperationRequest, -) from .gsa_update_picture_attribute import GsaUpdatePictureAttribute from .gsa_update_point_attribute import GsaUpdatePointAttribute from .gsa_update_profile import GsaUpdateProfile from .gsa_update_profile_table import GsaUpdateProfileTable -from .gsa_update_put_discrete_value import GsaUpdatePutDiscreteValue -from .gsa_update_put_layout_item import GsaUpdatePutLayoutItem -from .gsa_update_put_permission import GsaUpdatePutPermission -from .gsa_update_put_permission_category import GsaUpdatePutPermissionCategory from .gsa_update_range_attribute import GsaUpdateRangeAttribute from .gsa_update_record_link_group import GsaUpdateRecordLinkGroup from .gsa_update_record_list_permission_flags import GsaUpdateRecordListPermissionFlags from .gsa_update_record_list_properties import GsaUpdateRecordListProperties from .gsa_update_replacement_string import GsaUpdateReplacementString -from .gsa_update_root_folder_error_detail import GsaUpdateRootFolderErrorDetail -from .gsa_update_run_status import GsaUpdateRunStatus from .gsa_update_short_text_attribute import GsaUpdateShortTextAttribute -from .gsa_update_smart_record_link_group import GsaUpdateSmartRecordLinkGroup from .gsa_update_standard_name import GsaUpdateStandardName from .gsa_update_static_record_link_group import GsaUpdateStaticRecordLinkGroup -from .gsa_update_static_record_link_group_mapping import GsaUpdateStaticRecordLinkGroupMapping from .gsa_update_subset import GsaUpdateSubset from .gsa_update_table import GsaUpdateTable from .gsa_update_tabular_attribute import GsaUpdateTabularAttribute from .gsa_update_tabular_attribute_target import GsaUpdateTabularAttributeTarget from .gsa_update_tabular_column import GsaUpdateTabularColumn -from .gsa_update_tabular_column_property_not_provided_attribute_error_detail import ( - GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail, -) -from .gsa_update_tabular_column_type_attribute_error_detail import ( - GsaUpdateTabularColumnTypeAttributeErrorDetail, -) from .gsa_update_unavailable_tabular_column import GsaUpdateUnavailableTabularColumn from .gsa_update_unit import GsaUpdateUnit from .gsa_update_unit_system import GsaUpdateUnitSystem from .gsa_update_user_permission import GsaUpdateUserPermission from .gsa_update_user_permissions_info import GsaUpdateUserPermissionsInfo -from .gsa_upgrade_database_exception import GsaUpgradeDatabaseException -from .gsa_upgrade_database_failure_reason import GsaUpgradeDatabaseFailureReason from .gsa_usage_data_modification_error_detail import GsaUsageDataModificationErrorDetail -from .gsa_user_capabilities import GsaUserCapabilities +from .gsa_user_or_group import GsaUserOrGroup from .gsa_user_permission import GsaUserPermission from .gsa_user_permissions_info import GsaUserPermissionsInfo from .gsa_user_role import GsaUserRole from .gsa_validate_attribute_request import GsaValidateAttributeRequest -from .gsa_validate_unit_equation_request import GsaValidateUnitEquationRequest -from .gsa_validate_unit_equation_response import GsaValidateUnitEquationResponse -from .gsa_value_not_provided_parameter_value_error_detail import ( - GsaValueNotProvidedParameterValueErrorDetail, -) from .gsa_value_specifier import GsaValueSpecifier from .gsa_value_specifier_type import GsaValueSpecifierType from .gsa_value_with_count_of_boolean import GsaValueWithCountOfBoolean from .gsa_value_with_count_of_guid import GsaValueWithCountOfGuid from .gsa_value_with_count_of_int32 import GsaValueWithCountOfInt32 from .gsa_version_control_error_detail import GsaVersionControlErrorDetail -from .gsa_version_control_error_reason import GsaVersionControlErrorReason -from .gsa_version_control_mode import GsaVersionControlMode from .gsa_version_controlled_data_usage_data_modification_error_detail import ( GsaVersionControlledDataUsageDataModificationErrorDetail, ) from .gsa_version_number_property import GsaVersionNumberProperty from .gsa_version_state import GsaVersionState from .gsa_version_state_property import GsaVersionStateProperty -from .gsa_weighting_type import GsaWeightingType from .gsa_withdraw_record_version_control_exception import GsaWithdrawRecordVersionControlException -from .gsa_xy_chart_template import GsaXYChartTemplate from .gsa_xy_chart_template_usage_data_modification_error_detail import ( GsaXYChartTemplateUsageDataModificationErrorDetail, ) -from .gsa_xy_chart_templates_info import GsaXYChartTemplatesInfo -from .gsa_xy_template_axis import GsaXYTemplateAxis from .jobqueue_files_body import JobqueueFilesBody from .json_patch_document import JsonPatchDocument from .microsoft_asp_net_core_mvc_formatters_i_output_formatter import ( @@ -1891,46 +1136,12 @@ "FolderguidFilesBody1", "FolderguidFilesBody2", "GrantaMIRecordPropertyFakeAttributeIdentities", - "GrantaMISearchFreeTextIdentifiers", "GsaAboutAttributeCannotBeMetaAttributeErrorDetail", - "GsaAccessControlCategoriesInfo", - "GsaAccessControlCategory", - "GsaAccessControlCategoryCreationException", - "GsaAccessControlCategoryErrorDetail", - "GsaAccessControlCategoryErrorReason", - "GsaAccessControlCategoryInclude", - "GsaAccessControlCategoryNoSuchEntityType", - "GsaAccessControlCategoryTableMapping", - "GsaAccessControlCategoryUpdateException", - "GsaAccessControlDatabaseUserCapabilities", - "GsaAccessControlEntitiesAggregationErrorDetail", - "GsaAccessControlEntitiesErrorDetail", - "GsaAccessControlEntitiesUpdateOperationsErrorDetail", - "GsaAccessControlEntity", - "GsaAccessControlEntityType", - "GsaAccessControlInfo", - "GsaAccessControlMode", - "GsaAccessControlUserCapabilities", - "GsaActivityLogApplicationNameFilter", - "GsaActivityLogApplicationNamesCollectionFilter", - "GsaActivityLogCollectionMatchType", - "GsaActivityLogDatabaseKeyFilter", - "GsaActivityLogDateFilter", - "GsaActivityLogEntriesFilter", - "GsaActivityLogEntriesInfo", - "GsaActivityLogEntry", - "GsaActivityLogMatchType", - "GsaActivityLogUsageMode", - "GsaActivityLogUsageModeFilter", - "GsaActivityLogUsernameFilter", "GsaAddDatabase", "GsaAddDatabaseIssueType", - "GsaAddDatabaseSecurityGroups", "GsaAddDatabaseValidationIssue", "GsaAddDatabaseValidationResult", "GsaAddRecordHistoryToSubset", - "GsaAdditionalSqlParameters", - "GsaAggregatePermissionAccessControlsRequest", "GsaAggregation", "GsaAggregationCriterion", "GsaAggregationDatum", @@ -1951,23 +1162,16 @@ "GsaAppendPointValues", "GsaApplicableDatum", "GsaApplicationsInfo", - "GsaApplyOptions", - "GsaAssociationChainCreatePutLayoutItem", "GsaAttribute", - "GsaAttributeAccessControlEntity", "GsaAttributeAggregation", "GsaAttributeAggregationCriterion", "GsaAttributeAggregationExistsCriterion", "GsaAttributeAggregationType", "GsaAttributeAggregationValueCriterion", - "GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "GsaAttributeBasedAccessControlInfo", - "GsaAttributeCreatePutLayoutItem", "GsaAttributeCreationException", "GsaAttributeCriterion", "GsaAttributeCriterionType", "GsaAttributeDeletionException", - "GsaAttributeDiscreteTypeMismatchErrorDetail", "GsaAttributeErrorDetail", "GsaAttributeErrorReason", "GsaAttributeExistsAggregation", @@ -1979,76 +1183,42 @@ "GsaAttributeMatchesCriterion", "GsaAttributeNoSuchEntityType", "GsaAttributeNotApplicableCriterion", - "GsaAttributeNotOnTableErrorDetail", - "GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "GsaAttributePairTypeMismatchSmartAttributesErrorDetail", "GsaAttributeReference", "GsaAttributeScaleType", "GsaAttributeSortCriterion", "GsaAttributeThresholdType", "GsaAttributeToExport", "GsaAttributeType", - "GsaAttributeTypeAttributeErrorDetail", - "GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", - "GsaAttributeUpdateException", "GsaAttributeUsageDataModificationErrorDetail", "GsaAttributeValidateResponse", "GsaAttributeValueAggregation", "GsaAttributesInfo", "GsaAxisName", - "GsaBlobInfoDto", "GsaBooleanCriterion", "GsaBoostByGuid", "GsaBoostByIdentity", - "GsaBracketMismatchUnitEquationErrorDetail", - "GsaBreadcrumb", - "GsaBreadcrumbType", - "GsaBreadcrumbsProperty", "GsaBulkInfo", "GsaBulkRequest", "GsaBulkRequestHttpMethod", "GsaBulkRequestItem", "GsaBulkResponseItem", "GsaCalendarInterval", - "GsaCannotChangeDiscreteTypeAttributeErrorDetail", - "GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail", - "GsaCannotDeleteTabularColumnAttributeErrorDetail", - "GsaCannotRemoveParameterInUseAttributeErrorDetail", - "GsaCategoryReplacePermissionCategoryErrorDetail", - "GsaChartData", - "GsaChartDataType", - "GsaCircularReferenceFolderMoveErrorDetail", - "GsaCodeMissingCurrencyErrorDetail", - "GsaCodeWhitespaceCurrencyErrorDetail", - "GsaConfigInvalidJsonFileErrorDetail", "GsaConfiguration", - "GsaConfigurationDetails", "GsaConfigurationsInfo", "GsaConnectionDetails", "GsaConstant", - "GsaConstantCreationException", "GsaConstantDeletionException", - "GsaConstantErrorDetail", - "GsaConstantErrorReason", - "GsaConstantUpdateException", - "GsaConstantUsageDataModificationErrorDetail", "GsaConstantsInfo", - "GsaContinuousQualitySystem", "GsaContinuousRange", "GsaCopyRecordHistory", - "GsaCreateAccessControlCategory", - "GsaCreateAccessControlCategoryTableMapping", "GsaCreateAttribute", "GsaCreateAttributeLinkPair", "GsaCreateAxisName", "GsaCreateConfiguration", "GsaCreateConstant", - "GsaCreateContinuousQualitySystem", "GsaCreateContinuousRange", - "GsaCreateCrossDatabaseLinkTarget", "GsaCreateCrossDatabaseRecordLinkGroup", "GsaCreateDataRule", - "GsaCreateDataUpdateServerApiRequest", "GsaCreateDateTimeAttribute", "GsaCreateDiscreteAttribute", "GsaCreateDiscreteFunctionalAttribute", @@ -2058,9 +1228,9 @@ "GsaCreateDiscreteParameter", "GsaCreateDiscreteParameterContent", "GsaCreateDiscreteParameterValue", - "GsaCreateDiscreteQualitySystem", "GsaCreateDiscreteRange", "GsaCreateDiscreteType", + "GsaCreateDynamicRecordLinkGroup", "GsaCreateExpression", "GsaCreateFileAttribute", "GsaCreateFloatFunctionalAttribute", @@ -2098,51 +1268,31 @@ "GsaCreateParameter", "GsaCreateParameterContent", "GsaCreateParameterValue", - "GsaCreatePermission", - "GsaCreatePermissionCategory", "GsaCreatePictureAttribute", "GsaCreatePointAttribute", "GsaCreateProfile", "GsaCreateProfileTable", - "GsaCreatePutDiscreteValue", - "GsaCreatePutLayoutItem", - "GsaCreatePutPermission", - "GsaCreatePutPermissionCategory", - "GsaCreateQualityDiscreteValue", - "GsaCreateQualitySystem", "GsaCreateRangeAttribute", "GsaCreateRecordHistory", "GsaCreateRecordLinkGroup", "GsaCreateRecordList", "GsaCreateRecordListItemsInfo", "GsaCreateReplacementString", + "GsaCreateSearchRequest", "GsaCreateShortTextAttribute", - "GsaCreateSmartLinkTarget", - "GsaCreateSmartRecordLinkGroup", "GsaCreateStandardName", - "GsaCreateStaticLinkTarget", "GsaCreateStaticRecordLinkGroup", - "GsaCreateStaticRecordLinkGroupMapping", "GsaCreateSubset", "GsaCreateTable", "GsaCreateTabularAttribute", "GsaCreateTabularColumn", "GsaCreateUnit", - "GsaCreateUnitMapping", "GsaCreateUnitSystem", "GsaCreatedByUserProperty", "GsaCreatedDateProperty", "GsaCriterion", "GsaCriterionType", - "GsaCrossDatabaseLink", - "GsaCrossDatabaseLinkCreatePutLayoutItem", - "GsaCrossDatabaseRecordLink", "GsaCrossDatabaseRecordLinkGroup", - "GsaCrossDatabaseRecordLinkResult", - "GsaCurrenciesInfo", - "GsaCurrency", - "GsaCurrencyErrorDetail", - "GsaCurrencyErrorReason", "GsaCurrentUser", "GsaDataExportApplicableDatum", "GsaDataExportBinaryData", @@ -2192,27 +1342,11 @@ "GsaDataModificationErrorReason", "GsaDataRule", "GsaDataRulesInfo", - "GsaDataSource", - "GsaDataUpdate", - "GsaDataUpdateDeletionException", - "GsaDataUpdateHeader", - "GsaDataUpdateRunInfo", - "GsaDataUpdateToken", - "GsaDataUpdaterJob", - "GsaDataUpdaterJobStatus", - "GsaDataUpdaterJobType", - "GsaDataUpdaterProject", "GsaDataUsageDataModificationErrorDetail", "GsaDatabase", - "GsaDatabaseAccessControlEntity", - "GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "GsaDatabaseIssues", "GsaDatabaseKeyProperty", - "GsaDatabaseSecurityGroups", - "GsaDatabaseSecurityGroupsInfo", "GsaDatabaseStatus", "GsaDatabaseStatusInformation", - "GsaDatabaseUserCapabilities", "GsaDatabasesInfo", "GsaDateTimeAggregation", "GsaDateTimeAggregationDatumCriterion", @@ -2240,22 +1374,11 @@ "GsaDatumRollupType", "GsaDatumType", "GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail", - "GsaDefaultFallbackSecurityGroups", "GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail", - "GsaDefaultLayoutGuidErrorDetail", - "GsaDefaultParameterValueGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexParameterErrorDetail", - "GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", "GsaDefaultParameterValueUsageDataModificationErrorDetail", - "GsaDefaultSubsetGuidErrorDetail", "GsaDeleteRecordListItem", "GsaDeleteRecordListItems", - "GsaDeletionEntityType", - "GsaDeletionException", - "GsaDescriptionLengthFileErrorDetail", "GsaDiscreteAttribute", - "GsaDiscreteChartData", "GsaDiscreteDatum", "GsaDiscreteDatumExistsCriterion", "GsaDiscreteFunctionalAttribute", @@ -2282,7 +1405,6 @@ "GsaDiscreteParameterNameConstraint", "GsaDiscreteParameterValue", "GsaDiscreteParameterValueConstraint", - "GsaDiscreteQualitySystem", "GsaDiscreteRange", "GsaDiscreteRangeDatumCriterion", "GsaDiscreteSeries", @@ -2294,107 +1416,52 @@ "GsaDiscreteTextPrefixDatumCriterion", "GsaDiscreteTextValuesDatumCriterion", "GsaDiscreteType", - "GsaDiscreteTypeCreationException", "GsaDiscreteTypeDeletionException", - "GsaDiscreteTypeErrorDetail", - "GsaDiscreteTypeErrorReason", - "GsaDiscreteTypeUpdateException", "GsaDiscreteTypeUsage", - "GsaDiscreteTypeUsageType", "GsaDiscreteTypesInfo", "GsaDiscreteValue", - "GsaDiscreteValueCreationException", - "GsaDiscreteValueDeletionException", - "GsaDiscreteValueErrorDetail", - "GsaDiscreteValueErrorReason", - "GsaDiscreteValueNotInDiscreteTypeErrorDetail", - "GsaDiscreteValueUpdateException", - "GsaDiscreteValueUsedInDataErrorDetail", + "GsaDiscreteValueAggregateErrorReason", + "GsaDiscreteValueAggregateException", "GsaDiscreteValuesCreateDiscreteValue", "GsaDiscreteValuesDiscreteValue", "GsaDiscreteValuesDiscreteValuesInfo", - "GsaDiscreteValuesErrorDetail", "GsaDiscreteValuesReplaceDiscreteValuesInfo", "GsaDiscreteValuesUpdateDiscreteValue", "GsaDiskStatus", - "GsaDisplayNameEmptyErrorDetail", - "GsaDisplayNameLanguageNotProvidedErrorDetail", - "GsaDisplayNameLanguageNotSupportedErrorDetail", - "GsaDisplayNamesImportErrorDetail", - "GsaDisplayNamesImportErrorReason", - "GsaDisplayNamesImportException", - "GsaDisplayNamesInfo", - "GsaDivideByZeroUnitEquationErrorDetail", "GsaDoubleSortingValue", - "GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "GsaDuplicateCodeCurrencyErrorDetail", "GsaDuplicateDatabaseAddDatabaseValidationIssue", - "GsaDuplicateDiscreteValueErrorDetail", "GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail", "GsaDuplicateGuidAddDatabaseValidationIssue", "GsaDuplicateKeyAddDatabaseValidationIssue", - "GsaDuplicateMappedAttributeGuidsErrorDetail", - "GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateMappedParameterGuidsErrorDetail", - "GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateNameCurrencyErrorDetail", "GsaDuplicateParameterGuidsAttributeErrorDetail", - "GsaDuplicatePermissionGuidsAccessControlErrorDetail", - "GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "GsaDuplicateSymbolUnitErrorDetail", - "GsaDuplicateTableErrorDetail", - "GsaDuplicateTablesReorderTablesErrorDetail", "GsaDuplicateTabularColumnGuidsErrorDetail", "GsaDuplicateTabularColumnNamesErrorDetail", "GsaDuplicateVersionGuidAddDatabaseValidationIssue", + "GsaDynamicLinkGroupUsageDataModificationErrorDetail", + "GsaDynamicRecordLinkGroup", "GsaEmptyAxisNameAttributeErrorDetail", - "GsaEmptySymbolUnitErrorDetail", - "GsaEmptyTableTypeErrorDetail", "GsaEnabledLicensesInfo", "GsaEntityAlreadyExistsErrorDetail", "GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "GsaEntityType", - "GsaEquationUnitErrorDetail", - "GsaErrorCode", - "GsaErrorDetailOfRecordHistoryErrorReason", - "GsaErrorDetailOfUpgradeDatabaseFailureReason", - "GsaErrorResponse", - "GsaExceptionInformation", + "GsaErrorDetail", "GsaExcludeValuesSpecifier", "GsaExistingTabularColumnGuidErrorDetail", "GsaExportFailure", "GsaExportFailureType", "GsaExporterRefetchInfo", "GsaExpression", - "GsaExpressionAccessControlEntity", - "GsaExpressionDeletionException", "GsaExpressionMathsFunctionalErrorDetail", "GsaExpressionUsageDataModificationErrorDetail", "GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail", "GsaExpressionsInfo", - "GsaFileAlreadyExistsFileMoveErrorDetail", "GsaFileAttribute", - "GsaFileCreationException", "GsaFileDatum", "GsaFileDatumCriterion", "GsaFileDatumExistsCriterion", - "GsaFileErrorDetail", - "GsaFileErrorReason", "GsaFileHeader", - "GsaFileHeaderInfo", - "GsaFileMoveErrorDetail", - "GsaFileMoveErrorReason", - "GsaFileMoveException", - "GsaFileNameFileErrorDetail", - "GsaFileNameFolderErrorDetail", "GsaFilePrefixDatumCriterion", - "GsaFileUpdateException", "GsaFilesInfo", - "GsaFindSimilarRequest", - "GsaFindSimilarResponse", - "GsaFindSimilarResult", - "GsaFindSimilarSearchCriterion", + "GsaFindSearchRequest", "GsaFindStandardNames", "GsaFloatFunctionalAggregation", "GsaFloatFunctionalAggregationDatumCriterion", @@ -2416,20 +1483,7 @@ "GsaFloatSeriesGraph", "GsaFloatSeriesPoint", "GsaFolder", - "GsaFolderAlreadyExistsFolderMoveErrorDetail", - "GsaFolderCreationException", - "GsaFolderDeletionErrorDetail", - "GsaFolderDeletionErrorReason", - "GsaFolderDeletionException", - "GsaFolderErrorDetail", - "GsaFolderErrorReason", - "GsaFolderMoveErrorDetail", - "GsaFolderMoveErrorReason", - "GsaFolderMoveException", - "GsaFolderType", - "GsaFolderUpdateException", "GsaFoldersInfo", - "GsaForbidOrphansRecordLinkGroupErrorDetail", "GsaFreeTextAggregation", "GsaFreeTextAggregationCriterion", "GsaFreeTextCriterion", @@ -2437,18 +1491,14 @@ "GsaFullLayoutSection", "GsaFullNameProperty", "GsaFuncNoParamsAttributeErrorDetail", - "GsaFunctionalDataDefaultUsageDataModificationErrorDetail", "GsaFunctionalDatumParameterInfo", "GsaFunctionalParameterSetting", "GsaFunctionalType", - "GsaGeneralUnitEquationErrorDetail", "GsaGeneratedIntegrationSchemaOfObjectIdentifier", - "GsaGetFindSimilarResultsResponse", "GsaGetJobsResponse", "GsaGetJobsSummaryResponse", "GsaGetModifiableRecordVersionControlException", "GsaGetUnitConversionsRequest", - "GsaGetUnitEquivalentsException", "GsaGraph", "GsaGraphDecorationType", "GsaGraphEvaluationSettings", @@ -2457,7 +1507,6 @@ "GsaGraphType", "GsaGraphValue", "GsaGraphValueType", - "GsaGrid", "GsaGridGraph", "GsaGuidOnlyAttribute", "GsaGuidOnlyDiscreteType", @@ -2466,7 +1515,6 @@ "GsaGuidOnlyLayout", "GsaGuidOnlyMappingOfObjectIdentifier", "GsaGuidOnlySourceOfObjectIdentifier", - "GsaHelpPathsValidationResponse", "GsaHistogram", "GsaHistogramBucket", "GsaHyperlinkAttribute", @@ -2475,18 +1523,12 @@ "GsaHyperlinkDatumExistsCriterion", "GsaHyperlinkPrefixDatumCriterion", "GsaHyperlinkTarget", - "GsaInUseParameterValueErrorDetail", - "GsaInclusiveness", - "GsaIncompatibleUnitsErrorDetail", "GsaIndexRecordFailure", "GsaIndirectLinks", - "GsaInputConnectionDetails", "GsaInputValidationErrorDetail", - "GsaInputValidationErrorReason", "GsaIntegerAggregation", "GsaIntegerAggregationDatumCriterion", "GsaIntegerAttribute", - "GsaIntegerChartData", "GsaIntegerDatum", "GsaIntegerDatumCriterion", "GsaIntegerDatumExistsCriterion", @@ -2501,8 +1543,6 @@ "GsaIntegrationSchemaGenerationErrorDetail", "GsaIntegrationSchemaOfObjectIdentifier", "GsaIntegrationSchemaStatus", - "GsaInvalidEquivalenceTargetErrorDetail", - "GsaInvalidExchangeRateCurrencyErrorDetail", "GsaInvalidKeyAddDatabaseValidationIssue", "GsaInvalidParentStateErrorDetail", "GsaInvalidVersionStateErrorDetail", @@ -2522,7 +1562,6 @@ "GsaLayoutSectionsInfo", "GsaLayoutTabularColumn", "GsaLayoutsInfo", - "GsaLink", "GsaLinkAggregation", "GsaLinkAggregationDatumCriterion", "GsaLinkAttributeToExport", @@ -2575,27 +1614,19 @@ "GsaLocalRangeTabularColumn", "GsaLocalRowsBehavior", "GsaLocalShortTextTabularColumn", - "GsaLogScaleNegativeParameterValueErrorDetail", "GsaLogicalAggregation", "GsaLogicalAggregationDatumCriterion", "GsaLogicalAttribute", - "GsaLogicalChartData", "GsaLogicalDatum", "GsaLogicalDatumCriterion", "GsaLogicalDatumExistsCriterion", - "GsaLongRunningOperation", - "GsaLongRunningOperationInclude", - "GsaLongRunningOperationInvalidStatusException", - "GsaLongRunningStatus", "GsaLongSortingValue", "GsaLongTextAttribute", "GsaLongTextDatum", "GsaLongTextDatumCriterion", "GsaLongTextDatumExistsCriterion", "GsaLongTextPrefixDatumCriterion", - "GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", "GsaMappingOfObjectIdentifier", - "GsaMatchMode", "GsaMathsContent", "GsaMathsFunctionalAttribute", "GsaMathsFunctionalAttributeErrorDetail", @@ -2603,8 +1634,6 @@ "GsaMathsFunctionalDatumExistsCriterion", "GsaMathsFunctionalErrorDetail", "GsaMathsFunctionalErrorReason", - "GsaMaxPermissionsReachedPermissionErrorDetail", - "GsaMetaAttributeCannotHaveMetaAttributeErrorDetail", "GsaMfaExpressionErrorDetail", "GsaMfaExpressionErrorReason", "GsaMiVersion", @@ -2613,38 +1642,12 @@ "GsaMoveFile", "GsaMoveFolder", "GsaMoveRecordHistory", - "GsaMultiValuedAttributeErrorDetail", - "GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "GsaMultiValuedReason", - "GsaMultiValuedSmartAttributesErrorDetail", - "GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", "GsaNameAlreadyExistsErrorDetail", - "GsaNameAlreadySpecifiedErrorDetail", - "GsaNameMissingCurrencyErrorDetail", "GsaNameNotProvidedErrorDetail", - "GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "GsaNameWhitespaceCurrencyErrorDetail", - "GsaNameWhitespaceParameterValueErrorDetail", "GsaNamedCriterion", - "GsaNamedEntityAccessControlCategoryErrorDetail", "GsaNamedEntityAttributeErrorDetail", - "GsaNamedEntityConstantErrorDetail", - "GsaNamedEntityDiscreteTypeErrorDetail", - "GsaNamedEntityDiscreteValueErrorDetail", "GsaNamedEntityErrorDetail", "GsaNamedEntityErrorReason", - "GsaNamedEntityFileErrorDetail", - "GsaNamedEntityFolderErrorDetail", - "GsaNamedEntityParameterErrorDetail", - "GsaNamedEntityParameterValueErrorDetail", - "GsaNamedEntityPermissionCategoryErrorDetail", - "GsaNamedEntityPermissionErrorDetail", - "GsaNamedEntityQualityDiscreteValueErrorDetail", - "GsaNamedEntityQualitySystemErrorDetail", - "GsaNamedEntityRecordLinkGroupErrorDetail", - "GsaNamedEntityTableErrorDetail", - "GsaNamedEntityUnitErrorDetail", "GsaNewLayoutAssociationChainItem", "GsaNewLayoutAssociationChainLink", "GsaNewLayoutAttributeItem", @@ -2653,54 +1656,23 @@ "GsaNewLayoutItemType", "GsaNewLayoutRecordLinkItem", "GsaNewLayoutSmartLinkItem", - "GsaNoAttributePairsSmartAttributesErrorDetail", - "GsaNoDataFileErrorDetail", "GsaNoExpressionsMathsFunctionalErrorDetail", - "GsaNoFileFileErrorDetail", - "GsaNoParameterValuesParameterErrorDetail", - "GsaNoPermissionsPermissionCategoryErrorDetail", - "GsaNoQualityDiscreteValuesErrorDetail", - "GsaNoSuchAttributeSmartAttributesErrorDetail", - "GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "GsaNoSuchCategoryAccessControlErrorDetail", - "GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail", - "GsaNoSuchEntitiesAccessControlEntitiesErrorDetail", - "GsaNoSuchEntityAccessControlCategoryErrorDetail", "GsaNoSuchEntityAttributeErrorDetail", "GsaNoSuchEntityTabularColumnErrorDetail", "GsaNoSuchExpressionsMathsFunctionalErrorDetail", - "GsaNoSuchNewParentFileMoveErrorDetail", - "GsaNoSuchNewParentFolderMoveErrorDetail", "GsaNoSuchParameterValueParameterContentErrorDetail", - "GsaNoSuchPermissionAccessControlErrorDetail", - "GsaNoSuchPermissionsPermissionCategoryErrorDetail", - "GsaNoSuchSubsetAccessControlEntitiesErrorDetail", - "GsaNoSuchTableMappingErrorDetail", - "GsaNoSuchTablesReorderTablesErrorDetail", - "GsaNoSuchTabularColumnAttributeErrorDetail", - "GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "GsaNoSuchUnitConstantErrorDetail", - "GsaNoSuchUnitParameterErrorDetail", - "GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "GsaNoSuchUnitUnitEquivalentErrorDetail", "GsaNoValueExistsGraphValue", "GsaNoValuesSpecifier", - "GsaNonCustomStandardNameCannotBeChangedErrorDetail", "GsaNotApplicableDatum", "GsaNotTheLatestVersionErrorDetail", "GsaNotVersionedErrorDetail", - "GsaNumberParsingUnitEquationErrorDetail", "GsaNumericGraphParameterValue", "GsaNumericParameter", "GsaNumericParameterConstraint", "GsaNumericParameterContent", "GsaNumericParameterDataValue", "GsaNumericParameterValue", - "GsaNumericRestrictedInterpolationParameterErrorDetail", "GsaObjectIdentifier", - "GsaPaginatedItemType", - "GsaPaginatedResponseOf", - "GsaPaginationLinks", "GsaPagingOptions", "GsaParameter", "GsaParameterConstraint", @@ -2712,11 +1684,8 @@ "GsaParameterContentMathsFunctionalErrorDetail", "GsaParameterContentMissingArgument", "GsaParameterContentUnknownParametersMathsFunctionalErrorDetail", - "GsaParameterCreationException", "GsaParameterDataValue", "GsaParameterDeletionException", - "GsaParameterErrorDetail", - "GsaParameterErrorReason", "GsaParameterInfo", "GsaParameterInfoInterpolationType", "GsaParameterInfoParameterType", @@ -2726,56 +1695,14 @@ "GsaParameterSettingDefinedAt", "GsaParameterType", "GsaParameterTypeParameterContentErrorDetail", - "GsaParameterTypeParameterErrorDetail", - "GsaParameterUpdateException", - "GsaParameterUsageDataModificationErrorDetail", "GsaParameterValue", - "GsaParameterValueCreationException", "GsaParameterValueDeletionException", - "GsaParameterValueErrorDetail", - "GsaParameterValueErrorReason", - "GsaParameterValueParameterErrorDetail", "GsaParameterValueType", - "GsaParameterValueTypeParameterValueErrorDetail", - "GsaParameterValueUpdateException", - "GsaParameterValueUsedByType", "GsaParameterWithDataValue", "GsaParametersInfo", "GsaPermission", - "GsaPermissionAccessControl", - "GsaPermissionAccessControlAggregate", - "GsaPermissionBasedAccessControlAggregationErrorDetail", - "GsaPermissionBasedAccessControlAggregationErrorReason", - "GsaPermissionBasedAccessControlAggregationException", - "GsaPermissionBasedAccessControlEntitiesErrorReason", - "GsaPermissionBasedAccessControlInfo", - "GsaPermissionBasedAccessControlUpdateOperationException", - "GsaPermissionBasedAccessControlUpdateOperationsErrorDetail", - "GsaPermissionBasedAccessControlUpdateOperationsErrorReason", - "GsaPermissionCategoriesAccessControlErrorDetail", - "GsaPermissionCategoriesAccessControlErrorReason", - "GsaPermissionCategoriesAccessControlUpdateException", "GsaPermissionCategoriesInfo", - "GsaPermissionCategoriesUpdateOperationsErrorDetail", "GsaPermissionCategory", - "GsaPermissionCategoryAccessControl", - "GsaPermissionCategoryAccessControlAggregate", - "GsaPermissionCategoryAccessControlAggregateInfo", - "GsaPermissionCategoryAccessControlInfo", - "GsaPermissionCategoryCreationException", - "GsaPermissionCategoryErrorDetail", - "GsaPermissionCategoryErrorReason", - "GsaPermissionCategoryReplaceException", - "GsaPermissionCategoryUpdateException", - "GsaPermissionCreationException", - "GsaPermissionDeletionErrorDetail", - "GsaPermissionDeletionErrorReason", - "GsaPermissionDeletionException", - "GsaPermissionErrorDetail", - "GsaPermissionErrorReason", - "GsaPermissionPermissionCategoryErrorDetail", - "GsaPermissionUpdateException", - "GsaPermissionsInUseInfo", "GsaPermissionsInfo", "GsaPictureAttribute", "GsaPictureDatum", @@ -2784,7 +1711,6 @@ "GsaPointAggregation", "GsaPointAggregationDatumCriterion", "GsaPointAttribute", - "GsaPointChartData", "GsaPointDataValue", "GsaPointDatum", "GsaPointDatumCriterion", @@ -2798,23 +1724,6 @@ "GsaProfileTable", "GsaProfileTablesInfo", "GsaProperty", - "GsaPutDiscreteValue", - "GsaPutLayoutItem", - "GsaPutPermission", - "GsaPutPermissionCategory", - "GsaPutType", - "GsaQualityDiscreteValue", - "GsaQualityDiscreteValueErrorDetail", - "GsaQualityDiscreteValueErrorReason", - "GsaQualityDiscreteValuesErrorDetail", - "GsaQualitySystem", - "GsaQualitySystemCreationException", - "GsaQualitySystemDeletionException", - "GsaQualitySystemErrorDetail", - "GsaQualitySystemErrorReason", - "GsaQualitySystemGuidErrorDetail", - "GsaQualitySystemType", - "GsaQualitySystemsInfo", "GsaQueryAttribute", "GsaQueryAttributeFilter", "GsaQueryAttributeInfo", @@ -2831,25 +1740,9 @@ "GsaQueryDiscreteTypeProperties", "GsaQueryDiscreteTypesInfo", "GsaQueryDiscreteTypesRequest", - "GsaQueryLayout", - "GsaQueryLayoutFilter", - "GsaQueryLayoutItem", - "GsaQueryLayoutItemFilter", - "GsaQueryLayoutItemProperties", - "GsaQueryLayoutProperties", - "GsaQueryLayoutSection", - "GsaQueryLayoutSectionFilter", - "GsaQueryLayoutSectionProperties", - "GsaQueryLayoutSectionsInfo", - "GsaQueryLayoutSectionsRequest", - "GsaQueryLayoutsInfo", - "GsaQueryLayoutsRequest", "GsaQuerySlimDiscreteType", "GsaQuerySlimDiscreteTypeProperties", - "GsaQuerySlimEntity", - "GsaQuerySlimEntityProperties", "GsaQuerySlimNamedEntity", - "GsaQuerySlimNamedEntityFilter", "GsaQuerySlimNamedEntityProperties", "GsaQuerySlimTypedAttribute", "GsaQuerySlimTypedAttributeProperties", @@ -2860,48 +1753,33 @@ "GsaQueryTablesRequest", "GsaQueryTabularAttributeTarget", "GsaQueryTabularAttributeTargetProperties", - "GsaQueryTabularColumn", - "GsaQueryTabularColumnProperties", "GsaQueryUnit", "GsaQueryUnitProperties", "GsaRangeAggregation", "GsaRangeAggregationDatumCriterion", "GsaRangeAttribute", - "GsaRangeChartData", "GsaRangeDatum", "GsaRangeDatumCriterion", "GsaRangeDatumExistsCriterion", - "GsaRangeEndpoint", "GsaRangeFixedWidthHistogramAggregationDatumCriterion", "GsaRangeGraphValue", "GsaRangeHistogramAggregation", "GsaRangeHistogramAggregationDatumCriterion", "GsaRecordAncestorCriterion", "GsaRecordAncestorHistoryCriterion", - "GsaRecordAndAttributeSelectionType", + "GsaRecordCapabilities", "GsaRecordColor", "GsaRecordColorProperty", "GsaRecordExportFailure", "GsaRecordGuidProperty", "GsaRecordHistory", "GsaRecordHistoryCopyException", - "GsaRecordHistoryDescendantsAccessControlEntity", - "GsaRecordHistoryErrorReason", "GsaRecordHistoryGuidProperty", "GsaRecordHistoryMoveException", "GsaRecordHistoryReference", - "GsaRecordLink", - "GsaRecordLinkBase", - "GsaRecordLinkCreatePutLayoutItem", "GsaRecordLinkGroup", - "GsaRecordLinkGroupCreationException", - "GsaRecordLinkGroupErrorDetail", - "GsaRecordLinkGroupErrorReason", "GsaRecordLinkGroupType", - "GsaRecordLinkGroupUpdateException", "GsaRecordLinkGroupsInfo", - "GsaRecordLinkResult", - "GsaRecordLinkResults", "GsaRecordListHeader", "GsaRecordListHeadersInfo", "GsaRecordListItemsInfo", @@ -2921,82 +1799,45 @@ "GsaRecordReferenceType", "GsaRecordSubsetCriterion", "GsaRecordType", - "GsaRecordTypeCriterion", "GsaRecordTypeProperty", - "GsaRecordUserCapabilities", "GsaRecordVersion", - "GsaRecordVersionAccessControlEntity", "GsaRecordVersionReference", "GsaRecordWithData", "GsaReferencedByType", "GsaReferentialIntegrityModel", - "GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "GsaRegisterUpdateRequest", "GsaReleaseRecordVersionControlException", "GsaReleaseTableVersionControlException", "GsaReleasedDateProperty", "GsaRelevanceSortCriterion", "GsaRemoveRecordHistoryFromSubset", "GsaReorderSectionsInfo", - "GsaReorderTablesErrorDetail", - "GsaReorderTablesErrorReason", - "GsaReorderTablesException", - "GsaReorderTablesRequest", - "GsaReplaceDiscreteValuesException", - "GsaReplacePermissionCategoriesRequest", - "GsaReplacePermissionCategoryErrorDetail", - "GsaReplacePermissionCategoryErrorReason", "GsaReplacementString", "GsaReplacementStringsInfo", - "GsaResolveLinkTargetsInfo", - "GsaResolveLinkTargetsRequest", - "GsaResolvedBreadcrumb", + "GsaResolvedLink", + "GsaResolvedLinkInfo", "GsaResolvedLinkTarget", - "GsaResolvedTargetAttribute", "GsaResponseOptions", "GsaResubmitJobRequest", - "GsaRetargetPotentialRequest", - "GsaRetargetRequest", - "GsaRetargetResult", - "GsaRetargetResultType", - "GsaRetargetResultsInfo", - "GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", "GsaRichTextType", "GsaRichTextValue", - "GsaRoleNotProvidedPermissionErrorDetail", "GsaRollupExportFailure", "GsaRollupReference", - "GsaRootFolderMoveErrorDetail", - "GsaRootRecordNotAvailableToRenameErrorDetail", - "GsaRuleEngine", - "GsaSameParentFileMoveErrorDetail", - "GsaSameParentFolderMoveErrorDetail", - "GsaSchemaGenerationWarningReason", + "GsaSaveSearchRequest", "GsaSchemaTooNewAddDatabaseValidationIssue", "GsaSchemaTooOldAddDatabaseValidationIssue", "GsaSearchClusterStatus", + "GsaSearchDetail", "GsaSearchIndexStatus", - "GsaSearchMask", - "GsaSearchMaskInfo", "GsaSearchMaskUsageDataModificationErrorDetail", "GsaSearchRequest", "GsaSearchResponse", "GsaSearchResult", "GsaSearchResultsRequest", - "GsaSearchServiceStatus", - "GsaSearchTemplate", - "GsaSearchTemplateAttributeItem", - "GsaSearchTemplateInfo", - "GsaSearchTemplateItem", - "GsaSearchTemplateItemType", - "GsaSearchTemplateLinkItem", - "GsaSearchTemplateTabularColumnItem", "GsaSearchableRecordProperty", + "GsaSecurityAttributeGrouping", "GsaSecurityAttributeUsageDataModificationErrorDetail", "GsaSecurityGroups", - "GsaSelection", + "GsaSelectionSearch", "GsaSeriesGraph", "GsaSetDateTimeDatum", "GsaSetDatum", @@ -3016,9 +1857,6 @@ "GsaSetShortTextDatum", "GsaSetTabularDatum", "GsaSetTabularDatumRow", - "GsaSetUnitEquivalent", - "GsaSetUnitEquivalentsException", - "GsaSetUnitEquivalentsInfo", "GsaShortNameProperty", "GsaShortTextAggregation", "GsaShortTextAggregationDatumCriterion", @@ -3028,16 +1866,11 @@ "GsaShortTextDatumExistsCriterion", "GsaShortTextPrefixDatumCriterion", "GsaSignificantFiguresInfo", - "GsaSimilaritySetting", - "GsaSimilaritySettings", - "GsaSimilaritySortCriterion", "GsaSimpleAttributeToExport", - "GsaSlimAccessControlInfo", "GsaSlimAttribute", - "GsaSlimAttributeWithHelpPath", "GsaSlimConfiguration", + "GsaSlimConstant", "GsaSlimDatabase", - "GsaSlimDatabaseAccessControlInfo", "GsaSlimDiscreteType", "GsaSlimEntity", "GsaSlimExpression", @@ -3045,84 +1878,45 @@ "GsaSlimIdentifiedEntity", "GsaSlimLayout", "GsaSlimLayoutSection", - "GsaSlimLocalizedEntity", "GsaSlimNamedEntity", + "GsaSlimNamedUnit", "GsaSlimObjects", "GsaSlimParameter", - "GsaSlimParameterWithHelpPath", + "GsaSlimPermission", + "GsaSlimPermissionCategory", "GsaSlimProfile", "GsaSlimProfileTable", "GsaSlimRecordHistory", "GsaSlimRecordLinkGroup", "GsaSlimRecordVersion", "GsaSlimReplacementString", - "GsaSlimSearchMask", - "GsaSlimSearchTemplate", "GsaSlimSubset", "GsaSlimTable", "GsaSlimTypedAttribute", "GsaSlimUnit", - "GsaSmartAttributesErrorDetail", - "GsaSmartAttributesErrorReason", - "GsaSmartAttributesRecordLinkGroupErrorDetail", - "GsaSmartLink", - "GsaSmartLinkCreatePutLayoutItem", - "GsaSmartLinkGroupUsageDataModificationErrorDetail", - "GsaSmartRecordLinkGroup", - "GsaSmartRecordLinkResult", + "GsaSlimUnitSystem", + "GsaSmtpProperties", "GsaSortCriterion", "GsaSortCriterionType", "GsaSortDirection", "GsaSortType", "GsaSortingValue", "GsaSortingValueType", - "GsaSourceCannotBeTargetSmartAttributesErrorDetail", "GsaSourceOfObjectIdentifier", "GsaSpecificValuesSpecifier", - "GsaSqlCredentials", "GsaStandardName", - "GsaStandardNameAlreadyExistsErrorDetail", - "GsaStandardNameCreationException", - "GsaStandardNameDeletionErrorDetail", - "GsaStandardNameDeletionErrorReason", - "GsaStandardNameDeletionException", - "GsaStandardNameErrorDetail", - "GsaStandardNameErrorReason", - "GsaStandardNameUpdateException", "GsaStandardNamesInfo", - "GsaStaticRecordLink", "GsaStaticRecordLinkGroup", - "GsaStaticRecordLinkGroupMapping", - "GsaStaticRecordLinkResult", "GsaStringSortingValue", "GsaSubset", "GsaSubsetsInfo", - "GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail", - "GsaSymbolCannotContainCommaUnitErrorDetail", - "GsaTItem", "GsaTable", - "GsaTableAccessControlEntity", - "GsaTableCreationException", "GsaTableDeletionException", - "GsaTableDescendantsAccessControlEntity", - "GsaTableErrorDetail", - "GsaTableErrorReason", "GsaTableGuidProperty", "GsaTableIdentityProperty", "GsaTableNameProperty", - "GsaTableSearchBehaviour", - "GsaTableTypeContainsCommaErrorDetail", - "GsaTableTypeErrorDetail", - "GsaTableTypeErrorReason", - "GsaTableTypesErrorDetail", - "GsaTableTypesInfo", - "GsaTableUpdateException", - "GsaTableUsageDataModificationErrorDetail", - "GsaTableVersionStateAccessControlCategoryErrorDetail", "GsaTablesInfo", - "GsaTablesMissingReorderTablesErrorDetail", "GsaTabularAttribute", - "GsaTabularAttributeLink", "GsaTabularAttributeTarget", "GsaTabularAttributeUsageDataModificationErrorDetail", "GsaTabularAttributeWithColumns", @@ -3131,7 +1925,6 @@ "GsaTabularColumnNameNotProvidedErrorDetail", "GsaTabularColumnNoSuchEntityType", "GsaTabularColumnRollUpType", - "GsaTabularColumnUsageDataModificationErrorDetail", "GsaTabularDatum", "GsaTabularDatumCell", "GsaTabularDatumExistsCriterion", @@ -3140,75 +1933,36 @@ "GsaTabularDatumSummaryRow", "GsaTabularLinkingValueCriterion", "GsaTabularRowExportBehavior", - "GsaTargetAttribute", "GsaTargetAttributeNotInTableAttributeErrorDetail", - "GsaTargetAttributeType", "GsaTargetAttributeTypeAttributeErrorDetail", - "GsaTargetNotFullySpecifiedAttributeErrorDetail", "GsaTermWithCount", "GsaTextMatchBehavior", "GsaThresholdTypeAttributeErrorDetail", - "GsaThresholdValueNameEmptyErrorDetail", - "GsaThresholdValueNameInvalidErrorDetail", - "GsaTooLongCodeCurrencyErrorDetail", - "GsaTooManyAttributePairsSmartAttributesErrorDetail", - "GsaTooManyPermissionsPermissionCategoryErrorDetail", - "GsaTooManyPermissionsReplacePermissionCategoryErrorDetail", - "GsaTranslateBetweenGuidsAndIdentitiesResponse", "GsaTranslateGuidsToIdentitiesRequest", - "GsaTranslateIdentitiesToGuidsRequest", + "GsaTranslateGuidsToIdentitiesResponse", "GsaUnableToConnectAddDatabaseValidationIssue", "GsaUnavailableTabularColumn", "GsaUnit", - "GsaUnitAsExponentUnitEquationErrorDetail", "GsaUnitConversionSet", "GsaUnitConversionSetRequest", "GsaUnitConversionsInfo", - "GsaUnitCreationException", - "GsaUnitDeletionException", - "GsaUnitEquationErrorDetail", - "GsaUnitEquationErrorReason", "GsaUnitEquivalent", - "GsaUnitEquivalentErrorDetail", - "GsaUnitEquivalentErrorReason", "GsaUnitEquivalentsInfo", - "GsaUnitErrorDetail", - "GsaUnitErrorReason", "GsaUnitMapping", "GsaUnitSystem", "GsaUnitSystemsInfo", - "GsaUnitUpdateException", "GsaUnitUsage", - "GsaUnitUsageDataModificationErrorDetail", - "GsaUnitUsageType", - "GsaUnitsGroupingInfo", "GsaUnitsInfo", - "GsaUnknownUnitSymbolUnitEquationErrorDetail", - "GsaUnresolvedAttributeGuidsErrorDetail", - "GsaUnresolvedBreadcrumb", - "GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedParameterGuidsErrorDetail", - "GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedReverseRecordLinkGroupsErrorDetail", - "GsaUnresolvedTargetAttribute", - "GsaUpdateAccessControl", - "GsaUpdateAccessControlCategory", - "GsaUpdateAccessControlCategoryTableMapping", "GsaUpdateAllProfilesInfo", "GsaUpdateAttribute", - "GsaUpdateAttributeBasedAccessControl", "GsaUpdateAxisName", "GsaUpdateConfiguration", "GsaUpdateConstant", "GsaUpdateContinuousRange", "GsaUpdateCrossDatabaseRecordLinkGroup", - "GsaUpdateCurrentRuleEngine", "GsaUpdateDataRule", "GsaUpdateDatabase", - "GsaUpdateDatabaseSecurityGroups", "GsaUpdateDateTimeAttribute", - "GsaUpdateDefaultDatabase", - "GsaUpdateDefaultFallbackSecurityGroups", "GsaUpdateDefaultProfile", "GsaUpdateDiscreteAttribute", "GsaUpdateDiscreteFunctionalAttribute", @@ -3220,8 +1974,7 @@ "GsaUpdateDiscreteParameterValue", "GsaUpdateDiscreteRange", "GsaUpdateDiscreteType", - "GsaUpdateDisplayNames", - "GsaUpdateDisplayNamesResponse", + "GsaUpdateDynamicRecordLinkGroup", "GsaUpdateExpression", "GsaUpdateFile", "GsaUpdateFileAttribute", @@ -3234,7 +1987,6 @@ "GsaUpdateIntegerAttribute", "GsaUpdateJobRequest", "GsaUpdateLayout", - "GsaUpdateLayoutSection", "GsaUpdateLinkedAttributeTabularColumn", "GsaUpdateLinkedColumnTabularColumn", "GsaUpdateLinkedRecordTabularColumn", @@ -3259,74 +2011,46 @@ "GsaUpdateParameter", "GsaUpdateParameterContent", "GsaUpdateParameterValue", - "GsaUpdatePermission", - "GsaUpdatePermissionAccessControl", - "GsaUpdatePermissionBasedAccessControl", - "GsaUpdatePermissionCategory", - "GsaUpdatePermissionCategoryAccessControl", - "GsaUpdatePermissionCategoryAccessControlRequest", - "GsaUpdatePermissionCategoryAccessControlsOperationRequest", "GsaUpdatePictureAttribute", "GsaUpdatePointAttribute", "GsaUpdateProfile", "GsaUpdateProfileTable", - "GsaUpdatePutDiscreteValue", - "GsaUpdatePutLayoutItem", - "GsaUpdatePutPermission", - "GsaUpdatePutPermissionCategory", "GsaUpdateRangeAttribute", "GsaUpdateRecordLinkGroup", "GsaUpdateRecordListPermissionFlags", "GsaUpdateRecordListProperties", "GsaUpdateReplacementString", - "GsaUpdateRootFolderErrorDetail", - "GsaUpdateRunStatus", "GsaUpdateShortTextAttribute", - "GsaUpdateSmartRecordLinkGroup", "GsaUpdateStandardName", "GsaUpdateStaticRecordLinkGroup", - "GsaUpdateStaticRecordLinkGroupMapping", "GsaUpdateSubset", "GsaUpdateTable", "GsaUpdateTabularAttribute", "GsaUpdateTabularAttributeTarget", "GsaUpdateTabularColumn", - "GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail", - "GsaUpdateTabularColumnTypeAttributeErrorDetail", "GsaUpdateUnavailableTabularColumn", "GsaUpdateUnit", "GsaUpdateUnitSystem", "GsaUpdateUserPermission", "GsaUpdateUserPermissionsInfo", - "GsaUpgradeDatabaseException", - "GsaUpgradeDatabaseFailureReason", "GsaUsageDataModificationErrorDetail", - "GsaUserCapabilities", + "GsaUserOrGroup", "GsaUserPermission", "GsaUserPermissionsInfo", "GsaUserRole", "GsaValidateAttributeRequest", - "GsaValidateUnitEquationRequest", - "GsaValidateUnitEquationResponse", - "GsaValueNotProvidedParameterValueErrorDetail", "GsaValueSpecifier", "GsaValueSpecifierType", "GsaValueWithCountOfBoolean", "GsaValueWithCountOfGuid", "GsaValueWithCountOfInt32", "GsaVersionControlErrorDetail", - "GsaVersionControlErrorReason", - "GsaVersionControlMode", "GsaVersionControlledDataUsageDataModificationErrorDetail", "GsaVersionNumberProperty", "GsaVersionState", "GsaVersionStateProperty", - "GsaWeightingType", "GsaWithdrawRecordVersionControlException", - "GsaXYChartTemplate", "GsaXYChartTemplateUsageDataModificationErrorDetail", - "GsaXYChartTemplatesInfo", - "GsaXYTemplateAxis", "JobqueueFilesBody", "JsonPatchDocument", "MicrosoftAspNetCoreMvcFormattersIOutputFormatter", diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/granta_mi_search_free_text_identifiers.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/granta_mi_search_free_text_identifiers.py deleted file mode 100644 index 3c293edd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/granta_mi_search_free_text_identifiers.py +++ /dev/null @@ -1,171 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GrantaMISearchFreeTextIdentifiers(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guids": "list[str]", - "column_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "attribute_guids": "attributeGuids", - "column_guids": "columnGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guids: "list[str] | None | Unset_Type" = Unset, - column_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GrantaMISearchFreeTextIdentifiers - a model defined in Swagger - - Parameters - ---------- - attribute_guids: list[str] | None, optional - column_guids: list[str] | None, optional - """ - self._attribute_guids: list[str] | None | Unset_Type = Unset - self._column_guids: list[str] | None | Unset_Type = Unset - - if attribute_guids is not Unset: - self.attribute_guids = attribute_guids - if column_guids is not Unset: - self.column_guids = column_guids - - @property - def attribute_guids(self) -> "list[str] | None | Unset_Type": - """Gets the attribute_guids of this GrantaMISearchFreeTextIdentifiers. - - Returns - ------- - list[str] | None | Unset_Type - The attribute_guids of this GrantaMISearchFreeTextIdentifiers. - """ - return self._attribute_guids - - @attribute_guids.setter - def attribute_guids(self, attribute_guids: "list[str] | None | Unset_Type") -> None: - """Sets the attribute_guids of this GrantaMISearchFreeTextIdentifiers. - - Parameters - ---------- - attribute_guids: list[str] | None | Unset_Type - The attribute_guids of this GrantaMISearchFreeTextIdentifiers. - """ - self._attribute_guids = attribute_guids - - @property - def column_guids(self) -> "list[str] | None | Unset_Type": - """Gets the column_guids of this GrantaMISearchFreeTextIdentifiers. - - Returns - ------- - list[str] | None | Unset_Type - The column_guids of this GrantaMISearchFreeTextIdentifiers. - """ - return self._column_guids - - @column_guids.setter - def column_guids(self, column_guids: "list[str] | None | Unset_Type") -> None: - """Sets the column_guids of this GrantaMISearchFreeTextIdentifiers. - - Parameters - ---------- - column_guids: list[str] | None | Unset_Type - The column_guids of this GrantaMISearchFreeTextIdentifiers. - """ - self._column_guids = column_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GrantaMISearchFreeTextIdentifiers): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_categories_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_categories_info.py deleted file mode 100644 index 59966f6f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_categories_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoriesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "categories": "list[GsaAccessControlCategory]", - } - - attribute_map: dict[str, str] = { - "categories": "categories", - } - - subtype_mapping: dict[str, str] = { - "categories": "GsaAccessControlCategory", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - categories: "list[GsaAccessControlCategory]", - ) -> None: - """GsaAccessControlCategoriesInfo - a model defined in Swagger - - Parameters - ---------- - categories: list[GsaAccessControlCategory] - """ - self._categories: list[GsaAccessControlCategory] - - self.categories = categories - - @property - def categories(self) -> "list[GsaAccessControlCategory]": - """Gets the categories of this GsaAccessControlCategoriesInfo. - - Returns - ------- - list[GsaAccessControlCategory] - The categories of this GsaAccessControlCategoriesInfo. - """ - return self._categories - - @categories.setter - def categories(self, categories: "list[GsaAccessControlCategory]") -> None: - """Sets the categories of this GsaAccessControlCategoriesInfo. - - Parameters - ---------- - categories: list[GsaAccessControlCategory] - The categories of this GsaAccessControlCategoriesInfo. - """ - # Field is not nullable - if categories is None: - raise ValueError("Invalid value for 'categories', must not be 'None'") - # Field is required - if categories is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'categories', must not be 'Unset'") - self._categories = categories - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoriesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category.py deleted file mode 100644 index cb3b2f87..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category.py +++ /dev/null @@ -1,251 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type": "GsaSlimEntity", - "guid": "str", - "name": "str", - "table_mappings": "list[GsaAccessControlCategoryTableMapping]", - } - - attribute_map: dict[str, str] = { - "discrete_type": "discreteType", - "guid": "guid", - "name": "name", - "table_mappings": "tableMappings", - } - - subtype_mapping: dict[str, str] = { - "discreteType": "GsaSlimEntity", - "tableMappings": "GsaAccessControlCategoryTableMapping", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type: "GsaSlimEntity", - guid: "str", - name: "str", - table_mappings: "list[GsaAccessControlCategoryTableMapping] | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategory - a model defined in Swagger - - Parameters - ---------- - discrete_type: GsaSlimEntity - guid: str - name: str - table_mappings: list[GsaAccessControlCategoryTableMapping] | None, optional - """ - self._discrete_type: GsaSlimEntity - self._table_mappings: list[GsaAccessControlCategoryTableMapping] | None | Unset_Type = Unset - self._name: str - self._guid: str - - self.discrete_type = discrete_type - if table_mappings is not Unset: - self.table_mappings = table_mappings - self.name = name - self.guid = guid - - @property - def discrete_type(self) -> "GsaSlimEntity": - """Gets the discrete_type of this GsaAccessControlCategory. - - Returns - ------- - GsaSlimEntity - The discrete_type of this GsaAccessControlCategory. - """ - return self._discrete_type - - @discrete_type.setter - def discrete_type(self, discrete_type: "GsaSlimEntity") -> None: - """Sets the discrete_type of this GsaAccessControlCategory. - - Parameters - ---------- - discrete_type: GsaSlimEntity - The discrete_type of this GsaAccessControlCategory. - """ - # Field is not nullable - if discrete_type is None: - raise ValueError("Invalid value for 'discrete_type', must not be 'None'") - # Field is required - if discrete_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type', must not be 'Unset'") - self._discrete_type = discrete_type - - @property - def table_mappings(self) -> "list[GsaAccessControlCategoryTableMapping] | None | Unset_Type": - """Gets the table_mappings of this GsaAccessControlCategory. - Optionally maps an attribute, and values applied to the table, for each table. There can be at most one entry for each table. - - Returns - ------- - list[GsaAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaAccessControlCategory. - """ - return self._table_mappings - - @table_mappings.setter - def table_mappings( - self, table_mappings: "list[GsaAccessControlCategoryTableMapping] | None | Unset_Type" - ) -> None: - """Sets the table_mappings of this GsaAccessControlCategory. - Optionally maps an attribute, and values applied to the table, for each table. There can be at most one entry for each table. - - Parameters - ---------- - table_mappings: list[GsaAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaAccessControlCategory. - """ - self._table_mappings = table_mappings - - @property - def name(self) -> "str": - """Gets the name of this GsaAccessControlCategory. - - Returns - ------- - str - The name of this GsaAccessControlCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaAccessControlCategory. - - Parameters - ---------- - name: str - The name of this GsaAccessControlCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaAccessControlCategory. - - Returns - ------- - str - The guid of this GsaAccessControlCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaAccessControlCategory. - - Parameters - ---------- - guid: str - The guid of this GsaAccessControlCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_creation_exception.py deleted file mode 100644 index 612d68ec..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_creation_exception.py +++ /dev/null @@ -1,242 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaAccessControlCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaAccessControlCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategoryCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaAccessControlCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaAccessControlCategoryCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaAccessControlCategoryCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaAccessControlCategoryCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaAccessControlCategoryCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaAccessControlCategoryCreationException. - - Returns - ------- - str - The name of this GsaAccessControlCategoryCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - name: str - The name of this GsaAccessControlCategoryCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaAccessControlCategoryCreationException. - - Returns - ------- - list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryCreationException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_detail.py deleted file mode 100644 index 88aff66c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_detail.py +++ /dev/null @@ -1,203 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaAccessControlCategoryErrorReason", - } - - discriminator_value_class_map = { - "noSuchEntity".lower(): "#/components/schemas/GsaNoSuchEntityAccessControlCategoryErrorDetail", - "discreteValueNotInDiscreteType".lower(): "#/components/schemas/GsaDiscreteValueNotInDiscreteTypeErrorDetail", - "attributeNotOnTable".lower(): "#/components/schemas/GsaAttributeNotOnTableErrorDetail", - "attributeDiscreteTypeMismatch".lower(): "#/components/schemas/GsaAttributeDiscreteTypeMismatchErrorDetail", - "multipleDefaultValuesInSingleValuedDiscrete".lower(): "#/components/schemas/GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityAccessControlCategoryErrorDetail", - "duplicateTable".lower(): "#/components/schemas/GsaDuplicateTableErrorDetail", - "duplicateDiscreteValue".lower(): "#/components/schemas/GsaDuplicateDiscreteValueErrorDetail", - "noSuchTableMapping".lower(): "#/components/schemas/GsaNoSuchTableMappingErrorDetail", - "tableVersionState".lower(): "#/components/schemas/GsaTableVersionStateAccessControlCategoryErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason", - ) -> None: - """GsaAccessControlCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - """ - self._message: str - self._reason: GsaAccessControlCategoryErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaAccessControlCategoryErrorDetail. - - Returns - ------- - str - The message of this GsaAccessControlCategoryErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaAccessControlCategoryErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaAccessControlCategoryErrorReason": - """Gets the reason of this GsaAccessControlCategoryErrorDetail. - - Returns - ------- - GsaAccessControlCategoryErrorReason - The reason of this GsaAccessControlCategoryErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaAccessControlCategoryErrorReason") -> None: - """Sets the reason of this GsaAccessControlCategoryErrorDetail. - - Parameters - ---------- - reason: GsaAccessControlCategoryErrorReason - The reason of this GsaAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_reason.py deleted file mode 100644 index 232d2cf6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_error_reason.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlCategoryErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOSUCHENTITY = "noSuchEntity" - DISCRETEVALUENOTINDISCRETETYPE = "discreteValueNotInDiscreteType" - ATTRIBUTENOTONTABLE = "attributeNotOnTable" - ATTRIBUTEDISCRETETYPEMISMATCH = "attributeDiscreteTypeMismatch" - MULTIPLEDEFAULTVALUESINSINGLEVALUEDDISCRETE = "multipleDefaultValuesInSingleValuedDiscrete" - NAMEDENTITY = "namedEntity" - DUPLICATETABLE = "duplicateTable" - DUPLICATEDISCRETEVALUE = "duplicateDiscreteValue" - NOSUCHTABLEMAPPING = "noSuchTableMapping" - TABLEVERSIONSTATE = "tableVersionState" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_include.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_include.py deleted file mode 100644 index f7e981ba..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_include.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlCategoryInclude(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - TABLEMAPPINGS = "tableMappings" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_no_such_entity_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_no_such_entity_type.py deleted file mode 100644 index 80b0b779..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_no_such_entity_type.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlCategoryNoSuchEntityType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - TABLE = "table" - ATTRIBUTE = "attribute" - DISCRETETYPE = "discreteType" - DISCRETEVALUE = "discreteValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_table_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_table_mapping.py deleted file mode 100644 index 6e5c47c3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_table_mapping.py +++ /dev/null @@ -1,218 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryTableMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "table": "GsaSlimEntity", - "table_discrete_values": "list[GsaSlimEntity]", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "table": "table", - "table_discrete_values": "tableDiscreteValues", - } - - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "tableDiscreteValues": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - table: "GsaSlimEntity", - table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategoryTableMapping - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - table: GsaSlimEntity - table_discrete_values: list[GsaSlimEntity] | None, optional - """ - self._table: GsaSlimEntity - self._attribute: GsaSlimEntity - self._table_discrete_values: list[GsaSlimEntity] | None | Unset_Type = Unset - - self.table = table - self.attribute = attribute - if table_discrete_values is not Unset: - self.table_discrete_values = table_discrete_values - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The table of this GsaAccessControlCategoryTableMapping. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaAccessControlCategoryTableMapping. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaAccessControlCategoryTableMapping. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaAccessControlCategoryTableMapping. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaAccessControlCategoryTableMapping. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaAccessControlCategoryTableMapping. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @property - def table_discrete_values(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the table_discrete_values of this GsaAccessControlCategoryTableMapping. - The values applied to the table for this category. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaAccessControlCategoryTableMapping. - """ - return self._table_discrete_values - - @table_discrete_values.setter - def table_discrete_values( - self, table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the table_discrete_values of this GsaAccessControlCategoryTableMapping. - The values applied to the table for this category. - - Parameters - ---------- - table_discrete_values: list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaAccessControlCategoryTableMapping. - """ - self._table_discrete_values = table_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryTableMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_update_exception.py deleted file mode 100644 index 302ac578..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_category_update_exception.py +++ /dev/null @@ -1,242 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaAccessControlCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaAccessControlCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategoryUpdateException - a model defined in Swagger - - Parameters - ---------- - category_guid: str - code: GsaErrorCode, optional - errors: list[GsaAccessControlCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._category_guid: str - self._errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.category_guid = category_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaAccessControlCategoryUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaAccessControlCategoryUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - str - The category_guid of this GsaAccessControlCategoryUpdateException. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaAccessControlCategoryUpdateException. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @property - def errors(self) -> "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryUpdateException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_database_user_capabilities.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_database_user_capabilities.py deleted file mode 100644 index d7a4064f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_database_user_capabilities.py +++ /dev/null @@ -1,225 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlDatabaseUserCapabilities(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_based_categories": "GsaUserCapabilities", - "permission_based_access_control": "GsaUserCapabilities", - "permission_categories": "GsaUserCapabilities", - } - - attribute_map: dict[str, str] = { - "attribute_based_categories": "attributeBasedCategories", - "permission_based_access_control": "permissionBasedAccessControl", - "permission_categories": "permissionCategories", - } - - subtype_mapping: dict[str, str] = { - "attributeBasedCategories": "GsaUserCapabilities", - "permissionCategories": "GsaUserCapabilities", - "permissionBasedAccessControl": "GsaUserCapabilities", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_based_categories: "GsaUserCapabilities", - permission_based_access_control: "GsaUserCapabilities", - permission_categories: "GsaUserCapabilities", - ) -> None: - """GsaAccessControlDatabaseUserCapabilities - a model defined in Swagger - - Parameters - ---------- - attribute_based_categories: GsaUserCapabilities - permission_based_access_control: GsaUserCapabilities - permission_categories: GsaUserCapabilities - """ - self._attribute_based_categories: GsaUserCapabilities - self._permission_categories: GsaUserCapabilities - self._permission_based_access_control: GsaUserCapabilities - - self.attribute_based_categories = attribute_based_categories - self.permission_categories = permission_categories - self.permission_based_access_control = permission_based_access_control - - @property - def attribute_based_categories(self) -> "GsaUserCapabilities": - """Gets the attribute_based_categories of this GsaAccessControlDatabaseUserCapabilities. - - Returns - ------- - GsaUserCapabilities - The attribute_based_categories of this GsaAccessControlDatabaseUserCapabilities. - """ - return self._attribute_based_categories - - @attribute_based_categories.setter - def attribute_based_categories(self, attribute_based_categories: "GsaUserCapabilities") -> None: - """Sets the attribute_based_categories of this GsaAccessControlDatabaseUserCapabilities. - - Parameters - ---------- - attribute_based_categories: GsaUserCapabilities - The attribute_based_categories of this GsaAccessControlDatabaseUserCapabilities. - """ - # Field is not nullable - if attribute_based_categories is None: - raise ValueError("Invalid value for 'attribute_based_categories', must not be 'None'") - # Field is required - if attribute_based_categories is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_based_categories', must not be 'Unset'") - self._attribute_based_categories = attribute_based_categories - - @property - def permission_categories(self) -> "GsaUserCapabilities": - """Gets the permission_categories of this GsaAccessControlDatabaseUserCapabilities. - - Returns - ------- - GsaUserCapabilities - The permission_categories of this GsaAccessControlDatabaseUserCapabilities. - """ - return self._permission_categories - - @permission_categories.setter - def permission_categories(self, permission_categories: "GsaUserCapabilities") -> None: - """Sets the permission_categories of this GsaAccessControlDatabaseUserCapabilities. - - Parameters - ---------- - permission_categories: GsaUserCapabilities - The permission_categories of this GsaAccessControlDatabaseUserCapabilities. - """ - # Field is not nullable - if permission_categories is None: - raise ValueError("Invalid value for 'permission_categories', must not be 'None'") - # Field is required - if permission_categories is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_categories', must not be 'Unset'") - self._permission_categories = permission_categories - - @property - def permission_based_access_control(self) -> "GsaUserCapabilities": - """Gets the permission_based_access_control of this GsaAccessControlDatabaseUserCapabilities. - - Returns - ------- - GsaUserCapabilities - The permission_based_access_control of this GsaAccessControlDatabaseUserCapabilities. - """ - return self._permission_based_access_control - - @permission_based_access_control.setter - def permission_based_access_control( - self, permission_based_access_control: "GsaUserCapabilities" - ) -> None: - """Sets the permission_based_access_control of this GsaAccessControlDatabaseUserCapabilities. - - Parameters - ---------- - permission_based_access_control: GsaUserCapabilities - The permission_based_access_control of this GsaAccessControlDatabaseUserCapabilities. - """ - # Field is not nullable - if permission_based_access_control is None: - raise ValueError( - "Invalid value for 'permission_based_access_control', must not be 'None'" - ) - # Field is required - if permission_based_access_control is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'permission_based_access_control', must not be 'Unset'" - ) - self._permission_based_access_control = permission_based_access_control - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlDatabaseUserCapabilities): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_aggregation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_aggregation_error_detail.py deleted file mode 100644 index 3b054b74..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_aggregation_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_aggregation_error_detail import ( # noqa: F401 - GsaPermissionBasedAccessControlAggregationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_aggregation_error_reason import ( - GsaPermissionBasedAccessControlAggregationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlEntitiesAggregationErrorDetail( - GsaPermissionBasedAccessControlAggregationErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaAccessControlEntitiesErrorDetail]", - "message": "str", - "reason": "GsaPermissionBasedAccessControlAggregationErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaAccessControlEntitiesErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaAccessControlEntitiesErrorDetail]", - message: "str", - reason: "GsaPermissionBasedAccessControlAggregationErrorReason" = GsaPermissionBasedAccessControlAggregationErrorReason.ACCESSCONTROLENTITIES, - ) -> None: - """GsaAccessControlEntitiesAggregationErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaAccessControlEntitiesErrorDetail] - message: str - reason: GsaPermissionBasedAccessControlAggregationErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaAccessControlEntitiesErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaAccessControlEntitiesErrorDetail]": - """Gets the errors of this GsaAccessControlEntitiesAggregationErrorDetail. - - Returns - ------- - list[GsaAccessControlEntitiesErrorDetail] - The errors of this GsaAccessControlEntitiesAggregationErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaAccessControlEntitiesErrorDetail]") -> None: - """Sets the errors of this GsaAccessControlEntitiesAggregationErrorDetail. - - Parameters - ---------- - errors: list[GsaAccessControlEntitiesErrorDetail] - The errors of this GsaAccessControlEntitiesAggregationErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlEntitiesAggregationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_error_detail.py deleted file mode 100644 index d35e9050..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlEntitiesErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionBasedAccessControlEntitiesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionBasedAccessControlEntitiesErrorReason", - } - - discriminator_value_class_map = { - "noSuchEntities".lower(): "#/components/schemas/GsaNoSuchEntitiesAccessControlEntitiesErrorDetail", - "noSuchSubset".lower(): "#/components/schemas/GsaNoSuchSubsetAccessControlEntitiesErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionBasedAccessControlEntitiesErrorReason", - ) -> None: - """GsaAccessControlEntitiesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionBasedAccessControlEntitiesErrorReason - """ - self._message: str - self._reason: GsaPermissionBasedAccessControlEntitiesErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaAccessControlEntitiesErrorDetail. - - Returns - ------- - str - The message of this GsaAccessControlEntitiesErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaAccessControlEntitiesErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaAccessControlEntitiesErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionBasedAccessControlEntitiesErrorReason": - """Gets the reason of this GsaAccessControlEntitiesErrorDetail. - - Returns - ------- - GsaPermissionBasedAccessControlEntitiesErrorReason - The reason of this GsaAccessControlEntitiesErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionBasedAccessControlEntitiesErrorReason") -> None: - """Sets the reason of this GsaAccessControlEntitiesErrorDetail. - - Parameters - ---------- - reason: GsaPermissionBasedAccessControlEntitiesErrorReason - The reason of this GsaAccessControlEntitiesErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlEntitiesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_update_operations_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_update_operations_error_detail.py deleted file mode 100644 index 5750ee58..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entities_update_operations_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_update_operations_error_detail import ( # noqa: F401 - GsaPermissionBasedAccessControlUpdateOperationsErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_update_operations_error_reason import ( - GsaPermissionBasedAccessControlUpdateOperationsErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlEntitiesUpdateOperationsErrorDetail( - GsaPermissionBasedAccessControlUpdateOperationsErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaAccessControlEntitiesErrorDetail]", - "message": "str", - "reason": "GsaPermissionBasedAccessControlUpdateOperationsErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaAccessControlEntitiesErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaAccessControlEntitiesErrorDetail]", - message: "str", - reason: "GsaPermissionBasedAccessControlUpdateOperationsErrorReason" = GsaPermissionBasedAccessControlUpdateOperationsErrorReason.ACCESSCONTROLENTITIES, - ) -> None: - """GsaAccessControlEntitiesUpdateOperationsErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaAccessControlEntitiesErrorDetail] - message: str - reason: GsaPermissionBasedAccessControlUpdateOperationsErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaAccessControlEntitiesErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaAccessControlEntitiesErrorDetail]": - """Gets the errors of this GsaAccessControlEntitiesUpdateOperationsErrorDetail. - - Returns - ------- - list[GsaAccessControlEntitiesErrorDetail] - The errors of this GsaAccessControlEntitiesUpdateOperationsErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaAccessControlEntitiesErrorDetail]") -> None: - """Sets the errors of this GsaAccessControlEntitiesUpdateOperationsErrorDetail. - - Parameters - ---------- - errors: list[GsaAccessControlEntitiesErrorDetail] - The errors of this GsaAccessControlEntitiesUpdateOperationsErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlEntitiesUpdateOperationsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity.py deleted file mode 100644 index 22dfe147..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity.py +++ /dev/null @@ -1,166 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlEntity(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlEntityType", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - } - - subtype_mapping: dict[str, str] = { - "entityType": "GsaAccessControlEntityType", - } - - discriminator_value_class_map = { - "recordVersion".lower(): "#/components/schemas/GsaRecordVersionAccessControlEntity", - "attribute".lower(): "#/components/schemas/GsaAttributeAccessControlEntity", - "database".lower(): "#/components/schemas/GsaDatabaseAccessControlEntity", - "table".lower(): "#/components/schemas/GsaTableAccessControlEntity", - "expression".lower(): "#/components/schemas/GsaExpressionAccessControlEntity", - "tableDescendants".lower(): "#/components/schemas/GsaTableDescendantsAccessControlEntity", - "recordHistoryDescendants".lower(): "#/components/schemas/GsaRecordHistoryDescendantsAccessControlEntity", - } - - discriminator: Optional[str] = "entityType" - - def __init__( - self, - *, - entity_type: "GsaAccessControlEntityType", - ) -> None: - """GsaAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - """ - self._entity_type: GsaAccessControlEntityType - - self.entity_type = entity_type - - @property - def entity_type(self) -> "GsaAccessControlEntityType": - """Gets the entity_type of this GsaAccessControlEntity. - - Returns - ------- - GsaAccessControlEntityType - The entity_type of this GsaAccessControlEntity. - """ - return self._entity_type - - @entity_type.setter - def entity_type(self, entity_type: "GsaAccessControlEntityType") -> None: - """Sets the entity_type of this GsaAccessControlEntity. - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - The entity_type of this GsaAccessControlEntity. - """ - # Field is not nullable - if entity_type is None: - raise ValueError("Invalid value for 'entity_type', must not be 'None'") - # Field is required - if entity_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entity_type', must not be 'Unset'") - self._entity_type = entity_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity_type.py deleted file mode 100644 index 133795f0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_entity_type.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlEntityType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - RECORDVERSION = "recordVersion" - ATTRIBUTE = "attribute" - DATABASE = "database" - TABLE = "table" - EXPRESSION = "expression" - TABLEDESCENDANTS = "tableDescendants" - RECORDHISTORYDESCENDANTS = "recordHistoryDescendants" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_info.py deleted file mode 100644 index 4c78e82b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_info.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - discriminator_value_class_map = { - "permissionBased".lower(): "#/components/schemas/GsaPermissionBasedAccessControlInfo", - "attributeBased".lower(): "#/components/schemas/GsaAttributeBasedAccessControlInfo", - } - - discriminator: Optional[str] = "mode" - - def __init__( - self, - *, - mode: "GsaAccessControlMode", - ) -> None: - """GsaAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - self._mode: GsaAccessControlMode - - self.mode = mode - - @property - def mode(self) -> "GsaAccessControlMode": - """Gets the mode of this GsaAccessControlInfo. - - Returns - ------- - GsaAccessControlMode - The mode of this GsaAccessControlInfo. - """ - return self._mode - - @mode.setter - def mode(self, mode: "GsaAccessControlMode") -> None: - """Sets the mode of this GsaAccessControlInfo. - - Parameters - ---------- - mode: GsaAccessControlMode - The mode of this GsaAccessControlInfo. - """ - # Field is not nullable - if mode is None: - raise ValueError("Invalid value for 'mode', must not be 'None'") - # Field is required - if mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'mode', must not be 'Unset'") - self._mode = mode - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_user_capabilities.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_user_capabilities.py deleted file mode 100644 index 49d168b3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_user_capabilities.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlUserCapabilities(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "current_mode": "GsaUserCapabilities", - "database_user_capabilities": "GsaAccessControlDatabaseUserCapabilities", - } - - attribute_map: dict[str, str] = { - "current_mode": "currentMode", - "database_user_capabilities": "databaseUserCapabilities", - } - - subtype_mapping: dict[str, str] = { - "currentMode": "GsaUserCapabilities", - "databaseUserCapabilities": "GsaAccessControlDatabaseUserCapabilities", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - current_mode: "GsaUserCapabilities", - database_user_capabilities: "GsaAccessControlDatabaseUserCapabilities", - ) -> None: - """GsaAccessControlUserCapabilities - a model defined in Swagger - - Parameters - ---------- - current_mode: GsaUserCapabilities - database_user_capabilities: GsaAccessControlDatabaseUserCapabilities - """ - self._current_mode: GsaUserCapabilities - self._database_user_capabilities: GsaAccessControlDatabaseUserCapabilities - - self.current_mode = current_mode - self.database_user_capabilities = database_user_capabilities - - @property - def current_mode(self) -> "GsaUserCapabilities": - """Gets the current_mode of this GsaAccessControlUserCapabilities. - - Returns - ------- - GsaUserCapabilities - The current_mode of this GsaAccessControlUserCapabilities. - """ - return self._current_mode - - @current_mode.setter - def current_mode(self, current_mode: "GsaUserCapabilities") -> None: - """Sets the current_mode of this GsaAccessControlUserCapabilities. - - Parameters - ---------- - current_mode: GsaUserCapabilities - The current_mode of this GsaAccessControlUserCapabilities. - """ - # Field is not nullable - if current_mode is None: - raise ValueError("Invalid value for 'current_mode', must not be 'None'") - # Field is required - if current_mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'current_mode', must not be 'Unset'") - self._current_mode = current_mode - - @property - def database_user_capabilities(self) -> "GsaAccessControlDatabaseUserCapabilities": - """Gets the database_user_capabilities of this GsaAccessControlUserCapabilities. - - Returns - ------- - GsaAccessControlDatabaseUserCapabilities - The database_user_capabilities of this GsaAccessControlUserCapabilities. - """ - return self._database_user_capabilities - - @database_user_capabilities.setter - def database_user_capabilities( - self, database_user_capabilities: "GsaAccessControlDatabaseUserCapabilities" - ) -> None: - """Sets the database_user_capabilities of this GsaAccessControlUserCapabilities. - - Parameters - ---------- - database_user_capabilities: GsaAccessControlDatabaseUserCapabilities - The database_user_capabilities of this GsaAccessControlUserCapabilities. - """ - # Field is not nullable - if database_user_capabilities is None: - raise ValueError("Invalid value for 'database_user_capabilities', must not be 'None'") - # Field is required - if database_user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_user_capabilities', must not be 'Unset'") - self._database_user_capabilities = database_user_capabilities - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlUserCapabilities): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_name_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_name_filter.py deleted file mode 100644 index 16f4775a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_name_filter.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogApplicationNameFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "application_name_to_match": "str", - "match_type": "GsaActivityLogMatchType", - } - - attribute_map: dict[str, str] = { - "application_name_to_match": "applicationNameToMatch", - "match_type": "matchType", - } - - subtype_mapping: dict[str, str] = { - "matchType": "GsaActivityLogMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - application_name_to_match: "str", - match_type: "GsaActivityLogMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogApplicationNameFilter - a model defined in Swagger - - Parameters - ---------- - application_name_to_match: str - match_type: GsaActivityLogMatchType, optional - """ - self._application_name_to_match: str - self._match_type: GsaActivityLogMatchType | Unset_Type = Unset - - self.application_name_to_match = application_name_to_match - if match_type is not Unset: - self.match_type = match_type - - @property - def application_name_to_match(self) -> "str": - """Gets the application_name_to_match of this GsaActivityLogApplicationNameFilter. - - Returns - ------- - str - The application_name_to_match of this GsaActivityLogApplicationNameFilter. - """ - return self._application_name_to_match - - @application_name_to_match.setter - def application_name_to_match(self, application_name_to_match: "str") -> None: - """Sets the application_name_to_match of this GsaActivityLogApplicationNameFilter. - - Parameters - ---------- - application_name_to_match: str - The application_name_to_match of this GsaActivityLogApplicationNameFilter. - """ - # Field is not nullable - if application_name_to_match is None: - raise ValueError("Invalid value for 'application_name_to_match', must not be 'None'") - # Field is required - if application_name_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'application_name_to_match', must not be 'Unset'") - self._application_name_to_match = application_name_to_match - - @property - def match_type(self) -> "GsaActivityLogMatchType | Unset_Type": - """Gets the match_type of this GsaActivityLogApplicationNameFilter. - - Returns - ------- - GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogApplicationNameFilter. - """ - return self._match_type - - @match_type.setter - def match_type(self, match_type: "GsaActivityLogMatchType | Unset_Type") -> None: - """Sets the match_type of this GsaActivityLogApplicationNameFilter. - - Parameters - ---------- - match_type: GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogApplicationNameFilter. - """ - # Field is not nullable - if match_type is None: - raise ValueError("Invalid value for 'match_type', must not be 'None'") - self._match_type = match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogApplicationNameFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_names_collection_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_names_collection_filter.py deleted file mode 100644 index f7904d6e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_application_names_collection_filter.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogApplicationNamesCollectionFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "application_names_to_match": "list[str]", - "collection_match_type": "GsaActivityLogCollectionMatchType", - } - - attribute_map: dict[str, str] = { - "application_names_to_match": "applicationNamesToMatch", - "collection_match_type": "collectionMatchType", - } - - subtype_mapping: dict[str, str] = { - "collectionMatchType": "GsaActivityLogCollectionMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - application_names_to_match: "list[str]", - collection_match_type: "GsaActivityLogCollectionMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogApplicationNamesCollectionFilter - a model defined in Swagger - - Parameters - ---------- - application_names_to_match: list[str] - collection_match_type: GsaActivityLogCollectionMatchType, optional - """ - self._application_names_to_match: list[str] - self._collection_match_type: GsaActivityLogCollectionMatchType | Unset_Type = Unset - - self.application_names_to_match = application_names_to_match - if collection_match_type is not Unset: - self.collection_match_type = collection_match_type - - @property - def application_names_to_match(self) -> "list[str]": - """Gets the application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - - Returns - ------- - list[str] - The application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - """ - return self._application_names_to_match - - @application_names_to_match.setter - def application_names_to_match(self, application_names_to_match: "list[str]") -> None: - """Sets the application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - - Parameters - ---------- - application_names_to_match: list[str] - The application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - """ - # Field is not nullable - if application_names_to_match is None: - raise ValueError("Invalid value for 'application_names_to_match', must not be 'None'") - # Field is required - if application_names_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'application_names_to_match', must not be 'Unset'") - self._application_names_to_match = application_names_to_match - - @property - def collection_match_type(self) -> "GsaActivityLogCollectionMatchType | Unset_Type": - """Gets the collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - - Returns - ------- - GsaActivityLogCollectionMatchType | Unset_Type - The collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - """ - return self._collection_match_type - - @collection_match_type.setter - def collection_match_type( - self, collection_match_type: "GsaActivityLogCollectionMatchType | Unset_Type" - ) -> None: - """Sets the collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - - Parameters - ---------- - collection_match_type: GsaActivityLogCollectionMatchType | Unset_Type - The collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - """ - # Field is not nullable - if collection_match_type is None: - raise ValueError("Invalid value for 'collection_match_type', must not be 'None'") - self._collection_match_type = collection_match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogApplicationNamesCollectionFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_collection_match_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_collection_match_type.py deleted file mode 100644 index bd08738c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_collection_match_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaActivityLogCollectionMatchType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - COLLECTIONEXACTMATCH = "collectionExactMatch" - COLLECTIONCONTAINS = "collectionContains" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_database_key_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_database_key_filter.py deleted file mode 100644 index 256a5c54..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_database_key_filter.py +++ /dev/null @@ -1,178 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogDatabaseKeyFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key_to_match": "str", - "match_type": "GsaActivityLogMatchType", - } - - attribute_map: dict[str, str] = { - "database_key_to_match": "databaseKeyToMatch", - "match_type": "matchType", - } - - subtype_mapping: dict[str, str] = { - "matchType": "GsaActivityLogMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key_to_match: "str | None", - match_type: "GsaActivityLogMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogDatabaseKeyFilter - a model defined in Swagger - - Parameters - ---------- - database_key_to_match: str | None - match_type: GsaActivityLogMatchType, optional - """ - self._database_key_to_match: str | None - self._match_type: GsaActivityLogMatchType | Unset_Type = Unset - - self.database_key_to_match = database_key_to_match - if match_type is not Unset: - self.match_type = match_type - - @property - def database_key_to_match(self) -> "str | None": - """Gets the database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - - Returns - ------- - str | None - The database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - """ - return self._database_key_to_match - - @database_key_to_match.setter - def database_key_to_match(self, database_key_to_match: "str | None") -> None: - """Sets the database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - - Parameters - ---------- - database_key_to_match: str | None - The database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - """ - # Field is required - if database_key_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key_to_match', must not be 'Unset'") - self._database_key_to_match = database_key_to_match - - @property - def match_type(self) -> "GsaActivityLogMatchType | Unset_Type": - """Gets the match_type of this GsaActivityLogDatabaseKeyFilter. - - Returns - ------- - GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogDatabaseKeyFilter. - """ - return self._match_type - - @match_type.setter - def match_type(self, match_type: "GsaActivityLogMatchType | Unset_Type") -> None: - """Sets the match_type of this GsaActivityLogDatabaseKeyFilter. - - Parameters - ---------- - match_type: GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogDatabaseKeyFilter. - """ - # Field is not nullable - if match_type is None: - raise ValueError("Invalid value for 'match_type', must not be 'None'") - self._match_type = match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogDatabaseKeyFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_date_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_date_filter.py deleted file mode 100644 index 351b9e4a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_date_filter.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogDateFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "date_from": "datetime", - "date_from_inclusive": "bool", - "date_to": "datetime", - "date_to_inclusive": "bool", - } - - attribute_map: dict[str, str] = { - "date_from": "dateFrom", - "date_from_inclusive": "dateFromInclusive", - "date_to": "dateTo", - "date_to_inclusive": "dateToInclusive", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - date_from: "datetime | None | Unset_Type" = Unset, - date_from_inclusive: "bool | Unset_Type" = Unset, - date_to: "datetime | None | Unset_Type" = Unset, - date_to_inclusive: "bool | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogDateFilter - a model defined in Swagger - - Parameters - ---------- - date_from: datetime | None, optional - date_from_inclusive: bool, optional - date_to: datetime | None, optional - date_to_inclusive: bool, optional - """ - self._date_from: datetime | None | Unset_Type = Unset - self._date_from_inclusive: bool | Unset_Type = Unset - self._date_to: datetime | None | Unset_Type = Unset - self._date_to_inclusive: bool | Unset_Type = Unset - - if date_from is not Unset: - self.date_from = date_from - if date_from_inclusive is not Unset: - self.date_from_inclusive = date_from_inclusive - if date_to is not Unset: - self.date_to = date_to - if date_to_inclusive is not Unset: - self.date_to_inclusive = date_to_inclusive - - @property - def date_from(self) -> "datetime | None | Unset_Type": - """Gets the date_from of this GsaActivityLogDateFilter. - - Returns - ------- - datetime | None | Unset_Type - The date_from of this GsaActivityLogDateFilter. - """ - return self._date_from - - @date_from.setter - def date_from(self, date_from: "datetime | None | Unset_Type") -> None: - """Sets the date_from of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_from: datetime | None | Unset_Type - The date_from of this GsaActivityLogDateFilter. - """ - self._date_from = date_from - - @property - def date_from_inclusive(self) -> "bool | Unset_Type": - """Gets the date_from_inclusive of this GsaActivityLogDateFilter. - - Returns - ------- - bool | Unset_Type - The date_from_inclusive of this GsaActivityLogDateFilter. - """ - return self._date_from_inclusive - - @date_from_inclusive.setter - def date_from_inclusive(self, date_from_inclusive: "bool | Unset_Type") -> None: - """Sets the date_from_inclusive of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_from_inclusive: bool | Unset_Type - The date_from_inclusive of this GsaActivityLogDateFilter. - """ - # Field is not nullable - if date_from_inclusive is None: - raise ValueError("Invalid value for 'date_from_inclusive', must not be 'None'") - self._date_from_inclusive = date_from_inclusive - - @property - def date_to(self) -> "datetime | None | Unset_Type": - """Gets the date_to of this GsaActivityLogDateFilter. - - Returns - ------- - datetime | None | Unset_Type - The date_to of this GsaActivityLogDateFilter. - """ - return self._date_to - - @date_to.setter - def date_to(self, date_to: "datetime | None | Unset_Type") -> None: - """Sets the date_to of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_to: datetime | None | Unset_Type - The date_to of this GsaActivityLogDateFilter. - """ - self._date_to = date_to - - @property - def date_to_inclusive(self) -> "bool | Unset_Type": - """Gets the date_to_inclusive of this GsaActivityLogDateFilter. - - Returns - ------- - bool | Unset_Type - The date_to_inclusive of this GsaActivityLogDateFilter. - """ - return self._date_to_inclusive - - @date_to_inclusive.setter - def date_to_inclusive(self, date_to_inclusive: "bool | Unset_Type") -> None: - """Sets the date_to_inclusive of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_to_inclusive: bool | Unset_Type - The date_to_inclusive of this GsaActivityLogDateFilter. - """ - # Field is not nullable - if date_to_inclusive is None: - raise ValueError("Invalid value for 'date_to_inclusive', must not be 'None'") - self._date_to_inclusive = date_to_inclusive - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogDateFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_filter.py deleted file mode 100644 index 8a00b054..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_filter.py +++ /dev/null @@ -1,327 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogEntriesFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "application_name_filter": "GsaActivityLogApplicationNameFilter", - "application_names_collection_filter": "GsaActivityLogApplicationNamesCollectionFilter", - "database_key_filter": "GsaActivityLogDatabaseKeyFilter", - "date_filter": "GsaActivityLogDateFilter", - "usage_mode_filter": "GsaActivityLogUsageModeFilter", - "username_filter": "GsaActivityLogUsernameFilter", - } - - attribute_map: dict[str, str] = { - "application_name_filter": "applicationNameFilter", - "application_names_collection_filter": "applicationNamesCollectionFilter", - "database_key_filter": "databaseKeyFilter", - "date_filter": "dateFilter", - "usage_mode_filter": "usageModeFilter", - "username_filter": "usernameFilter", - } - - subtype_mapping: dict[str, str] = { - "dateFilter": "GsaActivityLogDateFilter", - "usernameFilter": "GsaActivityLogUsernameFilter", - "applicationNamesCollectionFilter": "GsaActivityLogApplicationNamesCollectionFilter", - "applicationNameFilter": "GsaActivityLogApplicationNameFilter", - "databaseKeyFilter": "GsaActivityLogDatabaseKeyFilter", - "usageModeFilter": "GsaActivityLogUsageModeFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - application_name_filter: "GsaActivityLogApplicationNameFilter | Unset_Type" = Unset, - application_names_collection_filter: "GsaActivityLogApplicationNamesCollectionFilter | Unset_Type" = Unset, - database_key_filter: "GsaActivityLogDatabaseKeyFilter | Unset_Type" = Unset, - date_filter: "GsaActivityLogDateFilter | Unset_Type" = Unset, - usage_mode_filter: "GsaActivityLogUsageModeFilter | Unset_Type" = Unset, - username_filter: "GsaActivityLogUsernameFilter | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogEntriesFilter - a model defined in Swagger - - Parameters - ---------- - application_name_filter: GsaActivityLogApplicationNameFilter, optional - application_names_collection_filter: GsaActivityLogApplicationNamesCollectionFilter, optional - database_key_filter: GsaActivityLogDatabaseKeyFilter, optional - date_filter: GsaActivityLogDateFilter, optional - usage_mode_filter: GsaActivityLogUsageModeFilter, optional - username_filter: GsaActivityLogUsernameFilter, optional - """ - self._date_filter: GsaActivityLogDateFilter | Unset_Type = Unset - self._username_filter: GsaActivityLogUsernameFilter | Unset_Type = Unset - self._application_names_collection_filter: ( - GsaActivityLogApplicationNamesCollectionFilter | Unset_Type - ) = Unset - self._application_name_filter: GsaActivityLogApplicationNameFilter | Unset_Type = Unset - self._database_key_filter: GsaActivityLogDatabaseKeyFilter | Unset_Type = Unset - self._usage_mode_filter: GsaActivityLogUsageModeFilter | Unset_Type = Unset - - if date_filter is not Unset: - self.date_filter = date_filter - if username_filter is not Unset: - self.username_filter = username_filter - if application_names_collection_filter is not Unset: - self.application_names_collection_filter = application_names_collection_filter - if application_name_filter is not Unset: - self.application_name_filter = application_name_filter - if database_key_filter is not Unset: - self.database_key_filter = database_key_filter - if usage_mode_filter is not Unset: - self.usage_mode_filter = usage_mode_filter - - @property - def date_filter(self) -> "GsaActivityLogDateFilter | Unset_Type": - """Gets the date_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogDateFilter | Unset_Type - The date_filter of this GsaActivityLogEntriesFilter. - """ - return self._date_filter - - @date_filter.setter - def date_filter(self, date_filter: "GsaActivityLogDateFilter | Unset_Type") -> None: - """Sets the date_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - date_filter: GsaActivityLogDateFilter | Unset_Type - The date_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if date_filter is None: - raise ValueError("Invalid value for 'date_filter', must not be 'None'") - self._date_filter = date_filter - - @property - def username_filter(self) -> "GsaActivityLogUsernameFilter | Unset_Type": - """Gets the username_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogUsernameFilter | Unset_Type - The username_filter of this GsaActivityLogEntriesFilter. - """ - return self._username_filter - - @username_filter.setter - def username_filter(self, username_filter: "GsaActivityLogUsernameFilter | Unset_Type") -> None: - """Sets the username_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - username_filter: GsaActivityLogUsernameFilter | Unset_Type - The username_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if username_filter is None: - raise ValueError("Invalid value for 'username_filter', must not be 'None'") - self._username_filter = username_filter - - @property - def application_names_collection_filter( - self, - ) -> "GsaActivityLogApplicationNamesCollectionFilter | Unset_Type": - """Gets the application_names_collection_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogApplicationNamesCollectionFilter | Unset_Type - The application_names_collection_filter of this GsaActivityLogEntriesFilter. - """ - return self._application_names_collection_filter - - @application_names_collection_filter.setter - def application_names_collection_filter( - self, - application_names_collection_filter: "GsaActivityLogApplicationNamesCollectionFilter | Unset_Type", - ) -> None: - """Sets the application_names_collection_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - application_names_collection_filter: GsaActivityLogApplicationNamesCollectionFilter | Unset_Type - The application_names_collection_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if application_names_collection_filter is None: - raise ValueError( - "Invalid value for 'application_names_collection_filter', must not be 'None'" - ) - self._application_names_collection_filter = application_names_collection_filter - - @property - def application_name_filter(self) -> "GsaActivityLogApplicationNameFilter | Unset_Type": - """Gets the application_name_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogApplicationNameFilter | Unset_Type - The application_name_filter of this GsaActivityLogEntriesFilter. - """ - return self._application_name_filter - - @application_name_filter.setter - def application_name_filter( - self, application_name_filter: "GsaActivityLogApplicationNameFilter | Unset_Type" - ) -> None: - """Sets the application_name_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - application_name_filter: GsaActivityLogApplicationNameFilter | Unset_Type - The application_name_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if application_name_filter is None: - raise ValueError("Invalid value for 'application_name_filter', must not be 'None'") - self._application_name_filter = application_name_filter - - @property - def database_key_filter(self) -> "GsaActivityLogDatabaseKeyFilter | Unset_Type": - """Gets the database_key_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogDatabaseKeyFilter | Unset_Type - The database_key_filter of this GsaActivityLogEntriesFilter. - """ - return self._database_key_filter - - @database_key_filter.setter - def database_key_filter( - self, database_key_filter: "GsaActivityLogDatabaseKeyFilter | Unset_Type" - ) -> None: - """Sets the database_key_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - database_key_filter: GsaActivityLogDatabaseKeyFilter | Unset_Type - The database_key_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if database_key_filter is None: - raise ValueError("Invalid value for 'database_key_filter', must not be 'None'") - self._database_key_filter = database_key_filter - - @property - def usage_mode_filter(self) -> "GsaActivityLogUsageModeFilter | Unset_Type": - """Gets the usage_mode_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogUsageModeFilter | Unset_Type - The usage_mode_filter of this GsaActivityLogEntriesFilter. - """ - return self._usage_mode_filter - - @usage_mode_filter.setter - def usage_mode_filter( - self, usage_mode_filter: "GsaActivityLogUsageModeFilter | Unset_Type" - ) -> None: - """Sets the usage_mode_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - usage_mode_filter: GsaActivityLogUsageModeFilter | Unset_Type - The usage_mode_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if usage_mode_filter is None: - raise ValueError("Invalid value for 'usage_mode_filter', must not be 'None'") - self._usage_mode_filter = usage_mode_filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogEntriesFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_info.py deleted file mode 100644 index 2db9b416..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entries_info.py +++ /dev/null @@ -1,219 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogEntriesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entries": "list[GsaActivityLogEntry]", - "item_type": "GsaPaginatedItemType", - "links": "GsaPaginationLinks", - } - - attribute_map: dict[str, str] = { - "entries": "entries", - "item_type": "itemType", - "links": "links", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaPaginatedItemType", - "entries": "GsaActivityLogEntry", - "links": "GsaPaginationLinks", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entries: "list[GsaActivityLogEntry]", - item_type: "GsaPaginatedItemType", - links: "GsaPaginationLinks", - ) -> None: - """GsaActivityLogEntriesInfo - a model defined in Swagger - - Parameters - ---------- - entries: list[GsaActivityLogEntry] - item_type: GsaPaginatedItemType - links: GsaPaginationLinks - """ - self._item_type: GsaPaginatedItemType - self._entries: list[GsaActivityLogEntry] - self._links: GsaPaginationLinks - - self.item_type = item_type - self.entries = entries - self.links = links - - @property - def item_type(self) -> "GsaPaginatedItemType": - """Gets the item_type of this GsaActivityLogEntriesInfo. - - Returns - ------- - GsaPaginatedItemType - The item_type of this GsaActivityLogEntriesInfo. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaPaginatedItemType") -> None: - """Sets the item_type of this GsaActivityLogEntriesInfo. - - Parameters - ---------- - item_type: GsaPaginatedItemType - The item_type of this GsaActivityLogEntriesInfo. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def entries(self) -> "list[GsaActivityLogEntry]": - """Gets the entries of this GsaActivityLogEntriesInfo. - - Returns - ------- - list[GsaActivityLogEntry] - The entries of this GsaActivityLogEntriesInfo. - """ - return self._entries - - @entries.setter - def entries(self, entries: "list[GsaActivityLogEntry]") -> None: - """Sets the entries of this GsaActivityLogEntriesInfo. - - Parameters - ---------- - entries: list[GsaActivityLogEntry] - The entries of this GsaActivityLogEntriesInfo. - """ - # Field is not nullable - if entries is None: - raise ValueError("Invalid value for 'entries', must not be 'None'") - # Field is required - if entries is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entries', must not be 'Unset'") - self._entries = entries - - @property - def links(self) -> "GsaPaginationLinks": - """Gets the links of this GsaActivityLogEntriesInfo. - - Returns - ------- - GsaPaginationLinks - The links of this GsaActivityLogEntriesInfo. - """ - return self._links - - @links.setter - def links(self, links: "GsaPaginationLinks") -> None: - """Sets the links of this GsaActivityLogEntriesInfo. - - Parameters - ---------- - links: GsaPaginationLinks - The links of this GsaActivityLogEntriesInfo. - """ - # Field is not nullable - if links is None: - raise ValueError("Invalid value for 'links', must not be 'None'") - # Field is required - if links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'links', must not be 'Unset'") - self._links = links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogEntriesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entry.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entry.py deleted file mode 100644 index 96c6364f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_entry.py +++ /dev/null @@ -1,280 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogEntry(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "_date": "datetime", - "application_names": "list[str]", - "usage_mode": "GsaActivityLogUsageMode", - "username": "str", - "database_key": "str", - } - - attribute_map: dict[str, str] = { - "_date": "date", - "application_names": "applicationNames", - "usage_mode": "usageMode", - "username": "username", - "database_key": "databaseKey", - } - - subtype_mapping: dict[str, str] = { - "usageMode": "GsaActivityLogUsageMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - _date: "datetime", - application_names: "list[str]", - usage_mode: "GsaActivityLogUsageMode", - username: "str", - database_key: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogEntry - a model defined in Swagger - - Parameters - ---------- - _date: datetime - application_names: list[str] - usage_mode: GsaActivityLogUsageMode - username: str - database_key: str | None, optional - """ - self.__date: datetime - self._username: str - self._application_names: list[str] - self._database_key: str | None | Unset_Type = Unset - self._usage_mode: GsaActivityLogUsageMode - - self._date = _date - self.username = username - self.application_names = application_names - if database_key is not Unset: - self.database_key = database_key - self.usage_mode = usage_mode - - @property - def _date(self) -> "datetime": - """Gets the _date of this GsaActivityLogEntry. - - Returns - ------- - datetime - The _date of this GsaActivityLogEntry. - """ - return self.__date - - @_date.setter - def _date(self, _date: "datetime") -> None: - """Sets the _date of this GsaActivityLogEntry. - - Parameters - ---------- - _date: datetime - The _date of this GsaActivityLogEntry. - """ - # Field is not nullable - if _date is None: - raise ValueError("Invalid value for '_date', must not be 'None'") - # Field is required - if _date is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for '_date', must not be 'Unset'") - self.__date = _date - - @property - def username(self) -> "str": - """Gets the username of this GsaActivityLogEntry. - - Returns - ------- - str - The username of this GsaActivityLogEntry. - """ - return self._username - - @username.setter - def username(self, username: "str") -> None: - """Sets the username of this GsaActivityLogEntry. - - Parameters - ---------- - username: str - The username of this GsaActivityLogEntry. - """ - # Field is not nullable - if username is None: - raise ValueError("Invalid value for 'username', must not be 'None'") - # Field is required - if username is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'username', must not be 'Unset'") - self._username = username - - @property - def application_names(self) -> "list[str]": - """Gets the application_names of this GsaActivityLogEntry. - - Returns - ------- - list[str] - The application_names of this GsaActivityLogEntry. - """ - return self._application_names - - @application_names.setter - def application_names(self, application_names: "list[str]") -> None: - """Sets the application_names of this GsaActivityLogEntry. - - Parameters - ---------- - application_names: list[str] - The application_names of this GsaActivityLogEntry. - """ - # Field is not nullable - if application_names is None: - raise ValueError("Invalid value for 'application_names', must not be 'None'") - # Field is required - if application_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'application_names', must not be 'Unset'") - self._application_names = application_names - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaActivityLogEntry. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaActivityLogEntry. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaActivityLogEntry. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaActivityLogEntry. - """ - self._database_key = database_key - - @property - def usage_mode(self) -> "GsaActivityLogUsageMode": - """Gets the usage_mode of this GsaActivityLogEntry. - - Returns - ------- - GsaActivityLogUsageMode - The usage_mode of this GsaActivityLogEntry. - """ - return self._usage_mode - - @usage_mode.setter - def usage_mode(self, usage_mode: "GsaActivityLogUsageMode") -> None: - """Sets the usage_mode of this GsaActivityLogEntry. - - Parameters - ---------- - usage_mode: GsaActivityLogUsageMode - The usage_mode of this GsaActivityLogEntry. - """ - # Field is not nullable - if usage_mode is None: - raise ValueError("Invalid value for 'usage_mode', must not be 'None'") - # Field is required - if usage_mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'usage_mode', must not be 'Unset'") - self._usage_mode = usage_mode - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogEntry): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_match_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_match_type.py deleted file mode 100644 index 08d5ff0b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_match_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaActivityLogMatchType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - EXACTMATCHCASEINSENSITIVE = "exactMatchCaseInsensitive" - CONTAINSCASEINSENSITIVE = "containsCaseInsensitive" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode.py deleted file mode 100644 index 9e4b047f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaActivityLogUsageMode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - VIEW = "view" - EDIT = "edit" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode_filter.py deleted file mode 100644 index 6848de40..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_usage_mode_filter.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogUsageModeFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "usage_mode_to_match": "GsaActivityLogUsageMode", - } - - attribute_map: dict[str, str] = { - "usage_mode_to_match": "usageModeToMatch", - } - - subtype_mapping: dict[str, str] = { - "usageModeToMatch": "GsaActivityLogUsageMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - usage_mode_to_match: "GsaActivityLogUsageMode", - ) -> None: - """GsaActivityLogUsageModeFilter - a model defined in Swagger - - Parameters - ---------- - usage_mode_to_match: GsaActivityLogUsageMode - """ - self._usage_mode_to_match: GsaActivityLogUsageMode - - self.usage_mode_to_match = usage_mode_to_match - - @property - def usage_mode_to_match(self) -> "GsaActivityLogUsageMode": - """Gets the usage_mode_to_match of this GsaActivityLogUsageModeFilter. - - Returns - ------- - GsaActivityLogUsageMode - The usage_mode_to_match of this GsaActivityLogUsageModeFilter. - """ - return self._usage_mode_to_match - - @usage_mode_to_match.setter - def usage_mode_to_match(self, usage_mode_to_match: "GsaActivityLogUsageMode") -> None: - """Sets the usage_mode_to_match of this GsaActivityLogUsageModeFilter. - - Parameters - ---------- - usage_mode_to_match: GsaActivityLogUsageMode - The usage_mode_to_match of this GsaActivityLogUsageModeFilter. - """ - # Field is not nullable - if usage_mode_to_match is None: - raise ValueError("Invalid value for 'usage_mode_to_match', must not be 'None'") - # Field is required - if usage_mode_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'usage_mode_to_match', must not be 'Unset'") - self._usage_mode_to_match = usage_mode_to_match - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogUsageModeFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_username_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_username_filter.py deleted file mode 100644 index b53d234d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_activity_log_username_filter.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogUsernameFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "username_to_match": "str", - "match_type": "GsaActivityLogMatchType", - } - - attribute_map: dict[str, str] = { - "username_to_match": "usernameToMatch", - "match_type": "matchType", - } - - subtype_mapping: dict[str, str] = { - "matchType": "GsaActivityLogMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - username_to_match: "str", - match_type: "GsaActivityLogMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogUsernameFilter - a model defined in Swagger - - Parameters - ---------- - username_to_match: str - match_type: GsaActivityLogMatchType, optional - """ - self._username_to_match: str - self._match_type: GsaActivityLogMatchType | Unset_Type = Unset - - self.username_to_match = username_to_match - if match_type is not Unset: - self.match_type = match_type - - @property - def username_to_match(self) -> "str": - """Gets the username_to_match of this GsaActivityLogUsernameFilter. - - Returns - ------- - str - The username_to_match of this GsaActivityLogUsernameFilter. - """ - return self._username_to_match - - @username_to_match.setter - def username_to_match(self, username_to_match: "str") -> None: - """Sets the username_to_match of this GsaActivityLogUsernameFilter. - - Parameters - ---------- - username_to_match: str - The username_to_match of this GsaActivityLogUsernameFilter. - """ - # Field is not nullable - if username_to_match is None: - raise ValueError("Invalid value for 'username_to_match', must not be 'None'") - # Field is required - if username_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'username_to_match', must not be 'Unset'") - self._username_to_match = username_to_match - - @property - def match_type(self) -> "GsaActivityLogMatchType | Unset_Type": - """Gets the match_type of this GsaActivityLogUsernameFilter. - - Returns - ------- - GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogUsernameFilter. - """ - return self._match_type - - @match_type.setter - def match_type(self, match_type: "GsaActivityLogMatchType | Unset_Type") -> None: - """Sets the match_type of this GsaActivityLogUsernameFilter. - - Parameters - ---------- - match_type: GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogUsernameFilter. - """ - # Field is not nullable - if match_type is None: - raise ValueError("Invalid value for 'match_type', must not be 'None'") - self._match_type = match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogUsernameFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database.py index 52b3182d..e2574a89 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database.py @@ -61,8 +61,8 @@ class GsaAddDatabase(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { + "connection_details": "GsaConnectionDetails", "database_key": "str", - "input_connection_details": "GsaInputConnectionDetails", "is_read_only": "bool", "language": "str", "loading_order": "int", @@ -70,8 +70,8 @@ class GsaAddDatabase(ModelBase): } attribute_map: dict[str, str] = { + "connection_details": "connectionDetails", "database_key": "databaseKey", - "input_connection_details": "inputConnectionDetails", "is_read_only": "isReadOnly", "language": "language", "loading_order": "loadingOrder", @@ -79,7 +79,7 @@ class GsaAddDatabase(ModelBase): } subtype_mapping: dict[str, str] = { - "inputConnectionDetails": "GsaInputConnectionDetails", + "connectionDetails": "GsaConnectionDetails", } discriminator: Optional[str] = None @@ -87,8 +87,8 @@ class GsaAddDatabase(ModelBase): def __init__( self, *, + connection_details: "GsaConnectionDetails", database_key: "str", - input_connection_details: "GsaInputConnectionDetails", is_read_only: "bool | None | Unset_Type" = Unset, language: "str | None | Unset_Type" = Unset, loading_order: "int | None | Unset_Type" = Unset, @@ -98,22 +98,22 @@ def __init__( Parameters ---------- + connection_details: GsaConnectionDetails database_key: str - input_connection_details: GsaInputConnectionDetails is_read_only: bool | None, optional language: str | None, optional loading_order: int | None, optional version_guid: str | None, optional """ self._database_key: str - self._input_connection_details: GsaInputConnectionDetails + self._connection_details: GsaConnectionDetails self._is_read_only: bool | None | Unset_Type = Unset self._loading_order: int | None | Unset_Type = Unset self._language: str | None | Unset_Type = Unset self._version_guid: str | None | Unset_Type = Unset self.database_key = database_key - self.input_connection_details = input_connection_details + self.connection_details = connection_details if is_read_only is not Unset: self.is_read_only = is_read_only if loading_order is not Unset: @@ -152,34 +152,32 @@ def database_key(self, database_key: "str") -> None: self._database_key = database_key @property - def input_connection_details(self) -> "GsaInputConnectionDetails": - """Gets the input_connection_details of this GsaAddDatabase. + def connection_details(self) -> "GsaConnectionDetails": + """Gets the connection_details of this GsaAddDatabase. Returns ------- - GsaInputConnectionDetails - The input_connection_details of this GsaAddDatabase. + GsaConnectionDetails + The connection_details of this GsaAddDatabase. """ - return self._input_connection_details + return self._connection_details - @input_connection_details.setter - def input_connection_details( - self, input_connection_details: "GsaInputConnectionDetails" - ) -> None: - """Sets the input_connection_details of this GsaAddDatabase. + @connection_details.setter + def connection_details(self, connection_details: "GsaConnectionDetails") -> None: + """Sets the connection_details of this GsaAddDatabase. Parameters ---------- - input_connection_details: GsaInputConnectionDetails - The input_connection_details of this GsaAddDatabase. + connection_details: GsaConnectionDetails + The connection_details of this GsaAddDatabase. """ # Field is not nullable - if input_connection_details is None: - raise ValueError("Invalid value for 'input_connection_details', must not be 'None'") + if connection_details is None: + raise ValueError("Invalid value for 'connection_details', must not be 'None'") # Field is required - if input_connection_details is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'input_connection_details', must not be 'Unset'") - self._input_connection_details = input_connection_details + if connection_details is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'connection_details', must not be 'Unset'") + self._connection_details = connection_details @property def is_read_only(self) -> "bool | None | Unset_Type": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database_security_groups.py deleted file mode 100644 index 59ac0c15..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_add_database_security_groups.py +++ /dev/null @@ -1,268 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAddDatabaseSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str | None", - grant_group: "str | None", - power_user_group: "str | None", - read_group: "str | None", - write_group: "str | None", - ) -> None: - """GsaAddDatabaseSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str | None - grant_group: str | None - power_user_group: str | None - read_group: str | None - write_group: str | None - """ - self._admin_group: str | None - self._grant_group: str | None - self._power_user_group: str | None - self._write_group: str | None - self._read_group: str | None - - self.admin_group = admin_group - self.grant_group = grant_group - self.power_user_group = power_user_group - self.write_group = write_group - self.read_group = read_group - - @property - def admin_group(self) -> "str | None": - """Gets the admin_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The admin_group of this GsaAddDatabaseSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str | None") -> None: - """Sets the admin_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - admin_group: str | None - The admin_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if admin_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'admin_group', must not be 'Unset'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str | None": - """Gets the grant_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The grant_group of this GsaAddDatabaseSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str | None") -> None: - """Sets the grant_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - grant_group: str | None - The grant_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if grant_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'grant_group', must not be 'Unset'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str | None": - """Gets the power_user_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The power_user_group of this GsaAddDatabaseSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str | None") -> None: - """Sets the power_user_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - power_user_group: str | None - The power_user_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if power_user_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'power_user_group', must not be 'Unset'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str | None": - """Gets the write_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The write_group of this GsaAddDatabaseSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str | None") -> None: - """Sets the write_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - write_group: str | None - The write_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if write_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'write_group', must not be 'Unset'") - self._write_group = write_group - - @property - def read_group(self) -> "str | None": - """Gets the read_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The read_group of this GsaAddDatabaseSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str | None") -> None: - """Sets the read_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - read_group: str | None - The read_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if read_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'read_group', must not be 'Unset'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAddDatabaseSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_additional_sql_parameters.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_additional_sql_parameters.py deleted file mode 100644 index c3fd61fd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_additional_sql_parameters.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAdditionalSqlParameters(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "value": "str", - } - - attribute_map: dict[str, str] = { - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - value: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaAdditionalSqlParameters - a model defined in Swagger - - Parameters - ---------- - value: str | None, optional - """ - self._value: str | None | Unset_Type = Unset - - if value is not Unset: - self.value = value - - @property - def value(self) -> "str | None | Unset_Type": - """Gets the value of this GsaAdditionalSqlParameters. - - Returns - ------- - str | None | Unset_Type - The value of this GsaAdditionalSqlParameters. - """ - return self._value - - @value.setter - def value(self, value: "str | None | Unset_Type") -> None: - """Sets the value of this GsaAdditionalSqlParameters. - - Parameters - ---------- - value: str | None | Unset_Type - The value of this GsaAdditionalSqlParameters. - """ - self._value = value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAdditionalSqlParameters): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregate_permission_access_controls_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregate_permission_access_controls_request.py deleted file mode 100644 index 485decfa..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregate_permission_access_controls_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAggregatePermissionAccessControlsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entities": "list[GsaAccessControlEntity]", - } - - attribute_map: dict[str, str] = { - "entities": "entities", - } - - subtype_mapping: dict[str, str] = { - "entities": "GsaAccessControlEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entities: "list[GsaAccessControlEntity]", - ) -> None: - """GsaAggregatePermissionAccessControlsRequest - a model defined in Swagger - - Parameters - ---------- - entities: list[GsaAccessControlEntity] - """ - self._entities: list[GsaAccessControlEntity] - - self.entities = entities - - @property - def entities(self) -> "list[GsaAccessControlEntity]": - """Gets the entities of this GsaAggregatePermissionAccessControlsRequest. - - Returns - ------- - list[GsaAccessControlEntity] - The entities of this GsaAggregatePermissionAccessControlsRequest. - """ - return self._entities - - @entities.setter - def entities(self, entities: "list[GsaAccessControlEntity]") -> None: - """Sets the entities of this GsaAggregatePermissionAccessControlsRequest. - - Parameters - ---------- - entities: list[GsaAccessControlEntity] - The entities of this GsaAggregatePermissionAccessControlsRequest. - """ - # Field is not nullable - if entities is None: - raise ValueError("Invalid value for 'entities', must not be 'None'") - # Field is required - if entities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entities', must not be 'Unset'") - self._entities = entities - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAggregatePermissionAccessControlsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregations_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregations_request.py index c15d5a97..4c546836 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregations_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_aggregations_request.py @@ -63,19 +63,16 @@ class GsaAggregationsRequest(ModelBase): swagger_types: dict[str, str] = { "aggregation_criteria": "list[GsaAggregationCriterion]", "criterion": "GsaCriterion", - "table_search_behaviour": "GsaTableSearchBehaviour", } attribute_map: dict[str, str] = { "aggregation_criteria": "aggregationCriteria", "criterion": "criterion", - "table_search_behaviour": "tableSearchBehaviour", } subtype_mapping: dict[str, str] = { "criterion": "GsaCriterion", "aggregationCriteria": "GsaAggregationCriterion", - "tableSearchBehaviour": "GsaTableSearchBehaviour", } discriminator: Optional[str] = None @@ -85,7 +82,6 @@ def __init__( *, aggregation_criteria: "list[GsaAggregationCriterion] | None | Unset_Type" = Unset, criterion: "GsaCriterion | Unset_Type" = Unset, - table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" = Unset, ) -> None: """GsaAggregationsRequest - a model defined in Swagger @@ -93,18 +89,14 @@ def __init__( ---------- aggregation_criteria: list[GsaAggregationCriterion] | None, optional criterion: GsaCriterion, optional - table_search_behaviour: GsaTableSearchBehaviour, optional """ self._criterion: GsaCriterion | Unset_Type = Unset self._aggregation_criteria: list[GsaAggregationCriterion] | None | Unset_Type = Unset - self._table_search_behaviour: GsaTableSearchBehaviour | Unset_Type = Unset if criterion is not Unset: self.criterion = criterion if aggregation_criteria is not Unset: self.aggregation_criteria = aggregation_criteria - if table_search_behaviour is not Unset: - self.table_search_behaviour = table_search_behaviour @property def criterion(self) -> "GsaCriterion | Unset_Type": @@ -157,33 +149,6 @@ def aggregation_criteria( """ self._aggregation_criteria = aggregation_criteria - @property - def table_search_behaviour(self) -> "GsaTableSearchBehaviour | Unset_Type": - """Gets the table_search_behaviour of this GsaAggregationsRequest. - - Returns - ------- - GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaAggregationsRequest. - """ - return self._table_search_behaviour - - @table_search_behaviour.setter - def table_search_behaviour( - self, table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" - ) -> None: - """Sets the table_search_behaviour of this GsaAggregationsRequest. - - Parameters - ---------- - table_search_behaviour: GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaAggregationsRequest. - """ - # Field is not nullable - if table_search_behaviour is None: - raise ValueError("Invalid value for 'table_search_behaviour', must not be 'None'") - self._table_search_behaviour = table_search_behaviour - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_apply_options.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_apply_options.py deleted file mode 100644 index c8dc1380..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_apply_options.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaApplyOptions(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "apply_adds_as_state": "bool", - "match_mode": "GsaMatchMode", - "retarget_tabular_attributes": "bool", - } - - attribute_map: dict[str, str] = { - "apply_adds_as_state": "applyAddsAsState", - "match_mode": "matchMode", - "retarget_tabular_attributes": "retargetTabularAttributes", - } - - subtype_mapping: dict[str, str] = { - "matchMode": "GsaMatchMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - apply_adds_as_state: "bool", - match_mode: "GsaMatchMode", - retarget_tabular_attributes: "bool", - ) -> None: - """GsaApplyOptions - a model defined in Swagger - - Parameters - ---------- - apply_adds_as_state: bool - match_mode: GsaMatchMode - retarget_tabular_attributes: bool - """ - self._match_mode: GsaMatchMode - self._apply_adds_as_state: bool - self._retarget_tabular_attributes: bool - - self.match_mode = match_mode - self.apply_adds_as_state = apply_adds_as_state - self.retarget_tabular_attributes = retarget_tabular_attributes - - @property - def match_mode(self) -> "GsaMatchMode": - """Gets the match_mode of this GsaApplyOptions. - - Returns - ------- - GsaMatchMode - The match_mode of this GsaApplyOptions. - """ - return self._match_mode - - @match_mode.setter - def match_mode(self, match_mode: "GsaMatchMode") -> None: - """Sets the match_mode of this GsaApplyOptions. - - Parameters - ---------- - match_mode: GsaMatchMode - The match_mode of this GsaApplyOptions. - """ - # Field is not nullable - if match_mode is None: - raise ValueError("Invalid value for 'match_mode', must not be 'None'") - # Field is required - if match_mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'match_mode', must not be 'Unset'") - self._match_mode = match_mode - - @property - def apply_adds_as_state(self) -> "bool": - """Gets the apply_adds_as_state of this GsaApplyOptions. - - Returns - ------- - bool - The apply_adds_as_state of this GsaApplyOptions. - """ - return self._apply_adds_as_state - - @apply_adds_as_state.setter - def apply_adds_as_state(self, apply_adds_as_state: "bool") -> None: - """Sets the apply_adds_as_state of this GsaApplyOptions. - - Parameters - ---------- - apply_adds_as_state: bool - The apply_adds_as_state of this GsaApplyOptions. - """ - # Field is not nullable - if apply_adds_as_state is None: - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'None'") - # Field is required - if apply_adds_as_state is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'Unset'") - self._apply_adds_as_state = apply_adds_as_state - - @property - def retarget_tabular_attributes(self) -> "bool": - """Gets the retarget_tabular_attributes of this GsaApplyOptions. - - Returns - ------- - bool - The retarget_tabular_attributes of this GsaApplyOptions. - """ - return self._retarget_tabular_attributes - - @retarget_tabular_attributes.setter - def retarget_tabular_attributes(self, retarget_tabular_attributes: "bool") -> None: - """Sets the retarget_tabular_attributes of this GsaApplyOptions. - - Parameters - ---------- - retarget_tabular_attributes: bool - The retarget_tabular_attributes of this GsaApplyOptions. - """ - # Field is not nullable - if retarget_tabular_attributes is None: - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'None'") - # Field is required - if retarget_tabular_attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'Unset'") - self._retarget_tabular_attributes = retarget_tabular_attributes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaApplyOptions): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_association_chain_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_association_chain_create_put_layout_item.py deleted file mode 100644 index 84205578..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_association_chain_create_put_layout_item.py +++ /dev/null @@ -1,202 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAssociationChainCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "association_chain_links": "list[GsaNewLayoutAssociationChainLink]", - "association_chain_name": "str", - "item_type": "GsaNewLayoutItemType", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "association_chain_links": "associationChainLinks", - "association_chain_name": "associationChainName", - "item_type": "itemType", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "associationChainLinks": "GsaNewLayoutAssociationChainLink", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - association_chain_links: "list[GsaNewLayoutAssociationChainLink]", - association_chain_name: "str", - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.ASSOCIATIONCHAIN, - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaAssociationChainCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - association_chain_links: list[GsaNewLayoutAssociationChainLink] - association_chain_name: str - item_type: GsaNewLayoutItemType - type: GsaPutType - """ - super().__init__(item_type=item_type, type=type) - self._association_chain_name: str - self._association_chain_links: list[GsaNewLayoutAssociationChainLink] - - self.association_chain_name = association_chain_name - self.association_chain_links = association_chain_links - - @property - def association_chain_name(self) -> "str": - """Gets the association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - - Returns - ------- - str - The association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - """ - return self._association_chain_name - - @association_chain_name.setter - def association_chain_name(self, association_chain_name: "str") -> None: - """Sets the association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - - Parameters - ---------- - association_chain_name: str - The association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - """ - # Field is not nullable - if association_chain_name is None: - raise ValueError("Invalid value for 'association_chain_name', must not be 'None'") - # Field is required - if association_chain_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'association_chain_name', must not be 'Unset'") - self._association_chain_name = association_chain_name - - @property - def association_chain_links(self) -> "list[GsaNewLayoutAssociationChainLink]": - """Gets the association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - - Returns - ------- - list[GsaNewLayoutAssociationChainLink] - The association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - """ - return self._association_chain_links - - @association_chain_links.setter - def association_chain_links( - self, association_chain_links: "list[GsaNewLayoutAssociationChainLink]" - ) -> None: - """Sets the association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - - Parameters - ---------- - association_chain_links: list[GsaNewLayoutAssociationChainLink] - The association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - """ - # Field is not nullable - if association_chain_links is None: - raise ValueError("Invalid value for 'association_chain_links', must not be 'None'") - # Field is required - if association_chain_links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'association_chain_links', must not be 'Unset'") - self._association_chain_links = association_chain_links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAssociationChainCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute.py index 112da011..40ee400a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute.py @@ -68,7 +68,6 @@ class GsaAttribute(ModelBase): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -83,7 +82,6 @@ class GsaAttribute(ModelBase): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -129,7 +127,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType", @@ -146,7 +143,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -161,7 +157,6 @@ def __init__( self._type: GsaAttributeType self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset self._is_hidden_from_search_criteria: bool - self._is_protected: bool self._table: GsaSlimEntity self._display_names: dict[str, str] self._name: str @@ -177,7 +172,6 @@ def __init__( if about_attribute is not Unset: self.about_attribute = about_attribute self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - self.is_protected = is_protected self.table = table self.display_names = display_names self.name = name @@ -373,36 +367,6 @@ def is_hidden_from_search_criteria(self, is_hidden_from_search_criteria: "bool") ) self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaAttribute. - If true, the attribute is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaAttribute. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaAttribute. - If true, the attribute is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaAttribute. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def table(self) -> "GsaSlimEntity": """Gets the table of this GsaAttribute. @@ -434,7 +398,6 @@ def table(self, table: "GsaSlimEntity") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -446,7 +409,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_access_control_entity.py deleted file mode 100644 index 4a09465b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_access_control_entity.py +++ /dev/null @@ -1,225 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity import ( # noqa: F401 - GsaAccessControlEntity, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity_type import ( - GsaAccessControlEntityType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeAccessControlEntity(GsaAccessControlEntity): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "entity_type": "GsaAccessControlEntityType", - "table_guid": "str", - "is_meta_attribute": "bool", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "entity_type": "entityType", - "table_guid": "tableGuid", - "is_meta_attribute": "isMetaAttribute", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - entity_type: "GsaAccessControlEntityType" = GsaAccessControlEntityType.ATTRIBUTE, - table_guid: "str", - is_meta_attribute: "bool | Unset_Type" = Unset, - ) -> None: - """GsaAttributeAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - entity_type: GsaAccessControlEntityType - table_guid: str - is_meta_attribute: bool, optional - """ - super().__init__(entity_type=entity_type) - self._table_guid: str - self._attribute_guid: str - self._is_meta_attribute: bool | Unset_Type = Unset - - self.table_guid = table_guid - self.attribute_guid = attribute_guid - if is_meta_attribute is not Unset: - self.is_meta_attribute = is_meta_attribute - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaAttributeAccessControlEntity. - - Returns - ------- - str - The table_guid of this GsaAttributeAccessControlEntity. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaAttributeAccessControlEntity. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaAttributeAccessControlEntity. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeAccessControlEntity. - - Returns - ------- - str - The attribute_guid of this GsaAttributeAccessControlEntity. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeAccessControlEntity. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeAccessControlEntity. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def is_meta_attribute(self) -> "bool | Unset_Type": - """Gets the is_meta_attribute of this GsaAttributeAccessControlEntity. - - Returns - ------- - bool | Unset_Type - The is_meta_attribute of this GsaAttributeAccessControlEntity. - """ - return self._is_meta_attribute - - @is_meta_attribute.setter - def is_meta_attribute(self, is_meta_attribute: "bool | Unset_Type") -> None: - """Sets the is_meta_attribute of this GsaAttributeAccessControlEntity. - - Parameters - ---------- - is_meta_attribute: bool | Unset_Type - The is_meta_attribute of this GsaAttributeAccessControlEntity. - """ - # Field is not nullable - if is_meta_attribute is None: - raise ValueError("Invalid value for 'is_meta_attribute', must not be 'None'") - self._is_meta_attribute = is_meta_attribute - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_already_specified_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_already_specified_smart_attributes_error_detail.py deleted file mode 100644 index 30e6fef5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_already_specified_smart_attributes_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTEALREADYSPECIFIED, - table_guid: "str", - ) -> None: - """GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - message: str - reason: GsaSmartAttributesErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._table_guid: str - self._attribute_guid: str - - self.table_guid = table_guid - self.attribute_guid = attribute_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Returns - ------- - str - The table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_based_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_based_access_control_info.py deleted file mode 100644 index 8a567ca8..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_based_access_control_info.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_info import ( # noqa: F401 - GsaAccessControlInfo, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeBasedAccessControlInfo(GsaAccessControlInfo): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "current_rule_engine": "GsaRuleEngine", - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "current_rule_engine": "currentRuleEngine", - "mode": "mode", - } - - subtype_mapping: dict[str, str] = { - "currentRuleEngine": "GsaRuleEngine", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - current_rule_engine: "GsaRuleEngine", - mode: "GsaAccessControlMode" = GsaAccessControlMode.ATTRIBUTEBASED, - ) -> None: - """GsaAttributeBasedAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - current_rule_engine: GsaRuleEngine - mode: GsaAccessControlMode - """ - super().__init__(mode=mode) - self._current_rule_engine: GsaRuleEngine - - self.current_rule_engine = current_rule_engine - - @property - def current_rule_engine(self) -> "GsaRuleEngine": - """Gets the current_rule_engine of this GsaAttributeBasedAccessControlInfo. - - Returns - ------- - GsaRuleEngine - The current_rule_engine of this GsaAttributeBasedAccessControlInfo. - """ - return self._current_rule_engine - - @current_rule_engine.setter - def current_rule_engine(self, current_rule_engine: "GsaRuleEngine") -> None: - """Sets the current_rule_engine of this GsaAttributeBasedAccessControlInfo. - - Parameters - ---------- - current_rule_engine: GsaRuleEngine - The current_rule_engine of this GsaAttributeBasedAccessControlInfo. - """ - # Field is not nullable - if current_rule_engine is None: - raise ValueError("Invalid value for 'current_rule_engine', must not be 'None'") - # Field is required - if current_rule_engine is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'current_rule_engine', must not be 'Unset'") - self._current_rule_engine = current_rule_engine - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeBasedAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_create_put_layout_item.py deleted file mode 100644 index dc070f47..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_create_put_layout_item.py +++ /dev/null @@ -1,290 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "item_type": "GsaNewLayoutItemType", - "type": "GsaPutType", - "meta_attributes": "list[GsaNewLayoutAttributeItem]", - "read_only": "bool", - "required": "bool", - "tabular_column_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "item_type": "itemType", - "type": "type", - "meta_attributes": "metaAttributes", - "read_only": "readOnly", - "required": "required", - "tabular_column_guids": "tabularColumnGuids", - } - - subtype_mapping: dict[str, str] = { - "metaAttributes": "GsaNewLayoutAttributeItem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.ATTRIBUTE, - type: "GsaPutType" = GsaPutType.CREATE, - meta_attributes: "list[GsaNewLayoutAttributeItem] | None | Unset_Type" = Unset, - read_only: "bool | Unset_Type" = Unset, - required: "bool | Unset_Type" = Unset, - tabular_column_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaAttributeCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - item_type: GsaNewLayoutItemType - type: GsaPutType - meta_attributes: list[GsaNewLayoutAttributeItem] | None, optional - read_only: bool, optional - required: bool, optional - tabular_column_guids: list[str] | None, optional - """ - super().__init__(item_type=item_type, type=type) - self._attribute_guid: str - self._required: bool | Unset_Type = Unset - self._read_only: bool | Unset_Type = Unset - self._meta_attributes: list[GsaNewLayoutAttributeItem] | None | Unset_Type = Unset - self._tabular_column_guids: list[str] | None | Unset_Type = Unset - - self.attribute_guid = attribute_guid - if required is not Unset: - self.required = required - if read_only is not Unset: - self.read_only = read_only - if meta_attributes is not Unset: - self.meta_attributes = meta_attributes - if tabular_column_guids is not Unset: - self.tabular_column_guids = tabular_column_guids - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - str - The attribute_guid of this GsaAttributeCreatePutLayoutItem. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeCreatePutLayoutItem. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def required(self) -> "bool | Unset_Type": - """Gets the required of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - bool | Unset_Type - The required of this GsaAttributeCreatePutLayoutItem. - """ - return self._required - - @required.setter - def required(self, required: "bool | Unset_Type") -> None: - """Sets the required of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - required: bool | Unset_Type - The required of this GsaAttributeCreatePutLayoutItem. - """ - # Field is not nullable - if required is None: - raise ValueError("Invalid value for 'required', must not be 'None'") - self._required = required - - @property - def read_only(self) -> "bool | Unset_Type": - """Gets the read_only of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - bool | Unset_Type - The read_only of this GsaAttributeCreatePutLayoutItem. - """ - return self._read_only - - @read_only.setter - def read_only(self, read_only: "bool | Unset_Type") -> None: - """Sets the read_only of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - read_only: bool | Unset_Type - The read_only of this GsaAttributeCreatePutLayoutItem. - """ - # Field is not nullable - if read_only is None: - raise ValueError("Invalid value for 'read_only', must not be 'None'") - self._read_only = read_only - - @property - def meta_attributes(self) -> "list[GsaNewLayoutAttributeItem] | None | Unset_Type": - """Gets the meta_attributes of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - list[GsaNewLayoutAttributeItem] | None | Unset_Type - The meta_attributes of this GsaAttributeCreatePutLayoutItem. - """ - return self._meta_attributes - - @meta_attributes.setter - def meta_attributes( - self, meta_attributes: "list[GsaNewLayoutAttributeItem] | None | Unset_Type" - ) -> None: - """Sets the meta_attributes of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - meta_attributes: list[GsaNewLayoutAttributeItem] | None | Unset_Type - The meta_attributes of this GsaAttributeCreatePutLayoutItem. - """ - self._meta_attributes = meta_attributes - - @property - def tabular_column_guids(self) -> "list[str] | None | Unset_Type": - """Gets the tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - list[str] | None | Unset_Type - The tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - """ - return self._tabular_column_guids - - @tabular_column_guids.setter - def tabular_column_guids(self, tabular_column_guids: "list[str] | None | Unset_Type") -> None: - """Sets the tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - tabular_column_guids: list[str] | None | Unset_Type - The tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - """ - self._tabular_column_guids = tabular_column_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_creation_exception.py index 44f9bbd8..dd35e8da 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_creation_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_creation_exception.py @@ -61,23 +61,19 @@ class GsaAttributeCreationException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaAttributeErrorDetail]", - "is_meta_attribute": "bool", "message": "str", - "name": "str", } attribute_map: dict[str, str] = { "code": "code", "errors": "errors", - "is_meta_attribute": "isMetaAttribute", "message": "message", - "name": "name", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaAttributeErrorDetail", } @@ -86,36 +82,26 @@ class GsaAttributeCreationException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaAttributeErrorDetail] | None | Unset_Type" = Unset, - is_meta_attribute: "bool | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, ) -> None: """GsaAttributeCreationException - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaAttributeErrorDetail] | None, optional - is_meta_attribute: bool, optional message: str | None, optional - name: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._is_meta_attribute: bool | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaAttributeErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - if name is not Unset: - self.name = name - if is_meta_attribute is not Unset: - self.is_meta_attribute = is_meta_attribute if errors is not Unset: self.errors = errors @@ -142,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaAttributeCreationException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaAttributeCreationException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaAttributeCreationException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaAttributeCreationException. """ # Field is not nullable @@ -166,53 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaAttributeCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaAttributeCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaAttributeCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaAttributeCreationException. - """ - self._name = name - - @property - def is_meta_attribute(self) -> "bool | Unset_Type": - """Gets the is_meta_attribute of this GsaAttributeCreationException. - - Returns - ------- - bool | Unset_Type - The is_meta_attribute of this GsaAttributeCreationException. - """ - return self._is_meta_attribute - - @is_meta_attribute.setter - def is_meta_attribute(self, is_meta_attribute: "bool | Unset_Type") -> None: - """Sets the is_meta_attribute of this GsaAttributeCreationException. - - Parameters - ---------- - is_meta_attribute: bool | Unset_Type - The is_meta_attribute of this GsaAttributeCreationException. - """ - # Field is not nullable - if is_meta_attribute is None: - raise ValueError("Invalid value for 'is_meta_attribute', must not be 'None'") - self._is_meta_attribute = is_meta_attribute - @property def errors(self) -> "list[GsaAttributeErrorDetail] | None | Unset_Type": """Gets the errors of this GsaAttributeCreationException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_deletion_exception.py index 7981d597..3590a700 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_deletion_exception.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaAttributeDeletionException(GsaDeletionException): +class GsaAttributeDeletionException(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,31 +61,28 @@ class GsaAttributeDeletionException(GsaDeletionException): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", "code": "code", "errors": "errors", "message": "message", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "code": "SystemNetHttpStatusCode", + "errors": "GsaDataModificationErrorDetail", + } discriminator: Optional[str] = None def __init__( self, *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.ATTRIBUTE, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -100,19 +90,89 @@ def __init__( Parameters ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) + self._message: str | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset + + if message is not Unset: + self.message = message + if code is not Unset: + self.code = code + if errors is not Unset: + self.errors = errors + + @property + def message(self) -> "str | None | Unset_Type": + """Gets the message of this GsaAttributeDeletionException. + + Returns + ------- + str | None | Unset_Type + The message of this GsaAttributeDeletionException. + """ + return self._message + + @message.setter + def message(self, message: "str | None | Unset_Type") -> None: + """Sets the message of this GsaAttributeDeletionException. + + Parameters + ---------- + message: str | None | Unset_Type + The message of this GsaAttributeDeletionException. + """ + self._message = message + + @property + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": + """Gets the code of this GsaAttributeDeletionException. + + Returns + ------- + SystemNetHttpStatusCode | Unset_Type + The code of this GsaAttributeDeletionException. + """ + return self._code + + @code.setter + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: + """Sets the code of this GsaAttributeDeletionException. + + Parameters + ---------- + code: SystemNetHttpStatusCode | Unset_Type + The code of this GsaAttributeDeletionException. + """ + # Field is not nullable + if code is None: + raise ValueError("Invalid value for 'code', must not be 'None'") + self._code = code + + @property + def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": + """Gets the errors of this GsaAttributeDeletionException. + + Returns + ------- + list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaAttributeDeletionException. + """ + return self._errors + + @errors.setter + def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: + """Sets the errors of this GsaAttributeDeletionException. + + Parameters + ---------- + errors: list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaAttributeDeletionException. + """ + self._errors = errors @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_discrete_type_mismatch_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_discrete_type_mismatch_error_detail.py deleted file mode 100644 index 5f898419..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_discrete_type_mismatch_error_detail.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeDiscreteTypeMismatchErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "actual_discrete_type_guid": "str", - "attribute_guid": "str", - "expected_discrete_type_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "actual_discrete_type_guid": "actualDiscreteTypeGuid", - "attribute_guid": "attributeGuid", - "expected_discrete_type_guid": "expectedDiscreteTypeGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - actual_discrete_type_guid: "str", - attribute_guid: "str", - expected_discrete_type_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.ATTRIBUTEDISCRETETYPEMISMATCH, - ) -> None: - """GsaAttributeDiscreteTypeMismatchErrorDetail - a model defined in Swagger - - Parameters - ---------- - actual_discrete_type_guid: str - attribute_guid: str - expected_discrete_type_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str - self._expected_discrete_type_guid: str - self._actual_discrete_type_guid: str - - self.attribute_guid = attribute_guid - self.expected_discrete_type_guid = expected_discrete_type_guid - self.actual_discrete_type_guid = actual_discrete_type_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def expected_discrete_type_guid(self) -> "str": - """Gets the expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Returns - ------- - str - The expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - return self._expected_discrete_type_guid - - @expected_discrete_type_guid.setter - def expected_discrete_type_guid(self, expected_discrete_type_guid: "str") -> None: - """Sets the expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Parameters - ---------- - expected_discrete_type_guid: str - The expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - # Field is not nullable - if expected_discrete_type_guid is None: - raise ValueError("Invalid value for 'expected_discrete_type_guid', must not be 'None'") - # Field is required - if expected_discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'expected_discrete_type_guid', must not be 'Unset'") - self._expected_discrete_type_guid = expected_discrete_type_guid - - @property - def actual_discrete_type_guid(self) -> "str": - """Gets the actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Returns - ------- - str - The actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - return self._actual_discrete_type_guid - - @actual_discrete_type_guid.setter - def actual_discrete_type_guid(self, actual_discrete_type_guid: "str") -> None: - """Sets the actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Parameters - ---------- - actual_discrete_type_guid: str - The actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - # Field is not nullable - if actual_discrete_type_guid is None: - raise ValueError("Invalid value for 'actual_discrete_type_guid', must not be 'None'") - # Field is required - if actual_discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'actual_discrete_type_guid', must not be 'Unset'") - self._actual_discrete_type_guid = actual_discrete_type_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeDiscreteTypeMismatchErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_detail.py index d544d05d..18f30336 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_detail.py @@ -78,7 +78,6 @@ class GsaAttributeErrorDetail(ModelBase): discriminator_value_class_map = { "aboutAttributeCannotBeMeta".lower(): "#/components/schemas/GsaAboutAttributeCannotBeMetaAttributeErrorDetail", - "attributeType".lower(): "#/components/schemas/GsaAttributeTypeAttributeErrorDetail", "duplicateParameterGuids".lower(): "#/components/schemas/GsaDuplicateParameterGuidsAttributeErrorDetail", "emptyAxisName".lower(): "#/components/schemas/GsaEmptyAxisNameAttributeErrorDetail", "funcNoParams".lower(): "#/components/schemas/GsaFuncNoParamsAttributeErrorDetail", @@ -95,16 +94,6 @@ class GsaAttributeErrorDetail(ModelBase): "tabularColumnNameNotProvided".lower(): "#/components/schemas/GsaTabularColumnNameNotProvidedErrorDetail", "duplicateTabularColumnNames".lower(): "#/components/schemas/GsaDuplicateTabularColumnNamesErrorDetail", "tabularColumnNoSuchEntity".lower(): "#/components/schemas/GsaNoSuchEntityTabularColumnErrorDetail", - "metaAttributeCannotHaveMetaAttribute".lower(): "#/components/schemas/GsaMetaAttributeCannotHaveMetaAttributeErrorDetail", - "multiValued".lower(): "#/components/schemas/GsaMultiValuedAttributeErrorDetail", - "targetNotFullySpecified".lower(): "#/components/schemas/GsaTargetNotFullySpecifiedAttributeErrorDetail", - "noSuchTabularColumn".lower(): "#/components/schemas/GsaNoSuchTabularColumnAttributeErrorDetail", - "updateTabularColumnPropertyNotProvided".lower(): "#/components/schemas/GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail", - "updateTabularColumnType".lower(): "#/components/schemas/GsaUpdateTabularColumnTypeAttributeErrorDetail", - "cannotDeleteTabularColumn".lower(): "#/components/schemas/GsaCannotDeleteTabularColumnAttributeErrorDetail", - "cannotCreateUnavailableTabularColumn".lower(): "#/components/schemas/GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail", - "cannotChangeDiscreteType".lower(): "#/components/schemas/GsaCannotChangeDiscreteTypeAttributeErrorDetail", - "cannotRemoveParameterInUse".lower(): "#/components/schemas/GsaCannotRemoveParameterInUseAttributeErrorDetail", } discriminator: Optional[str] = "reason" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_reason.py index 543b2fac..28ecd63a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_reason.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_error_reason.py @@ -43,8 +43,6 @@ class GsaAttributeErrorReason(Enum): Allowed Enum values """ ABOUTATTRIBUTECANNOTBEMETA = "aboutAttributeCannotBeMeta" - ATTRIBUTETYPE = "attributeType" - METAATTRIBUTECANNOTHAVEMETAATTRIBUTE = "metaAttributeCannotHaveMetaAttribute" DUPLICATEPARAMETERGUIDS = "duplicateParameterGuids" EMPTYAXISNAME = "emptyAxisName" FUNCNOPARAMS = "funcNoParams" @@ -61,12 +59,3 @@ class GsaAttributeErrorReason(Enum): TABULARCOLUMNNAMENOTPROVIDED = "tabularColumnNameNotProvided" DUPLICATETABULARCOLUMNNAMES = "duplicateTabularColumnNames" TABULARCOLUMNNOSUCHENTITY = "tabularColumnNoSuchEntity" - MULTIVALUED = "multiValued" - TARGETNOTFULLYSPECIFIED = "targetNotFullySpecified" - NOSUCHTABULARCOLUMN = "noSuchTabularColumn" - UPDATETABULARCOLUMNPROPERTYNOTPROVIDED = "updateTabularColumnPropertyNotProvided" - UPDATETABULARCOLUMNTYPE = "updateTabularColumnType" - CANNOTDELETETABULARCOLUMN = "cannotDeleteTabularColumn" - CANNOTCREATEUNAVAILABLETABULARCOLUMN = "cannotCreateUnavailableTabularColumn" - CANNOTCHANGEDISCRETETYPE = "cannotChangeDiscreteType" - CANNOTREMOVEPARAMETERINUSE = "cannotRemoveParameterInUse" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_info.py index 7ff5deb8..58e3f1d5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_info.py @@ -70,9 +70,9 @@ class GsaAttributeInfo(ModelBase): "primary_data_link_groups": "list[GsaSlimNamedEntity]", "standard_names": "list[GsaSlimNamedEntity]", "type_code": "str", - "foreign_smart_link_groups": "list[GsaSlimNamedEntity]", + "foreign_dynamic_link_groups": "list[GsaSlimNamedEntity]", "ordered_meta_attributes": "list[GsaSlimTypedAttribute]", - "primary_smart_link_groups": "list[GsaSlimNamedEntity]", + "primary_dynamic_link_groups": "list[GsaSlimNamedEntity]", } attribute_map: dict[str, str] = { @@ -85,9 +85,9 @@ class GsaAttributeInfo(ModelBase): "primary_data_link_groups": "primaryDataLinkGroups", "standard_names": "standardNames", "type_code": "typeCode", - "foreign_smart_link_groups": "foreignSmartLinkGroups", + "foreign_dynamic_link_groups": "foreignDynamicLinkGroups", "ordered_meta_attributes": "orderedMetaAttributes", - "primary_smart_link_groups": "primarySmartLinkGroups", + "primary_dynamic_link_groups": "primaryDynamicLinkGroups", } subtype_mapping: dict[str, str] = { @@ -95,8 +95,8 @@ class GsaAttributeInfo(ModelBase): "standardNames": "GsaSlimNamedEntity", "primaryDataLinkGroups": "GsaSlimNamedEntity", "foreignDataLinkGroups": "GsaSlimNamedEntity", - "primarySmartLinkGroups": "GsaSlimNamedEntity", - "foreignSmartLinkGroups": "GsaSlimNamedEntity", + "primaryDynamicLinkGroups": "GsaSlimNamedEntity", + "foreignDynamicLinkGroups": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -113,9 +113,9 @@ def __init__( primary_data_link_groups: "list[GsaSlimNamedEntity]", standard_names: "list[GsaSlimNamedEntity]", type_code: "str", - foreign_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, + foreign_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ordered_meta_attributes: "list[GsaSlimTypedAttribute] | None | Unset_Type" = Unset, - primary_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, + primary_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ) -> None: """GsaAttributeInfo - a model defined in Swagger @@ -130,9 +130,9 @@ def __init__( primary_data_link_groups: list[GsaSlimNamedEntity] standard_names: list[GsaSlimNamedEntity] type_code: str - foreign_smart_link_groups: list[GsaSlimNamedEntity] | None, optional + foreign_dynamic_link_groups: list[GsaSlimNamedEntity] | None, optional ordered_meta_attributes: list[GsaSlimTypedAttribute] | None, optional - primary_smart_link_groups: list[GsaSlimNamedEntity] | None, optional + primary_dynamic_link_groups: list[GsaSlimNamedEntity] | None, optional """ self._type_code: str self._chartable: bool @@ -144,8 +144,8 @@ def __init__( self._standard_names: list[GsaSlimNamedEntity] self._primary_data_link_groups: list[GsaSlimNamedEntity] self._foreign_data_link_groups: list[GsaSlimNamedEntity] - self._primary_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - self._foreign_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset + self._primary_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset + self._foreign_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset self.type_code = type_code self.chartable = chartable @@ -158,10 +158,10 @@ def __init__( self.standard_names = standard_names self.primary_data_link_groups = primary_data_link_groups self.foreign_data_link_groups = foreign_data_link_groups - if primary_smart_link_groups is not Unset: - self.primary_smart_link_groups = primary_smart_link_groups - if foreign_smart_link_groups is not Unset: - self.foreign_smart_link_groups = foreign_smart_link_groups + if primary_dynamic_link_groups is not Unset: + self.primary_dynamic_link_groups = primary_dynamic_link_groups + if foreign_dynamic_link_groups is not Unset: + self.foreign_dynamic_link_groups = foreign_dynamic_link_groups @property def type_code(self) -> "str": @@ -450,52 +450,52 @@ def foreign_data_link_groups( self._foreign_data_link_groups = foreign_data_link_groups @property - def primary_smart_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the primary_smart_link_groups of this GsaAttributeInfo. + def primary_dynamic_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + """Gets the primary_dynamic_link_groups of this GsaAttributeInfo. Returns ------- list[GsaSlimNamedEntity] | None | Unset_Type - The primary_smart_link_groups of this GsaAttributeInfo. + The primary_dynamic_link_groups of this GsaAttributeInfo. """ - return self._primary_smart_link_groups + return self._primary_dynamic_link_groups - @primary_smart_link_groups.setter - def primary_smart_link_groups( - self, primary_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" + @primary_dynamic_link_groups.setter + def primary_dynamic_link_groups( + self, primary_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" ) -> None: - """Sets the primary_smart_link_groups of this GsaAttributeInfo. + """Sets the primary_dynamic_link_groups of this GsaAttributeInfo. Parameters ---------- - primary_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type - The primary_smart_link_groups of this GsaAttributeInfo. + primary_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type + The primary_dynamic_link_groups of this GsaAttributeInfo. """ - self._primary_smart_link_groups = primary_smart_link_groups + self._primary_dynamic_link_groups = primary_dynamic_link_groups @property - def foreign_smart_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the foreign_smart_link_groups of this GsaAttributeInfo. + def foreign_dynamic_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + """Gets the foreign_dynamic_link_groups of this GsaAttributeInfo. Returns ------- list[GsaSlimNamedEntity] | None | Unset_Type - The foreign_smart_link_groups of this GsaAttributeInfo. + The foreign_dynamic_link_groups of this GsaAttributeInfo. """ - return self._foreign_smart_link_groups + return self._foreign_dynamic_link_groups - @foreign_smart_link_groups.setter - def foreign_smart_link_groups( - self, foreign_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" + @foreign_dynamic_link_groups.setter + def foreign_dynamic_link_groups( + self, foreign_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" ) -> None: - """Sets the foreign_smart_link_groups of this GsaAttributeInfo. + """Sets the foreign_dynamic_link_groups of this GsaAttributeInfo. Parameters ---------- - foreign_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type - The foreign_smart_link_groups of this GsaAttributeInfo. + foreign_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type + The foreign_dynamic_link_groups of this GsaAttributeInfo. """ - self._foreign_smart_link_groups = foreign_smart_link_groups + self._foreign_dynamic_link_groups = foreign_dynamic_link_groups @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_link_pair.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_link_pair.py index 83044b49..4a89faab 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_link_pair.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_link_pair.py @@ -61,8 +61,8 @@ class GsaAttributeLinkPair(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "attribute_source": "GsaTargetAttribute", - "attribute_target": "GsaTargetAttribute", + "attribute_source": "GsaSlimAttribute", + "attribute_target": "GsaSlimAttribute", } attribute_map: dict[str, str] = { @@ -71,8 +71,8 @@ class GsaAttributeLinkPair(ModelBase): } subtype_mapping: dict[str, str] = { - "attributeSource": "GsaTargetAttribute", - "attributeTarget": "GsaTargetAttribute", + "attributeSource": "GsaSlimAttribute", + "attributeTarget": "GsaSlimAttribute", } discriminator: Optional[str] = None @@ -80,76 +80,72 @@ class GsaAttributeLinkPair(ModelBase): def __init__( self, *, - attribute_source: "GsaTargetAttribute", - attribute_target: "GsaTargetAttribute", + attribute_source: "GsaSlimAttribute | Unset_Type" = Unset, + attribute_target: "GsaSlimAttribute | Unset_Type" = Unset, ) -> None: """GsaAttributeLinkPair - a model defined in Swagger Parameters ---------- - attribute_source: GsaTargetAttribute - attribute_target: GsaTargetAttribute + attribute_source: GsaSlimAttribute, optional + attribute_target: GsaSlimAttribute, optional """ - self._attribute_source: GsaTargetAttribute - self._attribute_target: GsaTargetAttribute + self._attribute_source: GsaSlimAttribute | Unset_Type = Unset + self._attribute_target: GsaSlimAttribute | Unset_Type = Unset - self.attribute_source = attribute_source - self.attribute_target = attribute_target + if attribute_source is not Unset: + self.attribute_source = attribute_source + if attribute_target is not Unset: + self.attribute_target = attribute_target @property - def attribute_source(self) -> "GsaTargetAttribute": + def attribute_source(self) -> "GsaSlimAttribute | Unset_Type": """Gets the attribute_source of this GsaAttributeLinkPair. Returns ------- - GsaTargetAttribute + GsaSlimAttribute | Unset_Type The attribute_source of this GsaAttributeLinkPair. """ return self._attribute_source @attribute_source.setter - def attribute_source(self, attribute_source: "GsaTargetAttribute") -> None: + def attribute_source(self, attribute_source: "GsaSlimAttribute | Unset_Type") -> None: """Sets the attribute_source of this GsaAttributeLinkPair. Parameters ---------- - attribute_source: GsaTargetAttribute + attribute_source: GsaSlimAttribute | Unset_Type The attribute_source of this GsaAttributeLinkPair. """ # Field is not nullable if attribute_source is None: raise ValueError("Invalid value for 'attribute_source', must not be 'None'") - # Field is required - if attribute_source is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_source', must not be 'Unset'") self._attribute_source = attribute_source @property - def attribute_target(self) -> "GsaTargetAttribute": + def attribute_target(self) -> "GsaSlimAttribute | Unset_Type": """Gets the attribute_target of this GsaAttributeLinkPair. Returns ------- - GsaTargetAttribute + GsaSlimAttribute | Unset_Type The attribute_target of this GsaAttributeLinkPair. """ return self._attribute_target @attribute_target.setter - def attribute_target(self, attribute_target: "GsaTargetAttribute") -> None: + def attribute_target(self, attribute_target: "GsaSlimAttribute | Unset_Type") -> None: """Sets the attribute_target of this GsaAttributeLinkPair. Parameters ---------- - attribute_target: GsaTargetAttribute + attribute_target: GsaSlimAttribute | Unset_Type The attribute_target of this GsaAttributeLinkPair. """ # Field is not nullable if attribute_target is None: raise ValueError("Invalid value for 'attribute_target', must not be 'None'") - # Field is required - if attribute_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_target', must not be 'Unset'") self._attribute_target = attribute_target @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_no_such_entity_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_no_such_entity_type.py index b1511170..ffde62bb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_no_such_entity_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_no_such_entity_type.py @@ -46,4 +46,3 @@ class GsaAttributeNoSuchEntityType(Enum): DISCRETETYPE = "discreteType" PARAMETER = "parameter" UNIT = "unit" - ABOUTATTRIBUTE = "aboutAttribute" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_not_on_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_not_on_table_error_detail.py deleted file mode 100644 index 3d109055..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_not_on_table_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeNotOnTableErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.ATTRIBUTENOTONTABLE, - table_guid: "str", - ) -> None: - """GsaAttributeNotOnTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str - self._table_guid: str - - self.attribute_guid = attribute_guid - self.table_guid = table_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeNotOnTableErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeNotOnTableErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeNotOnTableErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeNotOnTableErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaAttributeNotOnTableErrorDetail. - - Returns - ------- - str - The table_guid of this GsaAttributeNotOnTableErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaAttributeNotOnTableErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaAttributeNotOnTableErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeNotOnTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail.py deleted file mode 100644 index fc9a5baf..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "source_attribute_guid": "str", - "target_attribute_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "source_attribute_guid": "sourceAttributeGuid", - "target_attribute_guid": "targetAttributeGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTEPAIRDISCRETETYPEMISMATCH, - source_attribute_guid: "str", - target_attribute_guid: "str", - ) -> None: - """GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - source_attribute_guid: str - target_attribute_guid: str - """ - super().__init__(message=message, reason=reason) - self._source_attribute_guid: str - self._target_attribute_guid: str - - self.source_attribute_guid = source_attribute_guid - self.target_attribute_guid = target_attribute_guid - - @property - def source_attribute_guid(self) -> "str": - """Gets the source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - return self._source_attribute_guid - - @source_attribute_guid.setter - def source_attribute_guid(self, source_attribute_guid: "str") -> None: - """Sets the source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - source_attribute_guid: str - The source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if source_attribute_guid is None: - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'None'") - # Field is required - if source_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'Unset'") - self._source_attribute_guid = source_attribute_guid - - @property - def target_attribute_guid(self) -> "str": - """Gets the target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - return self._target_attribute_guid - - @target_attribute_guid.setter - def target_attribute_guid(self, target_attribute_guid: "str") -> None: - """Sets the target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - target_attribute_guid: str - The target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if target_attribute_guid is None: - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'None'") - # Field is required - if target_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'Unset'") - self._target_attribute_guid = target_attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_type_mismatch_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_type_mismatch_smart_attributes_error_detail.py deleted file mode 100644 index 156def9a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_pair_type_mismatch_smart_attributes_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributePairTypeMismatchSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "source_attribute_guid": "str", - "target_attribute_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "source_attribute_guid": "sourceAttributeGuid", - "target_attribute_guid": "targetAttributeGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTEPAIRTYPEMISMATCH, - source_attribute_guid: "str", - target_attribute_guid: "str", - ) -> None: - """GsaAttributePairTypeMismatchSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - source_attribute_guid: str - target_attribute_guid: str - """ - super().__init__(message=message, reason=reason) - self._source_attribute_guid: str - self._target_attribute_guid: str - - self.source_attribute_guid = source_attribute_guid - self.target_attribute_guid = target_attribute_guid - - @property - def source_attribute_guid(self) -> "str": - """Gets the source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - return self._source_attribute_guid - - @source_attribute_guid.setter - def source_attribute_guid(self, source_attribute_guid: "str") -> None: - """Sets the source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - source_attribute_guid: str - The source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if source_attribute_guid is None: - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'None'") - # Field is required - if source_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'Unset'") - self._source_attribute_guid = source_attribute_guid - - @property - def target_attribute_guid(self) -> "str": - """Gets the target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - return self._target_attribute_guid - - @target_attribute_guid.setter - def target_attribute_guid(self, target_attribute_guid: "str") -> None: - """Sets the target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - target_attribute_guid: str - The target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if target_attribute_guid is None: - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'None'") - # Field is required - if target_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'Unset'") - self._target_attribute_guid = target_attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributePairTypeMismatchSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_attribute_error_detail.py deleted file mode 100644 index 75d982aa..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_attribute_error_detail.py +++ /dev/null @@ -1,198 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeTypeAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "existing_attribute_type": "GsaAttributeType", - "new_attribute_type": "GsaAttributeType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "existing_attribute_type": "existingAttributeType", - "new_attribute_type": "newAttributeType", - } - - subtype_mapping: dict[str, str] = { - "newAttributeType": "GsaAttributeType", - "existingAttributeType": "GsaAttributeType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.ATTRIBUTETYPE, - existing_attribute_type: "GsaAttributeType | Unset_Type" = Unset, - new_attribute_type: "GsaAttributeType | Unset_Type" = Unset, - ) -> None: - """GsaAttributeTypeAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - existing_attribute_type: GsaAttributeType, optional - new_attribute_type: GsaAttributeType, optional - """ - super().__init__(message=message, reason=reason) - self._new_attribute_type: GsaAttributeType | Unset_Type = Unset - self._existing_attribute_type: GsaAttributeType | Unset_Type = Unset - - if new_attribute_type is not Unset: - self.new_attribute_type = new_attribute_type - if existing_attribute_type is not Unset: - self.existing_attribute_type = existing_attribute_type - - @property - def new_attribute_type(self) -> "GsaAttributeType | Unset_Type": - """Gets the new_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - - Returns - ------- - GsaAttributeType | Unset_Type - The new_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - """ - return self._new_attribute_type - - @new_attribute_type.setter - def new_attribute_type(self, new_attribute_type: "GsaAttributeType | Unset_Type") -> None: - """Sets the new_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - - Parameters - ---------- - new_attribute_type: GsaAttributeType | Unset_Type - The new_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - """ - # Field is not nullable - if new_attribute_type is None: - raise ValueError("Invalid value for 'new_attribute_type', must not be 'None'") - self._new_attribute_type = new_attribute_type - - @property - def existing_attribute_type(self) -> "GsaAttributeType | Unset_Type": - """Gets the existing_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - - Returns - ------- - GsaAttributeType | Unset_Type - The existing_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - """ - return self._existing_attribute_type - - @existing_attribute_type.setter - def existing_attribute_type( - self, existing_attribute_type: "GsaAttributeType | Unset_Type" - ) -> None: - """Sets the existing_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - - Parameters - ---------- - existing_attribute_type: GsaAttributeType | Unset_Type - The existing_attribute_type of this GsaAttributeTypeAttributeErrorDetail. - """ - # Field is not nullable - if existing_attribute_type is None: - raise ValueError("Invalid value for 'existing_attribute_type', must not be 'None'") - self._existing_attribute_type = existing_attribute_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeTypeAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_not_supported_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_not_supported_smart_attributes_error_detail.py deleted file mode 100644 index 2fe29ab8..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_type_not_supported_smart_attributes_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeTypeNotSupportedSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "attribute_type": "GsaAttributeType", - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "attribute_type": "attributeType", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "attributeType": "GsaAttributeType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - attribute_type: "GsaAttributeType", - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTETYPENOTSUPPORTED, - ) -> None: - """GsaAttributeTypeNotSupportedSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - attribute_type: GsaAttributeType - message: str - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str - self._attribute_type: GsaAttributeType - - self.attribute_guid = attribute_guid - self.attribute_type = attribute_type - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def attribute_type(self) -> "GsaAttributeType": - """Gets the attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Returns - ------- - GsaAttributeType - The attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - return self._attribute_type - - @attribute_type.setter - def attribute_type(self, attribute_type: "GsaAttributeType") -> None: - """Sets the attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_type: GsaAttributeType - The attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_type is None: - raise ValueError("Invalid value for 'attribute_type', must not be 'None'") - # Field is required - if attribute_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_type', must not be 'Unset'") - self._attribute_type = attribute_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeTypeNotSupportedSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_update_exception.py deleted file mode 100644 index d01ba466..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_attribute_update_exception.py +++ /dev/null @@ -1,270 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaAttributeErrorDetail]", - "is_meta_attribute": "bool", - "message": "str", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "code": "code", - "errors": "errors", - "is_meta_attribute": "isMetaAttribute", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaAttributeErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str | Unset_Type" = Unset, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaAttributeErrorDetail] | None | Unset_Type" = Unset, - is_meta_attribute: "bool | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaAttributeUpdateException - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str, optional - code: GsaErrorCode, optional - errors: list[GsaAttributeErrorDetail] | None, optional - is_meta_attribute: bool, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._attribute_guid: str | Unset_Type = Unset - self._is_meta_attribute: bool | Unset_Type = Unset - self._errors: list[GsaAttributeErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if attribute_guid is not Unset: - self.attribute_guid = attribute_guid - if is_meta_attribute is not Unset: - self.is_meta_attribute = is_meta_attribute - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaAttributeUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaAttributeUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaAttributeUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaAttributeUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaAttributeUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaAttributeUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaAttributeUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaAttributeUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def attribute_guid(self) -> "str | Unset_Type": - """Gets the attribute_guid of this GsaAttributeUpdateException. - - Returns - ------- - str | Unset_Type - The attribute_guid of this GsaAttributeUpdateException. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str | Unset_Type") -> None: - """Sets the attribute_guid of this GsaAttributeUpdateException. - - Parameters - ---------- - attribute_guid: str | Unset_Type - The attribute_guid of this GsaAttributeUpdateException. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - self._attribute_guid = attribute_guid - - @property - def is_meta_attribute(self) -> "bool | Unset_Type": - """Gets the is_meta_attribute of this GsaAttributeUpdateException. - - Returns - ------- - bool | Unset_Type - The is_meta_attribute of this GsaAttributeUpdateException. - """ - return self._is_meta_attribute - - @is_meta_attribute.setter - def is_meta_attribute(self, is_meta_attribute: "bool | Unset_Type") -> None: - """Sets the is_meta_attribute of this GsaAttributeUpdateException. - - Parameters - ---------- - is_meta_attribute: bool | Unset_Type - The is_meta_attribute of this GsaAttributeUpdateException. - """ - # Field is not nullable - if is_meta_attribute is None: - raise ValueError("Invalid value for 'is_meta_attribute', must not be 'None'") - self._is_meta_attribute = is_meta_attribute - - @property - def errors(self) -> "list[GsaAttributeErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaAttributeUpdateException. - - Returns - ------- - list[GsaAttributeErrorDetail] | None | Unset_Type - The errors of this GsaAttributeUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaAttributeErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaAttributeUpdateException. - - Parameters - ---------- - errors: list[GsaAttributeErrorDetail] | None | Unset_Type - The errors of this GsaAttributeUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_blob_info_dto.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_blob_info_dto.py deleted file mode 100644 index ae076480..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_blob_info_dto.py +++ /dev/null @@ -1,257 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaBlobInfoDto(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "full_path": "str", - "last_write_time_utc": "datetime", - "length": "int", - "name": "str", - } - - attribute_map: dict[str, str] = { - "full_path": "fullPath", - "last_write_time_utc": "lastWriteTimeUtc", - "length": "length", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - full_path: "str", - last_write_time_utc: "datetime", - length: "int", - name: "str", - ) -> None: - """GsaBlobInfoDto - a model defined in Swagger - - Parameters - ---------- - full_path: str - last_write_time_utc: datetime - length: int - name: str - """ - self._name: str - self._full_path: str - self._length: int - self._last_write_time_utc: datetime - - self.name = name - self.full_path = full_path - self.length = length - self.last_write_time_utc = last_write_time_utc - - @property - def name(self) -> "str": - """Gets the name of this GsaBlobInfoDto. - Name of the blob. - - Returns - ------- - str - The name of this GsaBlobInfoDto. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaBlobInfoDto. - Name of the blob. - - Parameters - ---------- - name: str - The name of this GsaBlobInfoDto. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def full_path(self) -> "str": - """Gets the full_path of this GsaBlobInfoDto. - Full path of the blob. Path segments are separated by '/' The last segment is always blob name. - - Returns - ------- - str - The full_path of this GsaBlobInfoDto. - """ - return self._full_path - - @full_path.setter - def full_path(self, full_path: "str") -> None: - """Sets the full_path of this GsaBlobInfoDto. - Full path of the blob. Path segments are separated by '/' The last segment is always blob name. - - Parameters - ---------- - full_path: str - The full_path of this GsaBlobInfoDto. - """ - # Field is not nullable - if full_path is None: - raise ValueError("Invalid value for 'full_path', must not be 'None'") - # Field is required - if full_path is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'full_path', must not be 'Unset'") - self._full_path = full_path - - @property - def length(self) -> "int": - """Gets the length of this GsaBlobInfoDto. - Blob size in bytes. - - Returns - ------- - int - The length of this GsaBlobInfoDto. - """ - return self._length - - @length.setter - def length(self, length: "int") -> None: - """Sets the length of this GsaBlobInfoDto. - Blob size in bytes. - - Parameters - ---------- - length: int - The length of this GsaBlobInfoDto. - """ - # Field is not nullable - if length is None: - raise ValueError("Invalid value for 'length', must not be 'None'") - # Field is required - if length is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'length', must not be 'Unset'") - self._length = length - - @property - def last_write_time_utc(self) -> "datetime": - """Gets the last_write_time_utc of this GsaBlobInfoDto. - Last modification date. - - Returns - ------- - datetime - The last_write_time_utc of this GsaBlobInfoDto. - """ - return self._last_write_time_utc - - @last_write_time_utc.setter - def last_write_time_utc(self, last_write_time_utc: "datetime") -> None: - """Sets the last_write_time_utc of this GsaBlobInfoDto. - Last modification date. - - Parameters - ---------- - last_write_time_utc: datetime - The last_write_time_utc of this GsaBlobInfoDto. - """ - # Field is not nullable - if last_write_time_utc is None: - raise ValueError("Invalid value for 'last_write_time_utc', must not be 'None'") - # Field is required - if last_write_time_utc is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'last_write_time_utc', must not be 'Unset'") - self._last_write_time_utc = last_write_time_utc - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaBlobInfoDto): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_bracket_mismatch_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_bracket_mismatch_unit_equation_error_detail.py deleted file mode 100644 index 7a69c398..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_bracket_mismatch_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaBracketMismatchUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.BRACKETMISMATCH, - ) -> None: - """GsaBracketMismatchUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaBracketMismatchUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb.py deleted file mode 100644 index ef05241d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaBreadcrumb(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "breadcrumb_type": "GsaBreadcrumbType", - } - - attribute_map: dict[str, str] = { - "breadcrumb_type": "breadcrumbType", - } - - subtype_mapping: dict[str, str] = { - "breadcrumbType": "GsaBreadcrumbType", - } - - discriminator_value_class_map = { - "resolved".lower(): "#/components/schemas/GsaResolvedBreadcrumb", - "unresolved".lower(): "#/components/schemas/GsaUnresolvedBreadcrumb", - } - - discriminator: Optional[str] = "breadcrumbType" - - def __init__( - self, - *, - breadcrumb_type: "GsaBreadcrumbType", - ) -> None: - """GsaBreadcrumb - a model defined in Swagger - - Parameters - ---------- - breadcrumb_type: GsaBreadcrumbType - """ - self._breadcrumb_type: GsaBreadcrumbType - - self.breadcrumb_type = breadcrumb_type - - @property - def breadcrumb_type(self) -> "GsaBreadcrumbType": - """Gets the breadcrumb_type of this GsaBreadcrumb. - - Returns - ------- - GsaBreadcrumbType - The breadcrumb_type of this GsaBreadcrumb. - """ - return self._breadcrumb_type - - @breadcrumb_type.setter - def breadcrumb_type(self, breadcrumb_type: "GsaBreadcrumbType") -> None: - """Sets the breadcrumb_type of this GsaBreadcrumb. - - Parameters - ---------- - breadcrumb_type: GsaBreadcrumbType - The breadcrumb_type of this GsaBreadcrumb. - """ - # Field is not nullable - if breadcrumb_type is None: - raise ValueError("Invalid value for 'breadcrumb_type', must not be 'None'") - # Field is required - if breadcrumb_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'breadcrumb_type', must not be 'Unset'") - self._breadcrumb_type = breadcrumb_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaBreadcrumb): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb_type.py deleted file mode 100644 index 400aba7a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumb_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaBreadcrumbType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - RESOLVED = "resolved" - UNRESOLVED = "unresolved" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumbs_property.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumbs_property.py deleted file mode 100644 index 9e68445e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_breadcrumbs_property.py +++ /dev/null @@ -1,157 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_property import GsaProperty # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_property import GsaRecordProperty - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaBreadcrumbsProperty(GsaProperty): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "breadcrumbs": "list[GsaBreadcrumb]", - "property_name": "GsaRecordProperty", - } - - attribute_map: dict[str, str] = { - "breadcrumbs": "breadcrumbs", - "property_name": "propertyName", - } - - subtype_mapping: dict[str, str] = { - "breadcrumbs": "GsaBreadcrumb", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - breadcrumbs: "list[GsaBreadcrumb]", - property_name: "GsaRecordProperty" = GsaRecordProperty.BREADCRUMBS, - ) -> None: - """GsaBreadcrumbsProperty - a model defined in Swagger - - Parameters - ---------- - breadcrumbs: list[GsaBreadcrumb] - property_name: GsaRecordProperty - """ - super().__init__(property_name=property_name) - self._breadcrumbs: list[GsaBreadcrumb] - - self.breadcrumbs = breadcrumbs - - @property - def breadcrumbs(self) -> "list[GsaBreadcrumb]": - """Gets the breadcrumbs of this GsaBreadcrumbsProperty. - - Returns - ------- - list[GsaBreadcrumb] - The breadcrumbs of this GsaBreadcrumbsProperty. - """ - return self._breadcrumbs - - @breadcrumbs.setter - def breadcrumbs(self, breadcrumbs: "list[GsaBreadcrumb]") -> None: - """Sets the breadcrumbs of this GsaBreadcrumbsProperty. - - Parameters - ---------- - breadcrumbs: list[GsaBreadcrumb] - The breadcrumbs of this GsaBreadcrumbsProperty. - """ - # Field is not nullable - if breadcrumbs is None: - raise ValueError("Invalid value for 'breadcrumbs', must not be 'None'") - # Field is required - if breadcrumbs is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'breadcrumbs', must not be 'Unset'") - self._breadcrumbs = breadcrumbs - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaBreadcrumbsProperty): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_change_discrete_type_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_change_discrete_type_attribute_error_detail.py deleted file mode 100644 index 99405af0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_change_discrete_type_attribute_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCannotChangeDiscreteTypeAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "column_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "column_guid": "columnGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.CANNOTCHANGEDISCRETETYPE, - column_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaCannotChangeDiscreteTypeAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - column_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._column_guid: str | Unset_Type = Unset - - if column_guid is not Unset: - self.column_guid = column_guid - - @property - def column_guid(self) -> "str | Unset_Type": - """Gets the column_guid of this GsaCannotChangeDiscreteTypeAttributeErrorDetail. - - Returns - ------- - str | Unset_Type - The column_guid of this GsaCannotChangeDiscreteTypeAttributeErrorDetail. - """ - return self._column_guid - - @column_guid.setter - def column_guid(self, column_guid: "str | Unset_Type") -> None: - """Sets the column_guid of this GsaCannotChangeDiscreteTypeAttributeErrorDetail. - - Parameters - ---------- - column_guid: str | Unset_Type - The column_guid of this GsaCannotChangeDiscreteTypeAttributeErrorDetail. - """ - # Field is not nullable - if column_guid is None: - raise ValueError("Invalid value for 'column_guid', must not be 'None'") - self._column_guid = column_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCannotChangeDiscreteTypeAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_create_unavailable_tabular_column_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_create_unavailable_tabular_column_attribute_error_detail.py deleted file mode 100644 index 7cd9e40d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_create_unavailable_tabular_column_attribute_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.CANNOTCREATEUNAVAILABLETABULARCOLUMN, - ) -> None: - """GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCannotCreateUnavailableTabularColumnAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_delete_tabular_column_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_delete_tabular_column_attribute_error_detail.py deleted file mode 100644 index ddd436b7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_delete_tabular_column_attribute_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCannotDeleteTabularColumnAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "column_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "column_guid": "columnGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.CANNOTDELETETABULARCOLUMN, - column_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaCannotDeleteTabularColumnAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - column_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._column_guid: str | Unset_Type = Unset - - if column_guid is not Unset: - self.column_guid = column_guid - - @property - def column_guid(self) -> "str | Unset_Type": - """Gets the column_guid of this GsaCannotDeleteTabularColumnAttributeErrorDetail. - - Returns - ------- - str | Unset_Type - The column_guid of this GsaCannotDeleteTabularColumnAttributeErrorDetail. - """ - return self._column_guid - - @column_guid.setter - def column_guid(self, column_guid: "str | Unset_Type") -> None: - """Sets the column_guid of this GsaCannotDeleteTabularColumnAttributeErrorDetail. - - Parameters - ---------- - column_guid: str | Unset_Type - The column_guid of this GsaCannotDeleteTabularColumnAttributeErrorDetail. - """ - # Field is not nullable - if column_guid is None: - raise ValueError("Invalid value for 'column_guid', must not be 'None'") - self._column_guid = column_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCannotDeleteTabularColumnAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_remove_parameter_in_use_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_remove_parameter_in_use_attribute_error_detail.py deleted file mode 100644 index 2192ed9a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cannot_remove_parameter_in_use_attribute_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCannotRemoveParameterInUseAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "parameter_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "parameter_guid": "parameterGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.CANNOTREMOVEPARAMETERINUSE, - parameter_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaCannotRemoveParameterInUseAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - parameter_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._parameter_guid: str | Unset_Type = Unset - - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid - - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaCannotRemoveParameterInUseAttributeErrorDetail. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaCannotRemoveParameterInUseAttributeErrorDetail. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaCannotRemoveParameterInUseAttributeErrorDetail. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaCannotRemoveParameterInUseAttributeErrorDetail. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCannotRemoveParameterInUseAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_category_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_category_replace_permission_category_error_detail.py deleted file mode 100644 index b5d8a55b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_category_replace_permission_category_error_detail.py +++ /dev/null @@ -1,223 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCategoryReplacePermissionCategoryErrorDetail(GsaReplacePermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaPermissionCategoryErrorDetail]", - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - "guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaPermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaPermissionCategoryErrorDetail]", - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.CATEGORY, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCategoryReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaPermissionCategoryErrorDetail] - message: str - reason: GsaReplacePermissionCategoryErrorReason - guid: str | None, optional - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - self._errors: list[GsaPermissionCategoryErrorDetail] - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - self.errors = errors - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionCategoryErrorDetail]": - """Gets the errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[GsaPermissionCategoryErrorDetail] - The errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionCategoryErrorDetail]") -> None: - """Sets the errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - errors: list[GsaPermissionCategoryErrorDetail] - The errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCategoryReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data.py deleted file mode 100644 index 21882cd1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaChartData(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "record_version_guid": "str", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "record_version_guid": "recordVersionGuid", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaChartDataType", - "bubbleAxisValue": "GsaDataExportRange", - } - - discriminator_value_class_map = { - "point".lower(): "#/components/schemas/GsaPointChartData", - "integer".lower(): "#/components/schemas/GsaIntegerChartData", - "range".lower(): "#/components/schemas/GsaRangeChartData", - "logical".lower(): "#/components/schemas/GsaLogicalChartData", - "discrete".lower(): "#/components/schemas/GsaDiscreteChartData", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaChartDataType", - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - record_version_guid: str, optional - """ - self._type: GsaChartDataType - self._record_version_guid: str | Unset_Type = Unset - self._bubble_axis_value: GsaDataExportRange | Unset_Type = Unset - - self.type = type - if record_version_guid is not Unset: - self.record_version_guid = record_version_guid - if bubble_axis_value is not Unset: - self.bubble_axis_value = bubble_axis_value - - @property - def type(self) -> "GsaChartDataType": - """Gets the type of this GsaChartData. - - Returns - ------- - GsaChartDataType - The type of this GsaChartData. - """ - return self._type - - @type.setter - def type(self, type: "GsaChartDataType") -> None: - """Sets the type of this GsaChartData. - - Parameters - ---------- - type: GsaChartDataType - The type of this GsaChartData. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def record_version_guid(self) -> "str | Unset_Type": - """Gets the record_version_guid of this GsaChartData. - The record version associated with this chart data. - - Returns - ------- - str | Unset_Type - The record_version_guid of this GsaChartData. - """ - return self._record_version_guid - - @record_version_guid.setter - def record_version_guid(self, record_version_guid: "str | Unset_Type") -> None: - """Sets the record_version_guid of this GsaChartData. - The record version associated with this chart data. - - Parameters - ---------- - record_version_guid: str | Unset_Type - The record_version_guid of this GsaChartData. - """ - # Field is not nullable - if record_version_guid is None: - raise ValueError("Invalid value for 'record_version_guid', must not be 'None'") - self._record_version_guid = record_version_guid - - @property - def bubble_axis_value(self) -> "GsaDataExportRange | Unset_Type": - """Gets the bubble_axis_value of this GsaChartData. - - Returns - ------- - GsaDataExportRange | Unset_Type - The bubble_axis_value of this GsaChartData. - """ - return self._bubble_axis_value - - @bubble_axis_value.setter - def bubble_axis_value(self, bubble_axis_value: "GsaDataExportRange | Unset_Type") -> None: - """Sets the bubble_axis_value of this GsaChartData. - - Parameters - ---------- - bubble_axis_value: GsaDataExportRange | Unset_Type - The bubble_axis_value of this GsaChartData. - """ - # Field is not nullable - if bubble_axis_value is None: - raise ValueError("Invalid value for 'bubble_axis_value', must not be 'None'") - self._bubble_axis_value = bubble_axis_value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data_type.py deleted file mode 100644 index b3dfec60..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_chart_data_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaChartDataType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - INTEGER = "integer" - POINT = "point" - RANGE = "range" - LOGICAL = "logical" - DISCRETE = "discrete" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_circular_reference_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_circular_reference_folder_move_error_detail.py deleted file mode 100644 index 005fdfcd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_circular_reference_folder_move_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCircularReferenceFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.CIRCULARREFERENCE, - ) -> None: - """GsaCircularReferenceFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCircularReferenceFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_missing_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_missing_currency_error_detail.py deleted file mode 100644 index 10c482db..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_missing_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCodeMissingCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.CODEMISSING, - ) -> None: - """GsaCodeMissingCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCodeMissingCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_whitespace_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_whitespace_currency_error_detail.py deleted file mode 100644 index 50aa0977..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_code_whitespace_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCodeWhitespaceCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "currency_code": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "currency_code": "currencyCode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.CODEWHITESPACE, - currency_code: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCodeWhitespaceCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - currency_code: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._currency_code: str | None | Unset_Type = Unset - - if currency_code is not Unset: - self.currency_code = currency_code - - @property - def currency_code(self) -> "str | None | Unset_Type": - """Gets the currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - """ - return self._currency_code - - @currency_code.setter - def currency_code(self, currency_code: "str | None | Unset_Type") -> None: - """Sets the currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - - Parameters - ---------- - currency_code: str | None | Unset_Type - The currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - """ - self._currency_code = currency_code - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCodeWhitespaceCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_config_invalid_json_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_config_invalid_json_file_error_detail.py deleted file mode 100644 index 02024f9a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_config_invalid_json_file_error_detail.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConfigInvalidJsonFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.CONFIGINVALIDJSON, - ) -> None: - """GsaConfigInvalidJsonFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConfigInvalidJsonFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_configuration_details.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_configuration_details.py deleted file mode 100644 index 64c941aa..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_configuration_details.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConfigurationDetails(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "connection_details": "GsaConnectionDetails", - "language": "str", - } - - attribute_map: dict[str, str] = { - "connection_details": "connectionDetails", - "language": "language", - } - - subtype_mapping: dict[str, str] = { - "connectionDetails": "GsaConnectionDetails", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - connection_details: "GsaConnectionDetails", - language: "str", - ) -> None: - """GsaConfigurationDetails - a model defined in Swagger - - Parameters - ---------- - connection_details: GsaConnectionDetails - language: str - """ - self._language: str - self._connection_details: GsaConnectionDetails - - self.language = language - self.connection_details = connection_details - - @property - def language(self) -> "str": - """Gets the language of this GsaConfigurationDetails. - - Returns - ------- - str - The language of this GsaConfigurationDetails. - """ - return self._language - - @language.setter - def language(self, language: "str") -> None: - """Sets the language of this GsaConfigurationDetails. - - Parameters - ---------- - language: str - The language of this GsaConfigurationDetails. - """ - # Field is not nullable - if language is None: - raise ValueError("Invalid value for 'language', must not be 'None'") - # Field is required - if language is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'language', must not be 'Unset'") - self._language = language - - @property - def connection_details(self) -> "GsaConnectionDetails": - """Gets the connection_details of this GsaConfigurationDetails. - - Returns - ------- - GsaConnectionDetails - The connection_details of this GsaConfigurationDetails. - """ - return self._connection_details - - @connection_details.setter - def connection_details(self, connection_details: "GsaConnectionDetails") -> None: - """Sets the connection_details of this GsaConfigurationDetails. - - Parameters - ---------- - connection_details: GsaConnectionDetails - The connection_details of this GsaConfigurationDetails. - """ - # Field is not nullable - if connection_details is None: - raise ValueError("Invalid value for 'connection_details', must not be 'None'") - # Field is required - if connection_details is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'connection_details', must not be 'Unset'") - self._connection_details = connection_details - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConfigurationDetails): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_connection_details.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_connection_details.py index bdc1f7a4..4e073e31 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_connection_details.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_connection_details.py @@ -64,8 +64,8 @@ class GsaConnectionDetails(ModelBase): "data_source": "str", "initial_catalog": "str", "additional_sql_parameters": "str", + "sql_password": "str", "sql_username": "str", - "use_configuration_database_credentials": "bool", "use_integrated_security": "bool", } @@ -73,8 +73,8 @@ class GsaConnectionDetails(ModelBase): "data_source": "dataSource", "initial_catalog": "initialCatalog", "additional_sql_parameters": "additionalSqlParameters", + "sql_password": "sqlPassword", "sql_username": "sqlUsername", - "use_configuration_database_credentials": "useConfigurationDatabaseCredentials", "use_integrated_security": "useIntegratedSecurity", } @@ -88,9 +88,9 @@ def __init__( data_source: "str", initial_catalog: "str", additional_sql_parameters: "str | None | Unset_Type" = Unset, + sql_password: "str | None | Unset_Type" = Unset, sql_username: "str | None | Unset_Type" = Unset, - use_configuration_database_credentials: "bool | Unset_Type" = Unset, - use_integrated_security: "bool | Unset_Type" = Unset, + use_integrated_security: "bool | None | Unset_Type" = Unset, ) -> None: """GsaConnectionDetails - a model defined in Swagger @@ -99,25 +99,25 @@ def __init__( data_source: str initial_catalog: str additional_sql_parameters: str | None, optional + sql_password: str | None, optional sql_username: str | None, optional - use_configuration_database_credentials: bool, optional - use_integrated_security: bool, optional + use_integrated_security: bool | None, optional """ self._data_source: str - self._initial_catalog: str - self._use_configuration_database_credentials: bool | Unset_Type = Unset - self._use_integrated_security: bool | Unset_Type = Unset + self._use_integrated_security: bool | None | Unset_Type = Unset self._sql_username: str | None | Unset_Type = Unset + self._sql_password: str | None | Unset_Type = Unset + self._initial_catalog: str self._additional_sql_parameters: str | None | Unset_Type = Unset self.data_source = data_source - self.initial_catalog = initial_catalog - if use_configuration_database_credentials is not Unset: - self.use_configuration_database_credentials = use_configuration_database_credentials if use_integrated_security is not Unset: self.use_integrated_security = use_integrated_security if sql_username is not Unset: self.sql_username = sql_username + if sql_password is not Unset: + self.sql_password = sql_password + self.initial_catalog = initial_catalog if additional_sql_parameters is not Unset: self.additional_sql_parameters = additional_sql_parameters @@ -152,121 +152,111 @@ def data_source(self, data_source: "str") -> None: self._data_source = data_source @property - def initial_catalog(self) -> "str": - """Gets the initial_catalog of this GsaConnectionDetails. - The name of the database in SQL server + def use_integrated_security(self) -> "bool | None | Unset_Type": + """Gets the use_integrated_security of this GsaConnectionDetails. + Set to true if the SQL connection to the new database should use Windows authentication Returns ------- - str - The initial_catalog of this GsaConnectionDetails. + bool | None | Unset_Type + The use_integrated_security of this GsaConnectionDetails. """ - return self._initial_catalog + return self._use_integrated_security - @initial_catalog.setter - def initial_catalog(self, initial_catalog: "str") -> None: - """Sets the initial_catalog of this GsaConnectionDetails. - The name of the database in SQL server + @use_integrated_security.setter + def use_integrated_security(self, use_integrated_security: "bool | None | Unset_Type") -> None: + """Sets the use_integrated_security of this GsaConnectionDetails. + Set to true if the SQL connection to the new database should use Windows authentication Parameters ---------- - initial_catalog: str - The initial_catalog of this GsaConnectionDetails. + use_integrated_security: bool | None | Unset_Type + The use_integrated_security of this GsaConnectionDetails. """ - # Field is not nullable - if initial_catalog is None: - raise ValueError("Invalid value for 'initial_catalog', must not be 'None'") - # Field is required - if initial_catalog is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'initial_catalog', must not be 'Unset'") - self._initial_catalog = initial_catalog + self._use_integrated_security = use_integrated_security @property - def use_configuration_database_credentials(self) -> "bool | Unset_Type": - """Gets the use_configuration_database_credentials of this GsaConnectionDetails. - Set to true if the SQL connection is using the credentials from the Configuration database. + def sql_username(self) -> "str | None | Unset_Type": + """Gets the sql_username of this GsaConnectionDetails. + The username to use if the new database should use SQL authentication. The password must also be provided. Returns ------- - bool | Unset_Type - The use_configuration_database_credentials of this GsaConnectionDetails. + str | None | Unset_Type + The sql_username of this GsaConnectionDetails. """ - return self._use_configuration_database_credentials + return self._sql_username - @use_configuration_database_credentials.setter - def use_configuration_database_credentials( - self, use_configuration_database_credentials: "bool | Unset_Type" - ) -> None: - """Sets the use_configuration_database_credentials of this GsaConnectionDetails. - Set to true if the SQL connection is using the credentials from the Configuration database. + @sql_username.setter + def sql_username(self, sql_username: "str | None | Unset_Type") -> None: + """Sets the sql_username of this GsaConnectionDetails. + The username to use if the new database should use SQL authentication. The password must also be provided. Parameters ---------- - use_configuration_database_credentials: bool | Unset_Type - The use_configuration_database_credentials of this GsaConnectionDetails. + sql_username: str | None | Unset_Type + The sql_username of this GsaConnectionDetails. """ - # Field is not nullable - if use_configuration_database_credentials is None: - raise ValueError( - "Invalid value for 'use_configuration_database_credentials', must not be 'None'" - ) - self._use_configuration_database_credentials = use_configuration_database_credentials + self._sql_username = sql_username @property - def use_integrated_security(self) -> "bool | Unset_Type": - """Gets the use_integrated_security of this GsaConnectionDetails. - Set to true if the SQL connection to the database is using Windows authentication + def sql_password(self) -> "str | None | Unset_Type": + """Gets the sql_password of this GsaConnectionDetails. + The password to use if the new database should use SQL authentication. The username must also be provided. Returns ------- - bool | Unset_Type - The use_integrated_security of this GsaConnectionDetails. + str | None | Unset_Type + The sql_password of this GsaConnectionDetails. """ - return self._use_integrated_security + return self._sql_password - @use_integrated_security.setter - def use_integrated_security(self, use_integrated_security: "bool | Unset_Type") -> None: - """Sets the use_integrated_security of this GsaConnectionDetails. - Set to true if the SQL connection to the database is using Windows authentication + @sql_password.setter + def sql_password(self, sql_password: "str | None | Unset_Type") -> None: + """Sets the sql_password of this GsaConnectionDetails. + The password to use if the new database should use SQL authentication. The username must also be provided. Parameters ---------- - use_integrated_security: bool | Unset_Type - The use_integrated_security of this GsaConnectionDetails. + sql_password: str | None | Unset_Type + The sql_password of this GsaConnectionDetails. """ - # Field is not nullable - if use_integrated_security is None: - raise ValueError("Invalid value for 'use_integrated_security', must not be 'None'") - self._use_integrated_security = use_integrated_security + self._sql_password = sql_password @property - def sql_username(self) -> "str | None | Unset_Type": - """Gets the sql_username of this GsaConnectionDetails. - The username used if the database is using SQL authentication. + def initial_catalog(self) -> "str": + """Gets the initial_catalog of this GsaConnectionDetails. + The name of the database in SQL server Returns ------- - str | None | Unset_Type - The sql_username of this GsaConnectionDetails. + str + The initial_catalog of this GsaConnectionDetails. """ - return self._sql_username + return self._initial_catalog - @sql_username.setter - def sql_username(self, sql_username: "str | None | Unset_Type") -> None: - """Sets the sql_username of this GsaConnectionDetails. - The username used if the database is using SQL authentication. + @initial_catalog.setter + def initial_catalog(self, initial_catalog: "str") -> None: + """Sets the initial_catalog of this GsaConnectionDetails. + The name of the database in SQL server Parameters ---------- - sql_username: str | None | Unset_Type - The sql_username of this GsaConnectionDetails. + initial_catalog: str + The initial_catalog of this GsaConnectionDetails. """ - self._sql_username = sql_username + # Field is not nullable + if initial_catalog is None: + raise ValueError("Invalid value for 'initial_catalog', must not be 'None'") + # Field is required + if initial_catalog is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'initial_catalog', must not be 'Unset'") + self._initial_catalog = initial_catalog @property def additional_sql_parameters(self) -> "str | None | Unset_Type": """Gets the additional_sql_parameters of this GsaConnectionDetails. - (Optional) Any additional parameters added to the SQL connection string for the database. + (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. Returns ------- @@ -280,7 +270,7 @@ def additional_sql_parameters( self, additional_sql_parameters: "str | None | Unset_Type" ) -> None: """Sets the additional_sql_parameters of this GsaConnectionDetails. - (Optional) Any additional parameters added to the SQL connection string for the database. + (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_creation_exception.py deleted file mode 100644 index 97020079..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_creation_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConstantCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaConstantErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaConstantErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaConstantErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaConstantCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaConstantErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaConstantErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaConstantCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaConstantCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaConstantCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaConstantCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaConstantCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaConstantCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaConstantCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaConstantCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaConstantCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaConstantCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaConstantCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaConstantCreationException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaConstantErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaConstantCreationException. - - Returns - ------- - list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaConstantErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaConstantCreationException. - - Parameters - ---------- - errors: list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_deletion_exception.py index a929e6ff..bb4315d8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_deletion_exception.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaConstantDeletionException(GsaDeletionException): +class GsaConstantDeletionException(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,31 +61,28 @@ class GsaConstantDeletionException(GsaDeletionException): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", "code": "code", "errors": "errors", "message": "message", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "code": "SystemNetHttpStatusCode", + "errors": "GsaDataModificationErrorDetail", + } discriminator: Optional[str] = None def __init__( self, *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.CONSTANT, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -100,19 +90,89 @@ def __init__( Parameters ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) + self._message: str | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset + + if message is not Unset: + self.message = message + if code is not Unset: + self.code = code + if errors is not Unset: + self.errors = errors + + @property + def message(self) -> "str | None | Unset_Type": + """Gets the message of this GsaConstantDeletionException. + + Returns + ------- + str | None | Unset_Type + The message of this GsaConstantDeletionException. + """ + return self._message + + @message.setter + def message(self, message: "str | None | Unset_Type") -> None: + """Sets the message of this GsaConstantDeletionException. + + Parameters + ---------- + message: str | None | Unset_Type + The message of this GsaConstantDeletionException. + """ + self._message = message + + @property + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": + """Gets the code of this GsaConstantDeletionException. + + Returns + ------- + SystemNetHttpStatusCode | Unset_Type + The code of this GsaConstantDeletionException. + """ + return self._code + + @code.setter + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: + """Sets the code of this GsaConstantDeletionException. + + Parameters + ---------- + code: SystemNetHttpStatusCode | Unset_Type + The code of this GsaConstantDeletionException. + """ + # Field is not nullable + if code is None: + raise ValueError("Invalid value for 'code', must not be 'None'") + self._code = code + + @property + def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": + """Gets the errors of this GsaConstantDeletionException. + + Returns + ------- + list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaConstantDeletionException. + """ + return self._errors + + @errors.setter + def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: + """Sets the errors of this GsaConstantDeletionException. + + Parameters + ---------- + errors: list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaConstantDeletionException. + """ + self._errors = errors @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_detail.py deleted file mode 100644 index 0fc67b97..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConstantErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaConstantErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaConstantErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityConstantErrorDetail", - "noSuchUnit".lower(): "#/components/schemas/GsaNoSuchUnitConstantErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaConstantErrorReason", - ) -> None: - """GsaConstantErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaConstantErrorReason - """ - self._message: str - self._reason: GsaConstantErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaConstantErrorDetail. - - Returns - ------- - str - The message of this GsaConstantErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaConstantErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaConstantErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaConstantErrorReason": - """Gets the reason of this GsaConstantErrorDetail. - - Returns - ------- - GsaConstantErrorReason - The reason of this GsaConstantErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaConstantErrorReason") -> None: - """Sets the reason of this GsaConstantErrorDetail. - - Parameters - ---------- - reason: GsaConstantErrorReason - The reason of this GsaConstantErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_reason.py deleted file mode 100644 index 9c751867..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_error_reason.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaConstantErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - NOSUCHUNIT = "noSuchUnit" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_update_exception.py deleted file mode 100644 index 8491e2c6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_update_exception.py +++ /dev/null @@ -1,238 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConstantUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "constant_guid": "str", - "errors": "list[GsaConstantErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "constant_guid": "constantGuid", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaConstantErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - constant_guid: "str | Unset_Type" = Unset, - errors: "list[GsaConstantErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaConstantUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - constant_guid: str, optional - errors: list[GsaConstantErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._constant_guid: str | Unset_Type = Unset - self._errors: list[GsaConstantErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if constant_guid is not Unset: - self.constant_guid = constant_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaConstantUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaConstantUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaConstantUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaConstantUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaConstantUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaConstantUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaConstantUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaConstantUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def constant_guid(self) -> "str | Unset_Type": - """Gets the constant_guid of this GsaConstantUpdateException. - - Returns - ------- - str | Unset_Type - The constant_guid of this GsaConstantUpdateException. - """ - return self._constant_guid - - @constant_guid.setter - def constant_guid(self, constant_guid: "str | Unset_Type") -> None: - """Sets the constant_guid of this GsaConstantUpdateException. - - Parameters - ---------- - constant_guid: str | Unset_Type - The constant_guid of this GsaConstantUpdateException. - """ - # Field is not nullable - if constant_guid is None: - raise ValueError("Invalid value for 'constant_guid', must not be 'None'") - self._constant_guid = constant_guid - - @property - def errors(self) -> "list[GsaConstantErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaConstantUpdateException. - - Returns - ------- - list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaConstantErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaConstantUpdateException. - - Parameters - ---------- - errors: list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_usage_data_modification_error_detail.py deleted file mode 100644 index 075c3956..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constant_usage_data_modification_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConstantUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimNamedEntity]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.CONSTANT, - referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaConstantUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimNamedEntity] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaConstantUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaConstantUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaConstantUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaConstantUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constants_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constants_info.py index 2d29f048..82f4dcb0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constants_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_constants_info.py @@ -61,7 +61,7 @@ class GsaConstantsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "constants": "list[GsaConstant]", + "constants": "list[GsaSlimConstant]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaConstantsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "constants": "GsaConstant", + "constants": "GsaSlimConstant", } discriminator: Optional[str] = None @@ -77,37 +77,37 @@ class GsaConstantsInfo(ModelBase): def __init__( self, *, - constants: "list[GsaConstant] | None | Unset_Type" = Unset, + constants: "list[GsaSlimConstant] | None | Unset_Type" = Unset, ) -> None: """GsaConstantsInfo - a model defined in Swagger Parameters ---------- - constants: list[GsaConstant] | None, optional + constants: list[GsaSlimConstant] | None, optional """ - self._constants: list[GsaConstant] | None | Unset_Type = Unset + self._constants: list[GsaSlimConstant] | None | Unset_Type = Unset if constants is not Unset: self.constants = constants @property - def constants(self) -> "list[GsaConstant] | None | Unset_Type": + def constants(self) -> "list[GsaSlimConstant] | None | Unset_Type": """Gets the constants of this GsaConstantsInfo. Returns ------- - list[GsaConstant] | None | Unset_Type + list[GsaSlimConstant] | None | Unset_Type The constants of this GsaConstantsInfo. """ return self._constants @constants.setter - def constants(self, constants: "list[GsaConstant] | None | Unset_Type") -> None: + def constants(self, constants: "list[GsaSlimConstant] | None | Unset_Type") -> None: """Sets the constants of this GsaConstantsInfo. Parameters ---------- - constants: list[GsaConstant] | None | Unset_Type + constants: list[GsaSlimConstant] | None | Unset_Type The constants of this GsaConstantsInfo. """ self._constants = constants diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_continuous_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_continuous_quality_system.py deleted file mode 100644 index e9c94f68..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_continuous_quality_system.py +++ /dev/null @@ -1,205 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system import ( # noqa: F401 - GsaQualitySystem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_type import ( - GsaQualitySystemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaContinuousQualitySystem(GsaQualitySystem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "does_quality_decrease_with_value": "bool", - "guid": "str", - "name": "str", - "threshold_value": "float", - "type": "GsaQualitySystemType", - } - - attribute_map: dict[str, str] = { - "does_quality_decrease_with_value": "doesQualityDecreaseWithValue", - "guid": "guid", - "name": "name", - "threshold_value": "thresholdValue", - "type": "type", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - does_quality_decrease_with_value: "bool", - guid: "str", - name: "str", - threshold_value: "float", - type: "GsaQualitySystemType" = GsaQualitySystemType.CONTINUOUS, - ) -> None: - """GsaContinuousQualitySystem - a model defined in Swagger - - Parameters - ---------- - does_quality_decrease_with_value: bool - guid: str - name: str - threshold_value: float - type: GsaQualitySystemType - """ - super().__init__(guid=guid, name=name, type=type) - self._does_quality_decrease_with_value: bool - self._threshold_value: float - - self.does_quality_decrease_with_value = does_quality_decrease_with_value - self.threshold_value = threshold_value - - @property - def does_quality_decrease_with_value(self) -> "bool": - """Gets the does_quality_decrease_with_value of this GsaContinuousQualitySystem. - - Returns - ------- - bool - The does_quality_decrease_with_value of this GsaContinuousQualitySystem. - """ - return self._does_quality_decrease_with_value - - @does_quality_decrease_with_value.setter - def does_quality_decrease_with_value(self, does_quality_decrease_with_value: "bool") -> None: - """Sets the does_quality_decrease_with_value of this GsaContinuousQualitySystem. - - Parameters - ---------- - does_quality_decrease_with_value: bool - The does_quality_decrease_with_value of this GsaContinuousQualitySystem. - """ - # Field is not nullable - if does_quality_decrease_with_value is None: - raise ValueError( - "Invalid value for 'does_quality_decrease_with_value', must not be 'None'" - ) - # Field is required - if does_quality_decrease_with_value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'does_quality_decrease_with_value', must not be 'Unset'" - ) - self._does_quality_decrease_with_value = does_quality_decrease_with_value - - @property - def threshold_value(self) -> "float": - """Gets the threshold_value of this GsaContinuousQualitySystem. - - Returns - ------- - float - The threshold_value of this GsaContinuousQualitySystem. - """ - return self._threshold_value - - @threshold_value.setter - def threshold_value(self, threshold_value: "float") -> None: - """Sets the threshold_value of this GsaContinuousQualitySystem. - - Parameters - ---------- - threshold_value: float - The threshold_value of this GsaContinuousQualitySystem. - """ - # Field is not nullable - if threshold_value is None: - raise ValueError("Invalid value for 'threshold_value', must not be 'None'") - # Field is required - if threshold_value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'threshold_value', must not be 'Unset'") - self._threshold_value = threshold_value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaContinuousQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category.py deleted file mode 100644 index c9142ede..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category.py +++ /dev/null @@ -1,253 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateAccessControlCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type": "GsaSlimEntity", - "name": "str", - "guid": "str", - "table_mappings": "list[GsaCreateAccessControlCategoryTableMapping]", - } - - attribute_map: dict[str, str] = { - "discrete_type": "discreteType", - "name": "name", - "guid": "guid", - "table_mappings": "tableMappings", - } - - subtype_mapping: dict[str, str] = { - "discreteType": "GsaSlimEntity", - "tableMappings": "GsaCreateAccessControlCategoryTableMapping", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type: "GsaSlimEntity", - name: "str", - guid: "str | Unset_Type" = Unset, - table_mappings: "list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateAccessControlCategory - a model defined in Swagger - - Parameters - ---------- - discrete_type: GsaSlimEntity - name: str - guid: str, optional - table_mappings: list[GsaCreateAccessControlCategoryTableMapping] | None, optional - """ - self._discrete_type: GsaSlimEntity - self._table_mappings: ( - list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type - ) = Unset - self._name: str - self._guid: str | Unset_Type = Unset - - self.discrete_type = discrete_type - if table_mappings is not Unset: - self.table_mappings = table_mappings - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def discrete_type(self) -> "GsaSlimEntity": - """Gets the discrete_type of this GsaCreateAccessControlCategory. - - Returns - ------- - GsaSlimEntity - The discrete_type of this GsaCreateAccessControlCategory. - """ - return self._discrete_type - - @discrete_type.setter - def discrete_type(self, discrete_type: "GsaSlimEntity") -> None: - """Sets the discrete_type of this GsaCreateAccessControlCategory. - - Parameters - ---------- - discrete_type: GsaSlimEntity - The discrete_type of this GsaCreateAccessControlCategory. - """ - # Field is not nullable - if discrete_type is None: - raise ValueError("Invalid value for 'discrete_type', must not be 'None'") - # Field is required - if discrete_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type', must not be 'Unset'") - self._discrete_type = discrete_type - - @property - def table_mappings( - self, - ) -> "list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type": - """Gets the table_mappings of this GsaCreateAccessControlCategory. - Optionally maps an attribute, and values applied to the table, for each table. There can be at most one entry for each table. - - Returns - ------- - list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaCreateAccessControlCategory. - """ - return self._table_mappings - - @table_mappings.setter - def table_mappings( - self, table_mappings: "list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type" - ) -> None: - """Sets the table_mappings of this GsaCreateAccessControlCategory. - Optionally maps an attribute, and values applied to the table, for each table. There can be at most one entry for each table. - - Parameters - ---------- - table_mappings: list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaCreateAccessControlCategory. - """ - self._table_mappings = table_mappings - - @property - def name(self) -> "str": - """Gets the name of this GsaCreateAccessControlCategory. - - Returns - ------- - str - The name of this GsaCreateAccessControlCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreateAccessControlCategory. - - Parameters - ---------- - name: str - The name of this GsaCreateAccessControlCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreateAccessControlCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaCreateAccessControlCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreateAccessControlCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaCreateAccessControlCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateAccessControlCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category_table_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category_table_mapping.py deleted file mode 100644 index 7906a1d5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_access_control_category_table_mapping.py +++ /dev/null @@ -1,218 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateAccessControlCategoryTableMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "table": "GsaSlimEntity", - "table_discrete_values": "list[GsaSlimEntity]", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "table": "table", - "table_discrete_values": "tableDiscreteValues", - } - - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "tableDiscreteValues": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - table: "GsaSlimEntity", - table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateAccessControlCategoryTableMapping - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - table: GsaSlimEntity - table_discrete_values: list[GsaSlimEntity] | None, optional - """ - self._table: GsaSlimEntity - self._attribute: GsaSlimEntity - self._table_discrete_values: list[GsaSlimEntity] | None | Unset_Type = Unset - - self.table = table - self.attribute = attribute - if table_discrete_values is not Unset: - self.table_discrete_values = table_discrete_values - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaCreateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The table of this GsaCreateAccessControlCategoryTableMapping. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaCreateAccessControlCategoryTableMapping. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaCreateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaCreateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaCreateAccessControlCategoryTableMapping. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaCreateAccessControlCategoryTableMapping. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaCreateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @property - def table_discrete_values(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - The discrete values applied to the table for this mapping. If omitted or set to null or an empty array, table discrete values will be set to empty. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - """ - return self._table_discrete_values - - @table_discrete_values.setter - def table_discrete_values( - self, table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - The discrete values applied to the table for this mapping. If omitted or set to null or an empty array, table discrete values will be set to empty. - - Parameters - ---------- - table_discrete_values: list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - """ - self._table_discrete_values = table_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateAccessControlCategoryTableMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_attribute.py index 6f0cd99c..0cbbf8ab 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_attribute.py @@ -66,28 +66,23 @@ class GsaCreateAttribute(ModelBase): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { "type": "GsaAttributeType", "defaultThresholdType": "GsaAttributeThresholdType", - "metaAttributes": "GsaCreateAttribute", } discriminator_value_class_map = { @@ -116,11 +111,9 @@ def __init__( name: "str", type: "GsaAttributeType", default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateAttribute - a model defined in Swagger @@ -129,18 +122,14 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ self._type: GsaAttributeType self._default_threshold_type: GsaAttributeThresholdType | Unset_Type = Unset self._help_path: str | None | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset - self._meta_attributes: list[GsaCreateAttribute] | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset @@ -151,10 +140,6 @@ def __init__( self.help_path = help_path if is_hidden_from_search_criteria is not Unset: self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - if meta_attributes is not Unset: - self.meta_attributes = meta_attributes - if display_names is not Unset: - self.display_names = display_names self.name = name if guid is not Unset: self.guid = guid @@ -262,54 +247,6 @@ def is_hidden_from_search_criteria( """ self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def meta_attributes(self) -> "list[GsaCreateAttribute] | None | Unset_Type": - """Gets the meta_attributes of this GsaCreateAttribute. - - Returns - ------- - list[GsaCreateAttribute] | None | Unset_Type - The meta_attributes of this GsaCreateAttribute. - """ - return self._meta_attributes - - @meta_attributes.setter - def meta_attributes( - self, meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" - ) -> None: - """Sets the meta_attributes of this GsaCreateAttribute. - - Parameters - ---------- - meta_attributes: list[GsaCreateAttribute] | None | Unset_Type - The meta_attributes of this GsaCreateAttribute. - """ - self._meta_attributes = meta_attributes - - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaCreateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaCreateAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaCreateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaCreateAttribute. - """ - self._display_names = display_names - @property def name(self) -> "str": """Gets the name of this GsaCreateAttribute. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_continuous_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_continuous_quality_system.py deleted file mode 100644 index 65bc1e94..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_continuous_quality_system.py +++ /dev/null @@ -1,203 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_create_quality_system import ( # noqa: F401 - GsaCreateQualitySystem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_type import ( - GsaQualitySystemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateContinuousQualitySystem(GsaCreateQualitySystem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "threshold_value": "float", - "type": "GsaQualitySystemType", - "does_quality_decrease_with_value": "bool", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "threshold_value": "thresholdValue", - "type": "type", - "does_quality_decrease_with_value": "doesQualityDecreaseWithValue", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - threshold_value: "float", - type: "GsaQualitySystemType" = GsaQualitySystemType.CONTINUOUS, - does_quality_decrease_with_value: "bool | Unset_Type" = Unset, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaCreateContinuousQualitySystem - a model defined in Swagger - - Parameters - ---------- - name: str - threshold_value: float - type: GsaQualitySystemType - does_quality_decrease_with_value: bool, optional - guid: str, optional - """ - super().__init__(name=name, type=type, guid=guid) - self._does_quality_decrease_with_value: bool | Unset_Type = Unset - self._threshold_value: float - - if does_quality_decrease_with_value is not Unset: - self.does_quality_decrease_with_value = does_quality_decrease_with_value - self.threshold_value = threshold_value - - @property - def does_quality_decrease_with_value(self) -> "bool | Unset_Type": - """Gets the does_quality_decrease_with_value of this GsaCreateContinuousQualitySystem. - - Returns - ------- - bool | Unset_Type - The does_quality_decrease_with_value of this GsaCreateContinuousQualitySystem. - """ - return self._does_quality_decrease_with_value - - @does_quality_decrease_with_value.setter - def does_quality_decrease_with_value( - self, does_quality_decrease_with_value: "bool | Unset_Type" - ) -> None: - """Sets the does_quality_decrease_with_value of this GsaCreateContinuousQualitySystem. - - Parameters - ---------- - does_quality_decrease_with_value: bool | Unset_Type - The does_quality_decrease_with_value of this GsaCreateContinuousQualitySystem. - """ - # Field is not nullable - if does_quality_decrease_with_value is None: - raise ValueError( - "Invalid value for 'does_quality_decrease_with_value', must not be 'None'" - ) - self._does_quality_decrease_with_value = does_quality_decrease_with_value - - @property - def threshold_value(self) -> "float": - """Gets the threshold_value of this GsaCreateContinuousQualitySystem. - - Returns - ------- - float - The threshold_value of this GsaCreateContinuousQualitySystem. - """ - return self._threshold_value - - @threshold_value.setter - def threshold_value(self, threshold_value: "float") -> None: - """Sets the threshold_value of this GsaCreateContinuousQualitySystem. - - Parameters - ---------- - threshold_value: float - The threshold_value of this GsaCreateContinuousQualitySystem. - """ - # Field is not nullable - if threshold_value is None: - raise ValueError("Invalid value for 'threshold_value', must not be 'None'") - # Field is required - if threshold_value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'threshold_value', must not be 'Unset'") - self._threshold_value = threshold_value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateContinuousQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_link_target.py deleted file mode 100644 index acc696a4..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_link_target.py +++ /dev/null @@ -1,178 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateCrossDatabaseLinkTarget(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - "database_guid": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - "database_guid": "databaseGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - database_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateCrossDatabaseLinkTarget - a model defined in Swagger - - Parameters - ---------- - table_guid: str - database_guid: str | None, optional - """ - self._database_guid: str | None | Unset_Type = Unset - self._table_guid: str - - if database_guid is not Unset: - self.database_guid = database_guid - self.table_guid = table_guid - - @property - def database_guid(self) -> "str | None | Unset_Type": - """Gets the database_guid of this GsaCreateCrossDatabaseLinkTarget. - If databaseGuid is set, the target will match any database with that Guid. If databaseGuid is not set, the target wil match the tableGuid in any database. - - Returns - ------- - str | None | Unset_Type - The database_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - return self._database_guid - - @database_guid.setter - def database_guid(self, database_guid: "str | None | Unset_Type") -> None: - """Sets the database_guid of this GsaCreateCrossDatabaseLinkTarget. - If databaseGuid is set, the target will match any database with that Guid. If databaseGuid is not set, the target wil match the tableGuid in any database. - - Parameters - ---------- - database_guid: str | None | Unset_Type - The database_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - self._database_guid = database_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaCreateCrossDatabaseLinkTarget. - - Returns - ------- - str - The table_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaCreateCrossDatabaseLinkTarget. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateCrossDatabaseLinkTarget): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_record_link_group.py index 7c8034b0..71fd430f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_cross_database_record_link_group.py @@ -68,7 +68,7 @@ class GsaCreateCrossDatabaseRecordLinkGroup(GsaCreateRecordLinkGroup): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "link_target": "GsaCreateCrossDatabaseLinkTarget", + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -85,16 +85,14 @@ class GsaCreateCrossDatabaseRecordLinkGroup(GsaCreateRecordLinkGroup): "include_indirect_links": "includeIndirectLinks", } - subtype_mapping: dict[str, str] = { - "linkTarget": "GsaCreateCrossDatabaseLinkTarget", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - link_target: "GsaCreateCrossDatabaseLinkTarget", + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.CROSSDATABASE, @@ -105,49 +103,21 @@ def __init__( Parameters ---------- - link_target: GsaCreateCrossDatabaseLinkTarget + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType guid: str, optional include_indirect_links: bool, optional """ - super().__init__(name=name, reverse_name=reverse_name, type=type, guid=guid) - self._link_target: GsaCreateCrossDatabaseLinkTarget + super().__init__( + link_target=link_target, name=name, reverse_name=reverse_name, type=type, guid=guid + ) self._include_indirect_links: bool | Unset_Type = Unset - self.link_target = link_target if include_indirect_links is not Unset: self.include_indirect_links = include_indirect_links - @property - def link_target(self) -> "GsaCreateCrossDatabaseLinkTarget": - """Gets the link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - - Returns - ------- - GsaCreateCrossDatabaseLinkTarget - The link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - """ - return self._link_target - - @link_target.setter - def link_target(self, link_target: "GsaCreateCrossDatabaseLinkTarget") -> None: - """Sets the link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - - Parameters - ---------- - link_target: GsaCreateCrossDatabaseLinkTarget - The link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - """ - # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") - # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target - @property def include_indirect_links(self) -> "bool | Unset_Type": """Gets the include_indirect_links of this GsaCreateCrossDatabaseRecordLinkGroup. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_data_update_server_api_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_data_update_server_api_request.py deleted file mode 100644 index 9e29e8f5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_data_update_server_api_request.py +++ /dev/null @@ -1,212 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateDataUpdateServerApiRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "project": "GsaDataUpdaterProject", - "description": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "project": "project", - "description": "description", - } - - subtype_mapping: dict[str, str] = { - "project": "GsaDataUpdaterProject", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - project: "GsaDataUpdaterProject", - description: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateDataUpdateServerApiRequest - a model defined in Swagger - - Parameters - ---------- - name: str - project: GsaDataUpdaterProject - description: str | None, optional - """ - self._name: str - self._description: str | None | Unset_Type = Unset - self._project: GsaDataUpdaterProject - - self.name = name - if description is not Unset: - self.description = description - self.project = project - - @property - def name(self) -> "str": - """Gets the name of this GsaCreateDataUpdateServerApiRequest. - - Returns - ------- - str - The name of this GsaCreateDataUpdateServerApiRequest. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreateDataUpdateServerApiRequest. - - Parameters - ---------- - name: str - The name of this GsaCreateDataUpdateServerApiRequest. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaCreateDataUpdateServerApiRequest. - - Returns - ------- - str | None | Unset_Type - The description of this GsaCreateDataUpdateServerApiRequest. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaCreateDataUpdateServerApiRequest. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaCreateDataUpdateServerApiRequest. - """ - self._description = description - - @property - def project(self) -> "GsaDataUpdaterProject": - """Gets the project of this GsaCreateDataUpdateServerApiRequest. - - Returns - ------- - GsaDataUpdaterProject - The project of this GsaCreateDataUpdateServerApiRequest. - """ - return self._project - - @project.setter - def project(self, project: "GsaDataUpdaterProject") -> None: - """Sets the project of this GsaCreateDataUpdateServerApiRequest. - - Parameters - ---------- - project: GsaDataUpdaterProject - The project of this GsaCreateDataUpdateServerApiRequest. - """ - # Field is not nullable - if project is None: - raise ValueError("Invalid value for 'project', must not be 'None'") - # Field is required - if project is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'project', must not be 'Unset'") - self._project = project - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateDataUpdateServerApiRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_date_time_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_date_time_attribute.py index 5349a92f..cce37bbe 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_date_time_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_date_time_attribute.py @@ -69,22 +69,18 @@ class GsaCreateDateTimeAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.DATETIME, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateDateTimeAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_attribute.py index c4be0dbe..d24d09b0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_attribute.py @@ -70,12 +70,10 @@ class GsaCreateDiscreteAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -83,12 +81,10 @@ class GsaCreateDiscreteAttribute(GsaCreateAttribute): "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -104,12 +100,10 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.DISCRETE, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateDiscreteAttribute - a model defined in Swagger @@ -119,22 +113,18 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._discrete_type: GsaSlimEntity self._is_multi_valued: bool | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_functional_attribute.py index cf6aee57..e62cf608 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_functional_attribute.py @@ -71,11 +71,9 @@ class GsaCreateDiscreteFunctionalAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -84,11 +82,9 @@ class GsaCreateDiscreteFunctionalAttribute(GsaCreateAttribute): "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -106,11 +102,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.DISCRETEFUNCTIONAL, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateDiscreteFunctionalAttribute - a model defined in Swagger @@ -121,21 +115,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._discrete_type: GsaSlimEntity self._attribute_parameters: list[GsaCreateDiscreteFunctionalAttributeParameter] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_parameter.py index 67eb7e79..67633918 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_parameter.py @@ -71,6 +71,7 @@ class GsaCreateDiscreteParameter(GsaCreateParameter): "type": "GsaParameterType", "values": "list[GsaCreateDiscreteParameterValue]", "guid": "str", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -79,6 +80,7 @@ class GsaCreateDiscreteParameter(GsaCreateParameter): "type": "type", "values": "values", "guid": "guid", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -95,6 +97,7 @@ def __init__( type: "GsaParameterType" = GsaParameterType.DISCRETE, values: "list[GsaCreateDiscreteParameterValue]", guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaCreateDiscreteParameter - a model defined in Swagger @@ -105,12 +108,14 @@ def __init__( type: GsaParameterType values: list[GsaCreateDiscreteParameterValue] guid: str, optional + help_path: str | None, optional """ super().__init__( default_parameter_value_index=default_parameter_value_index, name=name, type=type, guid=guid, + help_path=help_path, ) self._values: list[GsaCreateDiscreteParameterValue] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_quality_system.py deleted file mode 100644 index eaa12982..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_quality_system.py +++ /dev/null @@ -1,200 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_create_quality_system import ( # noqa: F401 - GsaCreateQualitySystem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_type import ( - GsaQualitySystemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateDiscreteQualitySystem(GsaCreateQualitySystem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "quality_discrete_values": "list[GsaCreateQualityDiscreteValue]", - "type": "GsaQualitySystemType", - "guid": "str", - "threshold_value_name": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "quality_discrete_values": "qualityDiscreteValues", - "type": "type", - "guid": "guid", - "threshold_value_name": "thresholdValueName", - } - - subtype_mapping: dict[str, str] = { - "qualityDiscreteValues": "GsaCreateQualityDiscreteValue", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - quality_discrete_values: "list[GsaCreateQualityDiscreteValue]", - type: "GsaQualitySystemType" = GsaQualitySystemType.DISCRETE, - guid: "str | Unset_Type" = Unset, - threshold_value_name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateDiscreteQualitySystem - a model defined in Swagger - - Parameters - ---------- - name: str - quality_discrete_values: list[GsaCreateQualityDiscreteValue] - type: GsaQualitySystemType - guid: str, optional - threshold_value_name: str | None, optional - """ - super().__init__(name=name, type=type, guid=guid) - self._threshold_value_name: str | None | Unset_Type = Unset - self._quality_discrete_values: list[GsaCreateQualityDiscreteValue] - - if threshold_value_name is not Unset: - self.threshold_value_name = threshold_value_name - self.quality_discrete_values = quality_discrete_values - - @property - def threshold_value_name(self) -> "str | None | Unset_Type": - """Gets the threshold_value_name of this GsaCreateDiscreteQualitySystem. - - Returns - ------- - str | None | Unset_Type - The threshold_value_name of this GsaCreateDiscreteQualitySystem. - """ - return self._threshold_value_name - - @threshold_value_name.setter - def threshold_value_name(self, threshold_value_name: "str | None | Unset_Type") -> None: - """Sets the threshold_value_name of this GsaCreateDiscreteQualitySystem. - - Parameters - ---------- - threshold_value_name: str | None | Unset_Type - The threshold_value_name of this GsaCreateDiscreteQualitySystem. - """ - self._threshold_value_name = threshold_value_name - - @property - def quality_discrete_values(self) -> "list[GsaCreateQualityDiscreteValue]": - """Gets the quality_discrete_values of this GsaCreateDiscreteQualitySystem. - - Returns - ------- - list[GsaCreateQualityDiscreteValue] - The quality_discrete_values of this GsaCreateDiscreteQualitySystem. - """ - return self._quality_discrete_values - - @quality_discrete_values.setter - def quality_discrete_values( - self, quality_discrete_values: "list[GsaCreateQualityDiscreteValue]" - ) -> None: - """Sets the quality_discrete_values of this GsaCreateDiscreteQualitySystem. - - Parameters - ---------- - quality_discrete_values: list[GsaCreateQualityDiscreteValue] - The quality_discrete_values of this GsaCreateDiscreteQualitySystem. - """ - # Field is not nullable - if quality_discrete_values is None: - raise ValueError("Invalid value for 'quality_discrete_values', must not be 'None'") - # Field is required - if quality_discrete_values is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'quality_discrete_values', must not be 'Unset'") - self._quality_discrete_values = quality_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateDiscreteQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_type.py index e54ded0e..08069489 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_discrete_type.py @@ -62,21 +62,17 @@ class GsaCreateDiscreteType(ModelBase): """ swagger_types: dict[str, str] = { "name": "str", - "discrete_values": "list[GsaDiscreteValuesCreateDiscreteValue]", "guid": "str", "is_ordered": "bool", } attribute_map: dict[str, str] = { "name": "name", - "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", } - subtype_mapping: dict[str, str] = { - "discreteValues": "GsaDiscreteValuesCreateDiscreteValue", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -84,7 +80,6 @@ def __init__( self, *, name: "str", - discrete_values: "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, is_ordered: "bool | Unset_Type" = Unset, ) -> None: @@ -93,21 +88,15 @@ def __init__( Parameters ---------- name: str - discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None, optional guid: str, optional is_ordered: bool, optional """ self._is_ordered: bool | Unset_Type = Unset - self._discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type = ( - Unset - ) self._name: str self._guid: str | Unset_Type = Unset if is_ordered is not Unset: self.is_ordered = is_ordered - if discrete_values is not Unset: - self.discrete_values = discrete_values self.name = name if guid is not Unset: self.guid = guid @@ -137,30 +126,6 @@ def is_ordered(self, is_ordered: "bool | Unset_Type") -> None: raise ValueError("Invalid value for 'is_ordered', must not be 'None'") self._is_ordered = is_ordered - @property - def discrete_values(self) -> "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type": - """Gets the discrete_values of this GsaCreateDiscreteType. - - Returns - ------- - list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type - The discrete_values of this GsaCreateDiscreteType. - """ - return self._discrete_values - - @discrete_values.setter - def discrete_values( - self, discrete_values: "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type" - ) -> None: - """Sets the discrete_values of this GsaCreateDiscreteType. - - Parameters - ---------- - discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type - The discrete_values of this GsaCreateDiscreteType. - """ - self._discrete_values = discrete_values - @property def name(self) -> "str": """Gets the name of this GsaCreateDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_smart_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_dynamic_record_link_group.py similarity index 75% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_smart_record_link_group.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_dynamic_record_link_group.py index 180d380c..6f712a56 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_smart_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_dynamic_record_link_group.py @@ -49,7 +49,7 @@ from . import * -class GsaCreateSmartRecordLinkGroup(GsaCreateRecordLinkGroup): +class GsaCreateDynamicRecordLinkGroup(GsaCreateRecordLinkGroup): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -69,7 +69,7 @@ class GsaCreateSmartRecordLinkGroup(GsaCreateRecordLinkGroup): """ swagger_types: dict[str, str] = { "attribute_pairs": "list[GsaCreateAttributeLinkPair]", - "link_target": "GsaCreateSmartLinkTarget", + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -90,7 +90,6 @@ class GsaCreateSmartRecordLinkGroup(GsaCreateRecordLinkGroup): } subtype_mapping: dict[str, str] = { - "linkTarget": "GsaCreateSmartLinkTarget", "referentialIntegrityModel": "GsaReferentialIntegrityModel", "attributePairs": "GsaCreateAttributeLinkPair", } @@ -101,20 +100,20 @@ def __init__( self, *, attribute_pairs: "list[GsaCreateAttributeLinkPair]", - link_target: "GsaCreateSmartLinkTarget", + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", - type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, + type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.DYNAMIC, forbid_orphans: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" = Unset, ) -> None: - """GsaCreateSmartRecordLinkGroup - a model defined in Swagger + """GsaCreateDynamicRecordLinkGroup - a model defined in Swagger Parameters ---------- attribute_pairs: list[GsaCreateAttributeLinkPair] - link_target: GsaCreateSmartLinkTarget + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType @@ -122,66 +121,38 @@ def __init__( guid: str, optional referential_integrity_model: GsaReferentialIntegrityModel, optional """ - super().__init__(name=name, reverse_name=reverse_name, type=type, guid=guid) - self._link_target: GsaCreateSmartLinkTarget + super().__init__( + link_target=link_target, name=name, reverse_name=reverse_name, type=type, guid=guid + ) self._forbid_orphans: bool | Unset_Type = Unset self._referential_integrity_model: GsaReferentialIntegrityModel | Unset_Type = Unset self._attribute_pairs: list[GsaCreateAttributeLinkPair] - self.link_target = link_target if forbid_orphans is not Unset: self.forbid_orphans = forbid_orphans if referential_integrity_model is not Unset: self.referential_integrity_model = referential_integrity_model self.attribute_pairs = attribute_pairs - @property - def link_target(self) -> "GsaCreateSmartLinkTarget": - """Gets the link_target of this GsaCreateSmartRecordLinkGroup. - - Returns - ------- - GsaCreateSmartLinkTarget - The link_target of this GsaCreateSmartRecordLinkGroup. - """ - return self._link_target - - @link_target.setter - def link_target(self, link_target: "GsaCreateSmartLinkTarget") -> None: - """Sets the link_target of this GsaCreateSmartRecordLinkGroup. - - Parameters - ---------- - link_target: GsaCreateSmartLinkTarget - The link_target of this GsaCreateSmartRecordLinkGroup. - """ - # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") - # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target - @property def forbid_orphans(self) -> "bool | Unset_Type": - """Gets the forbid_orphans of this GsaCreateSmartRecordLinkGroup. + """Gets the forbid_orphans of this GsaCreateDynamicRecordLinkGroup. Returns ------- bool | Unset_Type - The forbid_orphans of this GsaCreateSmartRecordLinkGroup. + The forbid_orphans of this GsaCreateDynamicRecordLinkGroup. """ return self._forbid_orphans @forbid_orphans.setter def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: - """Sets the forbid_orphans of this GsaCreateSmartRecordLinkGroup. + """Sets the forbid_orphans of this GsaCreateDynamicRecordLinkGroup. Parameters ---------- forbid_orphans: bool | Unset_Type - The forbid_orphans of this GsaCreateSmartRecordLinkGroup. + The forbid_orphans of this GsaCreateDynamicRecordLinkGroup. """ # Field is not nullable if forbid_orphans is None: @@ -190,12 +161,12 @@ def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: @property def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_Type": - """Gets the referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + """Gets the referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. Returns ------- GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + The referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. """ return self._referential_integrity_model @@ -203,12 +174,12 @@ def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_T def referential_integrity_model( self, referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" ) -> None: - """Sets the referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + """Sets the referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. Parameters ---------- referential_integrity_model: GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + The referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. """ # Field is not nullable if referential_integrity_model is None: @@ -217,25 +188,23 @@ def referential_integrity_model( @property def attribute_pairs(self) -> "list[GsaCreateAttributeLinkPair]": - """Gets the attribute_pairs of this GsaCreateSmartRecordLinkGroup. - There must be at least one and not more than three attribute pairs. + """Gets the attribute_pairs of this GsaCreateDynamicRecordLinkGroup. Returns ------- list[GsaCreateAttributeLinkPair] - The attribute_pairs of this GsaCreateSmartRecordLinkGroup. + The attribute_pairs of this GsaCreateDynamicRecordLinkGroup. """ return self._attribute_pairs @attribute_pairs.setter def attribute_pairs(self, attribute_pairs: "list[GsaCreateAttributeLinkPair]") -> None: - """Sets the attribute_pairs of this GsaCreateSmartRecordLinkGroup. - There must be at least one and not more than three attribute pairs. + """Sets the attribute_pairs of this GsaCreateDynamicRecordLinkGroup. Parameters ---------- attribute_pairs: list[GsaCreateAttributeLinkPair] - The attribute_pairs of this GsaCreateSmartRecordLinkGroup. + The attribute_pairs of this GsaCreateDynamicRecordLinkGroup. """ # Field is not nullable if attribute_pairs is None: @@ -267,7 +236,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateSmartRecordLinkGroup): + if not isinstance(other, GsaCreateDynamicRecordLinkGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_file_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_file_attribute.py index 25302d6a..5c5fa765 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_file_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_file_attribute.py @@ -69,22 +69,18 @@ class GsaCreateFileAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.FILE, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateFileAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_float_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_float_functional_attribute.py index 2f2fd715..6b6d6654 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_float_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_float_functional_attribute.py @@ -71,12 +71,10 @@ class GsaCreateFloatFunctionalAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_range": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -86,12 +84,10 @@ class GsaCreateFloatFunctionalAttribute(GsaCreateAttribute): "type": "type", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_range": "isRange", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -111,12 +107,10 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.FLOATFUNCTIONAL, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_range: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateFloatFunctionalAttribute - a model defined in Swagger @@ -128,23 +122,19 @@ def __init__( type: GsaAttributeType axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_range: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._unit: GsaSlimEntity | Unset_Type = Unset self._axis_name: GsaCreateAxisName | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_hyperlink_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_hyperlink_attribute.py index 083571a5..dd6e3a28 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_hyperlink_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_hyperlink_attribute.py @@ -69,22 +69,18 @@ class GsaCreateHyperlinkAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.HYPERLINK, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateHyperlinkAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_integer_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_integer_attribute.py index 961d4644..62219cff 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_integer_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_integer_attribute.py @@ -70,12 +70,10 @@ class GsaCreateIntegerAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_unique": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -83,12 +81,10 @@ class GsaCreateIntegerAttribute(GsaCreateAttribute): "type": "type", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_unique": "isUnique", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -104,12 +100,10 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.INTEGER, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_unique: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateIntegerAttribute - a model defined in Swagger @@ -119,22 +113,18 @@ def __init__( type: GsaAttributeType axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_unique: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._is_unique: bool | Unset_Type = Unset self._axis_name: GsaCreateAxisName | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout.py index 34b105d2..cb3cd7fb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout.py @@ -64,19 +64,15 @@ class GsaCreateLayout(ModelBase): "name": "str", "applicable_applications": "list[str]", "guid": "str", - "sections": "list[GsaCreateLayoutSection]", } attribute_map: dict[str, str] = { "name": "name", "applicable_applications": "applicableApplications", "guid": "guid", - "sections": "sections", } - subtype_mapping: dict[str, str] = { - "sections": "GsaCreateLayoutSection", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -86,7 +82,6 @@ def __init__( name: "str", applicable_applications: "list[str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, - sections: "list[GsaCreateLayoutSection] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLayout - a model defined in Swagger @@ -95,17 +90,13 @@ def __init__( name: str applicable_applications: list[str] | None, optional guid: str, optional - sections: list[GsaCreateLayoutSection] | None, optional """ self._applicable_applications: list[str] | None | Unset_Type = Unset - self._sections: list[GsaCreateLayoutSection] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset if applicable_applications is not Unset: self.applicable_applications = applicable_applications - if sections is not Unset: - self.sections = sections self.name = name if guid is not Unset: self.guid = guid @@ -136,28 +127,6 @@ def applicable_applications( """ self._applicable_applications = applicable_applications - @property - def sections(self) -> "list[GsaCreateLayoutSection] | None | Unset_Type": - """Gets the sections of this GsaCreateLayout. - - Returns - ------- - list[GsaCreateLayoutSection] | None | Unset_Type - The sections of this GsaCreateLayout. - """ - return self._sections - - @sections.setter - def sections(self, sections: "list[GsaCreateLayoutSection] | None | Unset_Type") -> None: - """Sets the sections of this GsaCreateLayout. - - Parameters - ---------- - sections: list[GsaCreateLayoutSection] | None | Unset_Type - The sections of this GsaCreateLayout. - """ - self._sections = sections - @property def name(self) -> "str": """Gets the name of this GsaCreateLayout. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout_section.py index 172f7843..6e2d93e8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout_section.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_layout_section.py @@ -63,18 +63,14 @@ class GsaCreateLayoutSection(ModelBase): swagger_types: dict[str, str] = { "name": "str", "guid": "str", - "section_items": "list[GsaNewLayoutItem]", } attribute_map: dict[str, str] = { "name": "name", "guid": "guid", - "section_items": "sectionItems", } - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaNewLayoutItem", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -83,7 +79,6 @@ def __init__( *, name: "str", guid: "str | Unset_Type" = Unset, - section_items: "list[GsaNewLayoutItem] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLayoutSection - a model defined in Swagger @@ -91,40 +86,14 @@ def __init__( ---------- name: str guid: str, optional - section_items: list[GsaNewLayoutItem] | None, optional """ - self._section_items: list[GsaNewLayoutItem] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset - if section_items is not Unset: - self.section_items = section_items self.name = name if guid is not Unset: self.guid = guid - @property - def section_items(self) -> "list[GsaNewLayoutItem] | None | Unset_Type": - """Gets the section_items of this GsaCreateLayoutSection. - - Returns - ------- - list[GsaNewLayoutItem] | None | Unset_Type - The section_items of this GsaCreateLayoutSection. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "list[GsaNewLayoutItem] | None | Unset_Type") -> None: - """Sets the section_items of this GsaCreateLayoutSection. - - Parameters - ---------- - section_items: list[GsaNewLayoutItem] | None | Unset_Type - The section_items of this GsaCreateLayoutSection. - """ - self._section_items = section_items - @property def name(self) -> "str": """Gets the name of this GsaCreateLayoutSection. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_logical_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_logical_attribute.py index ca8a0fb6..366e6aa6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_logical_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_logical_attribute.py @@ -69,22 +69,18 @@ class GsaCreateLogicalAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.LOGICAL, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLogicalAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_long_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_long_text_attribute.py index 7ed0053a..1782ccd9 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_long_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_long_text_attribute.py @@ -69,22 +69,18 @@ class GsaCreateLongTextAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.LONGTEXT, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLongTextAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_maths_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_maths_functional_attribute.py index b4fd1044..93c59fbb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_maths_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_maths_functional_attribute.py @@ -75,13 +75,11 @@ class GsaCreateMathsFunctionalAttribute(GsaCreateAttribute): "axis_name": "GsaCreateAxisName", "default_content": "GsaCreateMathsContent", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "expressions": "list[GsaSlimEntity]", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_range": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -95,13 +93,11 @@ class GsaCreateMathsFunctionalAttribute(GsaCreateAttribute): "axis_name": "axisName", "default_content": "defaultContent", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "expressions": "expressions", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_range": "isRange", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -127,13 +123,11 @@ def __init__( axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_content: "GsaCreateMathsContent | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, expressions: "list[GsaSlimEntity] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_range: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateMathsFunctionalAttribute - a model defined in Swagger @@ -149,24 +143,20 @@ def __init__( axis_name: GsaCreateAxisName, optional default_content: GsaCreateMathsContent, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional expressions: list[GsaSlimEntity] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_range: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._unit: GsaSlimEntity | Unset_Type = Unset self._attribute_parameters: list[GsaSlimEntity] | None | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_numeric_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_numeric_parameter.py index f9ce7ff9..cd648cc6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_numeric_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_numeric_parameter.py @@ -74,6 +74,7 @@ class GsaCreateNumericParameter(GsaCreateParameter): "type": "GsaParameterType", "values": "list[GsaCreateNumericParameterValue]", "guid": "str", + "help_path": "str", "unit": "GsaSlimEntity", } @@ -86,6 +87,7 @@ class GsaCreateNumericParameter(GsaCreateParameter): "type": "type", "values": "values", "guid": "guid", + "help_path": "helpPath", "unit": "unit", } @@ -109,6 +111,7 @@ def __init__( type: "GsaParameterType" = GsaParameterType.NUMERIC, values: "list[GsaCreateNumericParameterValue]", guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateNumericParameter - a model defined in Swagger @@ -123,6 +126,7 @@ def __init__( type: GsaParameterType values: list[GsaCreateNumericParameterValue] guid: str, optional + help_path: str | None, optional unit: GsaSlimEntity, optional """ super().__init__( @@ -130,6 +134,7 @@ def __init__( name=name, type=type, guid=guid, + help_path=help_path, ) self._is_restricted: bool self._unit: GsaSlimEntity | Unset_Type = Unset @@ -200,7 +205,6 @@ def unit(self, unit: "GsaSlimEntity | Unset_Type") -> None: @property def values(self) -> "list[GsaCreateNumericParameterValue]": """Gets the values of this GsaCreateNumericParameter. - Numeric parameter values cannot be ordered - they are ordered by numeric value. Returns ------- @@ -212,7 +216,6 @@ def values(self) -> "list[GsaCreateNumericParameterValue]": @values.setter def values(self, values: "list[GsaCreateNumericParameterValue]") -> None: """Sets the values of this GsaCreateNumericParameter. - Numeric parameter values cannot be ordered - they are ordered by numeric value. Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_parameter.py index bfcc8b07..0503ff63 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_parameter.py @@ -67,6 +67,7 @@ class GsaCreateParameter(ModelBase): "name": "str", "type": "GsaParameterType", "guid": "str", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -74,6 +75,7 @@ class GsaCreateParameter(ModelBase): "name": "name", "type": "type", "guid": "guid", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -94,6 +96,7 @@ def __init__( name: "str", type: "GsaParameterType", guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaCreateParameter - a model defined in Swagger @@ -103,13 +106,17 @@ def __init__( name: str type: GsaParameterType guid: str, optional + help_path: str | None, optional """ self._type: GsaParameterType + self._help_path: str | None | Unset_Type = Unset self._default_parameter_value_index: int self._name: str self._guid: str | Unset_Type = Unset self.type = type + if help_path is not Unset: + self.help_path = help_path self.default_parameter_value_index = default_parameter_value_index self.name = name if guid is not Unset: @@ -143,6 +150,28 @@ def type(self, type: "GsaParameterType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def help_path(self) -> "str | None | Unset_Type": + """Gets the help_path of this GsaCreateParameter. + + Returns + ------- + str | None | Unset_Type + The help_path of this GsaCreateParameter. + """ + return self._help_path + + @help_path.setter + def help_path(self, help_path: "str | None | Unset_Type") -> None: + """Sets the help_path of this GsaCreateParameter. + + Parameters + ---------- + help_path: str | None | Unset_Type + The help_path of this GsaCreateParameter. + """ + self._help_path = help_path + @property def default_parameter_value_index(self) -> "int": """Gets the default_parameter_value_index of this GsaCreateParameter. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission.py deleted file mode 100644 index f40a379b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission.py +++ /dev/null @@ -1,306 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePermission(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "role": "str", - "description": "str", - "guid": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "role": "role", - "description": "description", - "guid": "guid", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - role: "str", - description: "str | None | Unset_Type" = Unset, - guid: "str | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreatePermission - a model defined in Swagger - - Parameters - ---------- - name: str - role: str - description: str | None, optional - guid: str, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - self._role: str - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - self._name: str - self._guid: str | Unset_Type = Unset - - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def role(self) -> "str": - """Gets the role of this GsaCreatePermission. - - Returns - ------- - str - The role of this GsaCreatePermission. - """ - return self._role - - @role.setter - def role(self, role: "str") -> None: - """Sets the role of this GsaCreatePermission. - - Parameters - ---------- - role: str - The role of this GsaCreatePermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - # Field is required - if role is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'role', must not be 'Unset'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaCreatePermission. - The description of the permission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaCreatePermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaCreatePermission. - The description of the permission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaCreatePermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaCreatePermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaCreatePermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaCreatePermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaCreatePermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaCreatePermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaCreatePermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaCreatePermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaCreatePermission. - """ - self._unset_message = unset_message - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePermission. - - Returns - ------- - str - The name of this GsaCreatePermission. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePermission. - - Parameters - ---------- - name: str - The name of this GsaCreatePermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreatePermission. - - Returns - ------- - str | Unset_Type - The guid of this GsaCreatePermission. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreatePermission. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaCreatePermission. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission_category.py deleted file mode 100644 index adc121c7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_permission_category.py +++ /dev/null @@ -1,215 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePermissionCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "permissions": "list[GsaCreatePermission]", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "permissions": "permissions", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaCreatePermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - permissions: "list[GsaCreatePermission]", - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaCreatePermissionCategory - a model defined in Swagger - - Parameters - ---------- - name: str - permissions: list[GsaCreatePermission] - guid: str, optional - """ - self._permissions: list[GsaCreatePermission] - self._name: str - self._guid: str | Unset_Type = Unset - - self.permissions = permissions - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def permissions(self) -> "list[GsaCreatePermission]": - """Gets the permissions of this GsaCreatePermissionCategory. - - Returns - ------- - list[GsaCreatePermission] - The permissions of this GsaCreatePermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaCreatePermission]") -> None: - """Sets the permissions of this GsaCreatePermissionCategory. - - Parameters - ---------- - permissions: list[GsaCreatePermission] - The permissions of this GsaCreatePermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - # Field is required - if permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permissions', must not be 'Unset'") - self._permissions = permissions - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePermissionCategory. - - Returns - ------- - str - The name of this GsaCreatePermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePermissionCategory. - - Parameters - ---------- - name: str - The name of this GsaCreatePermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreatePermissionCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaCreatePermissionCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreatePermissionCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaCreatePermissionCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_picture_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_picture_attribute.py index 43a394cc..bd3b901c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_picture_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_picture_attribute.py @@ -69,22 +69,18 @@ class GsaCreatePictureAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.PICTURE, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreatePictureAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_point_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_point_attribute.py index fc8d71fe..b7dca2ea 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_point_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_point_attribute.py @@ -71,12 +71,10 @@ class GsaCreatePointAttribute(GsaCreateAttribute): "attribute_parameters": "list[GsaSlimEntity]", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -86,12 +84,10 @@ class GsaCreatePointAttribute(GsaCreateAttribute): "attribute_parameters": "attributeParameters", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -111,12 +107,10 @@ def __init__( attribute_parameters: "list[GsaSlimEntity] | None | Unset_Type" = Unset, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreatePointAttribute - a model defined in Swagger @@ -128,23 +122,19 @@ def __init__( attribute_parameters: list[GsaSlimEntity] | None, optional axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._is_multi_valued: bool | Unset_Type = Unset self._unit: GsaSlimEntity | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_layout_item.py deleted file mode 100644 index f172326f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_layout_item.py +++ /dev/null @@ -1,174 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_layout_item import ( # noqa: F401 - GsaPutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePutLayoutItem(GsaPutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaNewLayoutItemType", - } - - discriminator_value_class_map = { - "attribute".lower(): "#/components/schemas/GsaAttributeCreatePutLayoutItem", - "recordLink".lower(): "#/components/schemas/GsaRecordLinkCreatePutLayoutItem", - "smartLink".lower(): "#/components/schemas/GsaSmartLinkCreatePutLayoutItem", - "crossDatabaseLink".lower(): "#/components/schemas/GsaCrossDatabaseLinkCreatePutLayoutItem", - "associationChain".lower(): "#/components/schemas/GsaAssociationChainCreatePutLayoutItem", - } - - discriminator: Optional[str] = "item_type" - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType", - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - type: GsaPutType - """ - super().__init__(type=type) - self._item_type: GsaNewLayoutItemType - - self.item_type = item_type - - @property - def item_type(self) -> "GsaNewLayoutItemType": - """Gets the item_type of this GsaCreatePutLayoutItem. - - Returns - ------- - GsaNewLayoutItemType - The item_type of this GsaCreatePutLayoutItem. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaNewLayoutItemType") -> None: - """Sets the item_type of this GsaCreatePutLayoutItem. - - Parameters - ---------- - item_type: GsaNewLayoutItemType - The item_type of this GsaCreatePutLayoutItem. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission.py deleted file mode 100644 index 74d06e41..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission.py +++ /dev/null @@ -1,284 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_permission import ( # noqa: F401 - GsaPutPermission, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePutPermission(GsaPutPermission): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "role": "str", - "type": "GsaPutType", - "description": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "role": "role", - "type": "type", - "description": "description", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - role: "str", - type: "GsaPutType" = GsaPutType.CREATE, - description: "str | None | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreatePutPermission - a model defined in Swagger - - Parameters - ---------- - name: str - role: str - type: GsaPutType - description: str | None, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - super().__init__(type=type) - self._name: str - self._role: str - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - - self.name = name - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePutPermission. - - Returns - ------- - str - The name of this GsaCreatePutPermission. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePutPermission. - - Parameters - ---------- - name: str - The name of this GsaCreatePutPermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def role(self) -> "str": - """Gets the role of this GsaCreatePutPermission. - - Returns - ------- - str - The role of this GsaCreatePutPermission. - """ - return self._role - - @role.setter - def role(self, role: "str") -> None: - """Sets the role of this GsaCreatePutPermission. - - Parameters - ---------- - role: str - The role of this GsaCreatePutPermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - # Field is required - if role is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'role', must not be 'Unset'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaCreatePutPermission. - The description of the permission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaCreatePutPermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaCreatePutPermission. - The description of the permission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaCreatePutPermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaCreatePutPermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaCreatePutPermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaCreatePutPermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaCreatePutPermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaCreatePutPermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaCreatePutPermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaCreatePutPermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaCreatePutPermission. - """ - self._unset_message = unset_message - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePutPermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission_category.py deleted file mode 100644 index fb858d37..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_permission_category.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_permission_category import ( # noqa: F401 - GsaPutPermissionCategory, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePutPermissionCategory(GsaPutPermissionCategory): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "permissions": "list[GsaCreatePermission]", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "name": "name", - "permissions": "permissions", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaCreatePermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - permissions: "list[GsaCreatePermission]", - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaCreatePutPermissionCategory - a model defined in Swagger - - Parameters - ---------- - name: str - permissions: list[GsaCreatePermission] - type: GsaPutType - """ - super().__init__(type=type) - self._name: str - self._permissions: list[GsaCreatePermission] - - self.name = name - self.permissions = permissions - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePutPermissionCategory. - - Returns - ------- - str - The name of this GsaCreatePutPermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePutPermissionCategory. - - Parameters - ---------- - name: str - The name of this GsaCreatePutPermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def permissions(self) -> "list[GsaCreatePermission]": - """Gets the permissions of this GsaCreatePutPermissionCategory. - - Returns - ------- - list[GsaCreatePermission] - The permissions of this GsaCreatePutPermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaCreatePermission]") -> None: - """Sets the permissions of this GsaCreatePutPermissionCategory. - - Parameters - ---------- - permissions: list[GsaCreatePermission] - The permissions of this GsaCreatePutPermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - # Field is required - if permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permissions', must not be 'Unset'") - self._permissions = permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePutPermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_quality_system.py deleted file mode 100644 index 76734c3b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_quality_system.py +++ /dev/null @@ -1,227 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateQualitySystem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "type": "GsaQualitySystemType", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "type": "type", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaQualitySystemType", - } - - discriminator_value_class_map = { - "discrete".lower(): "#/components/schemas/GsaCreateDiscreteQualitySystem", - "continuous".lower(): "#/components/schemas/GsaCreateContinuousQualitySystem", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - name: "str", - type: "GsaQualitySystemType", - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaCreateQualitySystem - a model defined in Swagger - - Parameters - ---------- - name: str - type: GsaQualitySystemType - guid: str, optional - """ - self._type: GsaQualitySystemType - self._name: str - self._guid: str | Unset_Type = Unset - - self.type = type - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def type(self) -> "GsaQualitySystemType": - """Gets the type of this GsaCreateQualitySystem. - - Returns - ------- - GsaQualitySystemType - The type of this GsaCreateQualitySystem. - """ - return self._type - - @type.setter - def type(self, type: "GsaQualitySystemType") -> None: - """Sets the type of this GsaCreateQualitySystem. - - Parameters - ---------- - type: GsaQualitySystemType - The type of this GsaCreateQualitySystem. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def name(self) -> "str": - """Gets the name of this GsaCreateQualitySystem. - - Returns - ------- - str - The name of this GsaCreateQualitySystem. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreateQualitySystem. - - Parameters - ---------- - name: str - The name of this GsaCreateQualitySystem. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreateQualitySystem. - - Returns - ------- - str | Unset_Type - The guid of this GsaCreateQualitySystem. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreateQualitySystem. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaCreateQualitySystem. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_range_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_range_attribute.py index fce633cb..a56b7f59 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_range_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_range_attribute.py @@ -70,11 +70,9 @@ class GsaCreateRangeAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -83,11 +81,9 @@ class GsaCreateRangeAttribute(GsaCreateAttribute): "type": "type", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -105,11 +101,9 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.RANGE, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateRangeAttribute - a model defined in Swagger @@ -120,22 +114,18 @@ def __init__( type: GsaAttributeType axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._unit: GsaSlimEntity | Unset_Type = Unset self._axis_name: GsaCreateAxisName | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_record_link_group.py index e7255108..a7350791 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_record_link_group.py @@ -63,6 +63,7 @@ class GsaCreateRecordLinkGroup(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -70,6 +71,7 @@ class GsaCreateRecordLinkGroup(ModelBase): } attribute_map: dict[str, str] = { + "link_target": "linkTarget", "name": "name", "reverse_name": "reverseName", "type": "type", @@ -78,11 +80,12 @@ class GsaCreateRecordLinkGroup(ModelBase): subtype_mapping: dict[str, str] = { "type": "GsaRecordLinkGroupType", + "linkTarget": "GsaLinkTarget", } discriminator_value_class_map = { "static".lower(): "#/components/schemas/GsaCreateStaticRecordLinkGroup", - "smart".lower(): "#/components/schemas/GsaCreateSmartRecordLinkGroup", + "dynamic".lower(): "#/components/schemas/GsaCreateDynamicRecordLinkGroup", "crossDatabase".lower(): "#/components/schemas/GsaCreateCrossDatabaseRecordLinkGroup", } @@ -91,6 +94,7 @@ class GsaCreateRecordLinkGroup(ModelBase): def __init__( self, *, + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", type: "GsaRecordLinkGroupType", @@ -100,17 +104,20 @@ def __init__( Parameters ---------- + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType guid: str, optional """ self._type: GsaRecordLinkGroupType + self._link_target: GsaLinkTarget self._reverse_name: str self._name: str self._guid: str | Unset_Type = Unset self.type = type + self.link_target = link_target self.reverse_name = reverse_name self.name = name if guid is not Unset: @@ -144,6 +151,34 @@ def type(self, type: "GsaRecordLinkGroupType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def link_target(self) -> "GsaLinkTarget": + """Gets the link_target of this GsaCreateRecordLinkGroup. + + Returns + ------- + GsaLinkTarget + The link_target of this GsaCreateRecordLinkGroup. + """ + return self._link_target + + @link_target.setter + def link_target(self, link_target: "GsaLinkTarget") -> None: + """Sets the link_target of this GsaCreateRecordLinkGroup. + + Parameters + ---------- + link_target: GsaLinkTarget + The link_target of this GsaCreateRecordLinkGroup. + """ + # Field is not nullable + if link_target is None: + raise ValueError("Invalid value for 'link_target', must not be 'None'") + # Field is required + if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'link_target', must not be 'Unset'") + self._link_target = link_target + @property def reverse_name(self) -> "str": """Gets the reverse_name of this GsaCreateRecordLinkGroup. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_search_request.py similarity index 63% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section_filter.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_search_request.py index 9ce4a1fe..8852ddc2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section_filter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_search_request.py @@ -42,7 +42,7 @@ from . import * -class GsaQueryLayoutSectionFilter(ModelBase): +class GsaCreateSearchRequest(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,17 +61,17 @@ class GsaQueryLayoutSectionFilter(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "name": "str", - "section_items": "GsaQueryLayoutItemFilter", + "detail": "GsaSearchDetail", + "search_config": "str", } attribute_map: dict[str, str] = { - "name": "name", - "section_items": "sectionItems", + "detail": "detail", + "search_config": "searchConfig", } subtype_mapping: dict[str, str] = { - "sectionItems": "GsaQueryLayoutItemFilter", + "detail": "GsaSearchDetail", } discriminator: Optional[str] = None @@ -79,70 +79,70 @@ class GsaQueryLayoutSectionFilter(ModelBase): def __init__( self, *, - name: "str | None | Unset_Type" = Unset, - section_items: "GsaQueryLayoutItemFilter | Unset_Type" = Unset, + detail: "GsaSearchDetail | Unset_Type" = Unset, + search_config: "str | None | Unset_Type" = Unset, ) -> None: - """GsaQueryLayoutSectionFilter - a model defined in Swagger + """GsaCreateSearchRequest - a model defined in Swagger Parameters ---------- - name: str | None, optional - section_items: GsaQueryLayoutItemFilter, optional + detail: GsaSearchDetail, optional + search_config: str | None, optional """ - self._name: str | None | Unset_Type = Unset - self._section_items: GsaQueryLayoutItemFilter | Unset_Type = Unset + self._search_config: str | None | Unset_Type = Unset + self._detail: GsaSearchDetail | Unset_Type = Unset - if name is not Unset: - self.name = name - if section_items is not Unset: - self.section_items = section_items + if search_config is not Unset: + self.search_config = search_config + if detail is not Unset: + self.detail = detail @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayoutSectionFilter. + def search_config(self) -> "str | None | Unset_Type": + """Gets the search_config of this GsaCreateSearchRequest. Returns ------- str | None | Unset_Type - The name of this GsaQueryLayoutSectionFilter. + The search_config of this GsaCreateSearchRequest. """ - return self._name + return self._search_config - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutSectionFilter. + @search_config.setter + def search_config(self, search_config: "str | None | Unset_Type") -> None: + """Sets the search_config of this GsaCreateSearchRequest. Parameters ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayoutSectionFilter. + search_config: str | None | Unset_Type + The search_config of this GsaCreateSearchRequest. """ - self._name = name + self._search_config = search_config @property - def section_items(self) -> "GsaQueryLayoutItemFilter | Unset_Type": - """Gets the section_items of this GsaQueryLayoutSectionFilter. + def detail(self) -> "GsaSearchDetail | Unset_Type": + """Gets the detail of this GsaCreateSearchRequest. Returns ------- - GsaQueryLayoutItemFilter | Unset_Type - The section_items of this GsaQueryLayoutSectionFilter. + GsaSearchDetail | Unset_Type + The detail of this GsaCreateSearchRequest. """ - return self._section_items + return self._detail - @section_items.setter - def section_items(self, section_items: "GsaQueryLayoutItemFilter | Unset_Type") -> None: - """Sets the section_items of this GsaQueryLayoutSectionFilter. + @detail.setter + def detail(self, detail: "GsaSearchDetail | Unset_Type") -> None: + """Sets the detail of this GsaCreateSearchRequest. Parameters ---------- - section_items: GsaQueryLayoutItemFilter | Unset_Type - The section_items of this GsaQueryLayoutSectionFilter. + detail: GsaSearchDetail | Unset_Type + The detail of this GsaCreateSearchRequest. """ # Field is not nullable - if section_items is None: - raise ValueError("Invalid value for 'section_items', must not be 'None'") - self._section_items = section_items + if detail is None: + raise ValueError("Invalid value for 'detail', must not be 'None'") + self._detail = detail @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -166,7 +166,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionFilter): + if not isinstance(other, GsaCreateSearchRequest): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_short_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_short_text_attribute.py index cfd6b3af..0a16ce85 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_short_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_short_text_attribute.py @@ -70,12 +70,10 @@ class GsaCreateShortTextAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "data_rule": "GsaSlimEntity", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_unique": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -83,12 +81,10 @@ class GsaCreateShortTextAttribute(GsaCreateAttribute): "type": "type", "data_rule": "dataRule", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_unique": "isUnique", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -104,12 +100,10 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.SHORTTEXT, data_rule: "GsaSlimEntity | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_unique: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateShortTextAttribute - a model defined in Swagger @@ -119,22 +113,18 @@ def __init__( type: GsaAttributeType data_rule: GsaSlimEntity, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_unique: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._is_unique: bool | Unset_Type = Unset self._data_rule: GsaSlimEntity | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_smart_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_smart_link_target.py deleted file mode 100644 index 51f75f61..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_smart_link_target.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateSmartLinkTarget(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - ) -> None: - """GsaCreateSmartLinkTarget - a model defined in Swagger - - Parameters - ---------- - table_guid: str - """ - self._table_guid: str - - self.table_guid = table_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaCreateSmartLinkTarget. - - Returns - ------- - str - The table_guid of this GsaCreateSmartLinkTarget. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaCreateSmartLinkTarget. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaCreateSmartLinkTarget. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateSmartLinkTarget): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_standard_name.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_standard_name.py index 8044b034..7ef2e3cf 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_standard_name.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_standard_name.py @@ -66,7 +66,7 @@ class GsaCreateStandardName(ModelBase): "mapped_attributes": "list[GsaSlimEntity]", "mapped_cross_database_record_link_groups": "list[GsaSlimEntity]", "mapped_parameters": "list[GsaSlimEntity]", - "mapped_static_record_link_groups": "list[GsaCreateStaticRecordLinkGroupMapping]", + "mapped_record_link_groups": "list[GsaSlimEntity]", } attribute_map: dict[str, str] = { @@ -75,13 +75,13 @@ class GsaCreateStandardName(ModelBase): "mapped_attributes": "mappedAttributes", "mapped_cross_database_record_link_groups": "mappedCrossDatabaseRecordLinkGroups", "mapped_parameters": "mappedParameters", - "mapped_static_record_link_groups": "mappedStaticRecordLinkGroups", + "mapped_record_link_groups": "mappedRecordLinkGroups", } subtype_mapping: dict[str, str] = { "mappedAttributes": "GsaSlimEntity", "mappedParameters": "GsaSlimEntity", - "mappedStaticRecordLinkGroups": "GsaCreateStaticRecordLinkGroupMapping", + "mappedRecordLinkGroups": "GsaSlimEntity", "mappedCrossDatabaseRecordLinkGroups": "GsaSlimEntity", } @@ -95,7 +95,7 @@ def __init__( mapped_attributes: "list[GsaSlimEntity] | None | Unset_Type" = Unset, mapped_cross_database_record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, mapped_parameters: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - mapped_static_record_link_groups: "list[GsaCreateStaticRecordLinkGroupMapping] | None | Unset_Type" = Unset, + mapped_record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, ) -> None: """GsaCreateStandardName - a model defined in Swagger @@ -106,13 +106,11 @@ def __init__( mapped_attributes: list[GsaSlimEntity] | None, optional mapped_cross_database_record_link_groups: list[GsaSlimEntity] | None, optional mapped_parameters: list[GsaSlimEntity] | None, optional - mapped_static_record_link_groups: list[GsaCreateStaticRecordLinkGroupMapping] | None, optional + mapped_record_link_groups: list[GsaSlimEntity] | None, optional """ self._mapped_attributes: list[GsaSlimEntity] | None | Unset_Type = Unset self._mapped_parameters: list[GsaSlimEntity] | None | Unset_Type = Unset - self._mapped_static_record_link_groups: ( - list[GsaCreateStaticRecordLinkGroupMapping] | None | Unset_Type - ) = Unset + self._mapped_record_link_groups: list[GsaSlimEntity] | None | Unset_Type = Unset self._mapped_cross_database_record_link_groups: list[GsaSlimEntity] | None | Unset_Type = ( Unset ) @@ -123,8 +121,8 @@ def __init__( self.mapped_attributes = mapped_attributes if mapped_parameters is not Unset: self.mapped_parameters = mapped_parameters - if mapped_static_record_link_groups is not Unset: - self.mapped_static_record_link_groups = mapped_static_record_link_groups + if mapped_record_link_groups is not Unset: + self.mapped_record_link_groups = mapped_record_link_groups if mapped_cross_database_record_link_groups is not Unset: self.mapped_cross_database_record_link_groups = mapped_cross_database_record_link_groups self.name = name @@ -180,31 +178,28 @@ def mapped_parameters( self._mapped_parameters = mapped_parameters @property - def mapped_static_record_link_groups( - self, - ) -> "list[GsaCreateStaticRecordLinkGroupMapping] | None | Unset_Type": - """Gets the mapped_static_record_link_groups of this GsaCreateStandardName. + def mapped_record_link_groups(self) -> "list[GsaSlimEntity] | None | Unset_Type": + """Gets the mapped_record_link_groups of this GsaCreateStandardName. Returns ------- - list[GsaCreateStaticRecordLinkGroupMapping] | None | Unset_Type - The mapped_static_record_link_groups of this GsaCreateStandardName. + list[GsaSlimEntity] | None | Unset_Type + The mapped_record_link_groups of this GsaCreateStandardName. """ - return self._mapped_static_record_link_groups + return self._mapped_record_link_groups - @mapped_static_record_link_groups.setter - def mapped_static_record_link_groups( - self, - mapped_static_record_link_groups: "list[GsaCreateStaticRecordLinkGroupMapping] | None | Unset_Type", + @mapped_record_link_groups.setter + def mapped_record_link_groups( + self, mapped_record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" ) -> None: - """Sets the mapped_static_record_link_groups of this GsaCreateStandardName. + """Sets the mapped_record_link_groups of this GsaCreateStandardName. Parameters ---------- - mapped_static_record_link_groups: list[GsaCreateStaticRecordLinkGroupMapping] | None | Unset_Type - The mapped_static_record_link_groups of this GsaCreateStandardName. + mapped_record_link_groups: list[GsaSlimEntity] | None | Unset_Type + The mapped_record_link_groups of this GsaCreateStandardName. """ - self._mapped_static_record_link_groups = mapped_static_record_link_groups + self._mapped_record_link_groups = mapped_record_link_groups @property def mapped_cross_database_record_link_groups(self) -> "list[GsaSlimEntity] | None | Unset_Type": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_link_target.py deleted file mode 100644 index 3410b29e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_link_target.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateStaticLinkTarget(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - ) -> None: - """GsaCreateStaticLinkTarget - a model defined in Swagger - - Parameters - ---------- - table_guid: str - """ - self._table_guid: str - - self.table_guid = table_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaCreateStaticLinkTarget. - - Returns - ------- - str - The table_guid of this GsaCreateStaticLinkTarget. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaCreateStaticLinkTarget. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaCreateStaticLinkTarget. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateStaticLinkTarget): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group.py index 564fddc7..f3cb1e75 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group.py @@ -68,7 +68,7 @@ class GsaCreateStaticRecordLinkGroup(GsaCreateRecordLinkGroup): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "link_target": "GsaCreateStaticLinkTarget", + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -85,16 +85,14 @@ class GsaCreateStaticRecordLinkGroup(GsaCreateRecordLinkGroup): "include_indirect_links": "includeIndirectLinks", } - subtype_mapping: dict[str, str] = { - "linkTarget": "GsaCreateStaticLinkTarget", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - link_target: "GsaCreateStaticLinkTarget", + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.STATIC, @@ -105,49 +103,21 @@ def __init__( Parameters ---------- - link_target: GsaCreateStaticLinkTarget + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType guid: str, optional include_indirect_links: bool, optional """ - super().__init__(name=name, reverse_name=reverse_name, type=type, guid=guid) - self._link_target: GsaCreateStaticLinkTarget + super().__init__( + link_target=link_target, name=name, reverse_name=reverse_name, type=type, guid=guid + ) self._include_indirect_links: bool | Unset_Type = Unset - self.link_target = link_target if include_indirect_links is not Unset: self.include_indirect_links = include_indirect_links - @property - def link_target(self) -> "GsaCreateStaticLinkTarget": - """Gets the link_target of this GsaCreateStaticRecordLinkGroup. - - Returns - ------- - GsaCreateStaticLinkTarget - The link_target of this GsaCreateStaticRecordLinkGroup. - """ - return self._link_target - - @link_target.setter - def link_target(self, link_target: "GsaCreateStaticLinkTarget") -> None: - """Sets the link_target of this GsaCreateStaticRecordLinkGroup. - - Parameters - ---------- - link_target: GsaCreateStaticLinkTarget - The link_target of this GsaCreateStaticRecordLinkGroup. - """ - # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") - # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target - @property def include_indirect_links(self) -> "bool | Unset_Type": """Gets the include_indirect_links of this GsaCreateStaticRecordLinkGroup. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group_mapping.py deleted file mode 100644 index a70ec6dc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_static_record_link_group_mapping.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateStaticRecordLinkGroupMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "is_reverse": "bool", - "static_record_link_group": "GsaSlimEntity", - } - - attribute_map: dict[str, str] = { - "is_reverse": "isReverse", - "static_record_link_group": "staticRecordLinkGroup", - } - - subtype_mapping: dict[str, str] = { - "staticRecordLinkGroup": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - is_reverse: "bool", - static_record_link_group: "GsaSlimEntity", - ) -> None: - """GsaCreateStaticRecordLinkGroupMapping - a model defined in Swagger - - Parameters - ---------- - is_reverse: bool - static_record_link_group: GsaSlimEntity - """ - self._static_record_link_group: GsaSlimEntity - self._is_reverse: bool - - self.static_record_link_group = static_record_link_group - self.is_reverse = is_reverse - - @property - def static_record_link_group(self) -> "GsaSlimEntity": - """Gets the static_record_link_group of this GsaCreateStaticRecordLinkGroupMapping. - - Returns - ------- - GsaSlimEntity - The static_record_link_group of this GsaCreateStaticRecordLinkGroupMapping. - """ - return self._static_record_link_group - - @static_record_link_group.setter - def static_record_link_group(self, static_record_link_group: "GsaSlimEntity") -> None: - """Sets the static_record_link_group of this GsaCreateStaticRecordLinkGroupMapping. - - Parameters - ---------- - static_record_link_group: GsaSlimEntity - The static_record_link_group of this GsaCreateStaticRecordLinkGroupMapping. - """ - # Field is not nullable - if static_record_link_group is None: - raise ValueError("Invalid value for 'static_record_link_group', must not be 'None'") - # Field is required - if static_record_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'static_record_link_group', must not be 'Unset'") - self._static_record_link_group = static_record_link_group - - @property - def is_reverse(self) -> "bool": - """Gets the is_reverse of this GsaCreateStaticRecordLinkGroupMapping. - - Returns - ------- - bool - The is_reverse of this GsaCreateStaticRecordLinkGroupMapping. - """ - return self._is_reverse - - @is_reverse.setter - def is_reverse(self, is_reverse: "bool") -> None: - """Sets the is_reverse of this GsaCreateStaticRecordLinkGroupMapping. - - Parameters - ---------- - is_reverse: bool - The is_reverse of this GsaCreateStaticRecordLinkGroupMapping. - """ - # Field is not nullable - if is_reverse is None: - raise ValueError("Invalid value for 'is_reverse', must not be 'None'") - # Field is required - if is_reverse is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_reverse', must not be 'Unset'") - self._is_reverse = is_reverse - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateStaticRecordLinkGroupMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_table.py index 8a83959c..4f4382f8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_table.py @@ -62,33 +62,19 @@ class GsaCreateTable(ModelBase): """ swagger_types: dict[str, str] = { "name": "str", - "datasheet_footer": "str", - "datasheet_header": "str", "guid": "str", "is_hidden_from_browse": "bool", "is_hidden_from_search": "bool", - "legal_disclaimer": "str", - "quality_system": "GsaSlimEntity", - "should_show_version_control_signatures": "bool", - "table_types": "list[str]", } attribute_map: dict[str, str] = { "name": "name", - "datasheet_footer": "datasheetFooter", - "datasheet_header": "datasheetHeader", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", "is_hidden_from_search": "isHiddenFromSearch", - "legal_disclaimer": "legalDisclaimer", - "quality_system": "qualitySystem", - "should_show_version_control_signatures": "shouldShowVersionControlSignatures", - "table_types": "tableTypes", } - subtype_mapping: dict[str, str] = { - "qualitySystem": "GsaSlimEntity", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -96,39 +82,21 @@ def __init__( self, *, name: "str", - datasheet_footer: "str | None | Unset_Type" = Unset, - datasheet_header: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, is_hidden_from_browse: "bool | Unset_Type" = Unset, is_hidden_from_search: "bool | Unset_Type" = Unset, - legal_disclaimer: "str | None | Unset_Type" = Unset, - quality_system: "GsaSlimEntity | Unset_Type" = Unset, - should_show_version_control_signatures: "bool | Unset_Type" = Unset, - table_types: "list[str] | None | Unset_Type" = Unset, ) -> None: """GsaCreateTable - a model defined in Swagger Parameters ---------- name: str - datasheet_footer: str | None, optional - datasheet_header: str | None, optional guid: str, optional is_hidden_from_browse: bool, optional is_hidden_from_search: bool, optional - legal_disclaimer: str | None, optional - quality_system: GsaSlimEntity, optional - should_show_version_control_signatures: bool, optional - table_types: list[str] | None, optional """ self._is_hidden_from_browse: bool | Unset_Type = Unset self._is_hidden_from_search: bool | Unset_Type = Unset - self._legal_disclaimer: str | None | Unset_Type = Unset - self._datasheet_header: str | None | Unset_Type = Unset - self._datasheet_footer: str | None | Unset_Type = Unset - self._table_types: list[str] | None | Unset_Type = Unset - self._should_show_version_control_signatures: bool | Unset_Type = Unset - self._quality_system: GsaSlimEntity | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset @@ -136,18 +104,6 @@ def __init__( self.is_hidden_from_browse = is_hidden_from_browse if is_hidden_from_search is not Unset: self.is_hidden_from_search = is_hidden_from_search - if legal_disclaimer is not Unset: - self.legal_disclaimer = legal_disclaimer - if datasheet_header is not Unset: - self.datasheet_header = datasheet_header - if datasheet_footer is not Unset: - self.datasheet_footer = datasheet_footer - if table_types is not Unset: - self.table_types = table_types - if should_show_version_control_signatures is not Unset: - self.should_show_version_control_signatures = should_show_version_control_signatures - if quality_system is not Unset: - self.quality_system = quality_system self.name = name if guid is not Unset: self.guid = guid @@ -202,148 +158,6 @@ def is_hidden_from_search(self, is_hidden_from_search: "bool | Unset_Type") -> N raise ValueError("Invalid value for 'is_hidden_from_search', must not be 'None'") self._is_hidden_from_search = is_hidden_from_search - @property - def legal_disclaimer(self) -> "str | None | Unset_Type": - """Gets the legal_disclaimer of this GsaCreateTable. - - Returns - ------- - str | None | Unset_Type - The legal_disclaimer of this GsaCreateTable. - """ - return self._legal_disclaimer - - @legal_disclaimer.setter - def legal_disclaimer(self, legal_disclaimer: "str | None | Unset_Type") -> None: - """Sets the legal_disclaimer of this GsaCreateTable. - - Parameters - ---------- - legal_disclaimer: str | None | Unset_Type - The legal_disclaimer of this GsaCreateTable. - """ - self._legal_disclaimer = legal_disclaimer - - @property - def datasheet_header(self) -> "str | None | Unset_Type": - """Gets the datasheet_header of this GsaCreateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_header of this GsaCreateTable. - """ - return self._datasheet_header - - @datasheet_header.setter - def datasheet_header(self, datasheet_header: "str | None | Unset_Type") -> None: - """Sets the datasheet_header of this GsaCreateTable. - - Parameters - ---------- - datasheet_header: str | None | Unset_Type - The datasheet_header of this GsaCreateTable. - """ - self._datasheet_header = datasheet_header - - @property - def datasheet_footer(self) -> "str | None | Unset_Type": - """Gets the datasheet_footer of this GsaCreateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_footer of this GsaCreateTable. - """ - return self._datasheet_footer - - @datasheet_footer.setter - def datasheet_footer(self, datasheet_footer: "str | None | Unset_Type") -> None: - """Sets the datasheet_footer of this GsaCreateTable. - - Parameters - ---------- - datasheet_footer: str | None | Unset_Type - The datasheet_footer of this GsaCreateTable. - """ - self._datasheet_footer = datasheet_footer - - @property - def table_types(self) -> "list[str] | None | Unset_Type": - """Gets the table_types of this GsaCreateTable. - - Returns - ------- - list[str] | None | Unset_Type - The table_types of this GsaCreateTable. - """ - return self._table_types - - @table_types.setter - def table_types(self, table_types: "list[str] | None | Unset_Type") -> None: - """Sets the table_types of this GsaCreateTable. - - Parameters - ---------- - table_types: list[str] | None | Unset_Type - The table_types of this GsaCreateTable. - """ - self._table_types = table_types - - @property - def should_show_version_control_signatures(self) -> "bool | Unset_Type": - """Gets the should_show_version_control_signatures of this GsaCreateTable. - - Returns - ------- - bool | Unset_Type - The should_show_version_control_signatures of this GsaCreateTable. - """ - return self._should_show_version_control_signatures - - @should_show_version_control_signatures.setter - def should_show_version_control_signatures( - self, should_show_version_control_signatures: "bool | Unset_Type" - ) -> None: - """Sets the should_show_version_control_signatures of this GsaCreateTable. - - Parameters - ---------- - should_show_version_control_signatures: bool | Unset_Type - The should_show_version_control_signatures of this GsaCreateTable. - """ - # Field is not nullable - if should_show_version_control_signatures is None: - raise ValueError( - "Invalid value for 'should_show_version_control_signatures', must not be 'None'" - ) - self._should_show_version_control_signatures = should_show_version_control_signatures - - @property - def quality_system(self) -> "GsaSlimEntity | Unset_Type": - """Gets the quality_system of this GsaCreateTable. - - Returns - ------- - GsaSlimEntity | Unset_Type - The quality_system of this GsaCreateTable. - """ - return self._quality_system - - @quality_system.setter - def quality_system(self, quality_system: "GsaSlimEntity | Unset_Type") -> None: - """Sets the quality_system of this GsaCreateTable. - - Parameters - ---------- - quality_system: GsaSlimEntity | Unset_Type - The quality_system of this GsaCreateTable. - """ - # Field is not nullable - if quality_system is None: - raise ValueError("Invalid value for 'quality_system', must not be 'None'") - self._quality_system = quality_system - @property def name(self) -> "str": """Gets the name of this GsaCreateTable. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_tabular_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_tabular_attribute.py index 22d3d945..5dd15b62 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_tabular_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_tabular_attribute.py @@ -70,13 +70,11 @@ class GsaCreateTabularAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", "display_full_table": "bool", - "display_names": "dict(str, str)", "display_summary_row_inline": "bool", "guid": "str", "help_path": "str", "hide_unlinked_rows": "bool", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "tabular_columns": "list[GsaCreateTabularColumn]", "target": "GsaTabularAttributeTarget", } @@ -86,13 +84,11 @@ class GsaCreateTabularAttribute(GsaCreateAttribute): "type": "type", "default_threshold_type": "defaultThresholdType", "display_full_table": "displayFullTable", - "display_names": "displayNames", "display_summary_row_inline": "displaySummaryRowInline", "guid": "guid", "help_path": "helpPath", "hide_unlinked_rows": "hideUnlinkedRows", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", "tabular_columns": "tabularColumns", "target": "target", } @@ -111,13 +107,11 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.LINK, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, display_full_table: "bool | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, display_summary_row_inline: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, hide_unlinked_rows: "bool | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, tabular_columns: "list[GsaCreateTabularColumn] | None | Unset_Type" = Unset, target: "GsaTabularAttributeTarget | Unset_Type" = Unset, ) -> None: @@ -129,13 +123,11 @@ def __init__( type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional display_full_table: bool, optional - display_names: dict[str, str] | None, optional display_summary_row_inline: bool, optional guid: str, optional help_path: str | None, optional hide_unlinked_rows: bool, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional tabular_columns: list[GsaCreateTabularColumn] | None, optional target: GsaTabularAttributeTarget, optional """ @@ -143,11 +135,9 @@ def __init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._display_full_table: bool | Unset_Type = Unset self._display_summary_row_inline: bool | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_mapping.py deleted file mode 100644 index 6378a6cd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_mapping.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateUnitMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "equivalent_unit": "GsaSlimEntity", - "unit": "GsaSlimEntity", - } - - attribute_map: dict[str, str] = { - "equivalent_unit": "equivalentUnit", - "unit": "unit", - } - - subtype_mapping: dict[str, str] = { - "unit": "GsaSlimEntity", - "equivalentUnit": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - equivalent_unit: "GsaSlimEntity", - unit: "GsaSlimEntity", - ) -> None: - """GsaCreateUnitMapping - a model defined in Swagger - - Parameters - ---------- - equivalent_unit: GsaSlimEntity - unit: GsaSlimEntity - """ - self._unit: GsaSlimEntity - self._equivalent_unit: GsaSlimEntity - - self.unit = unit - self.equivalent_unit = equivalent_unit - - @property - def unit(self) -> "GsaSlimEntity": - """Gets the unit of this GsaCreateUnitMapping. - - Returns - ------- - GsaSlimEntity - The unit of this GsaCreateUnitMapping. - """ - return self._unit - - @unit.setter - def unit(self, unit: "GsaSlimEntity") -> None: - """Sets the unit of this GsaCreateUnitMapping. - - Parameters - ---------- - unit: GsaSlimEntity - The unit of this GsaCreateUnitMapping. - """ - # Field is not nullable - if unit is None: - raise ValueError("Invalid value for 'unit', must not be 'None'") - # Field is required - if unit is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unit', must not be 'Unset'") - self._unit = unit - - @property - def equivalent_unit(self) -> "GsaSlimEntity": - """Gets the equivalent_unit of this GsaCreateUnitMapping. - - Returns - ------- - GsaSlimEntity - The equivalent_unit of this GsaCreateUnitMapping. - """ - return self._equivalent_unit - - @equivalent_unit.setter - def equivalent_unit(self, equivalent_unit: "GsaSlimEntity") -> None: - """Sets the equivalent_unit of this GsaCreateUnitMapping. - - Parameters - ---------- - equivalent_unit: GsaSlimEntity - The equivalent_unit of this GsaCreateUnitMapping. - """ - # Field is not nullable - if equivalent_unit is None: - raise ValueError("Invalid value for 'equivalent_unit', must not be 'None'") - # Field is required - if equivalent_unit is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'equivalent_unit', must not be 'Unset'") - self._equivalent_unit = equivalent_unit - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateUnitMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_system.py index d32c8538..69795003 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_system.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_unit_system.py @@ -63,18 +63,14 @@ class GsaCreateUnitSystem(ModelBase): swagger_types: dict[str, str] = { "name": "str", "guid": "str", - "unit_mappings": "list[GsaCreateUnitMapping]", } attribute_map: dict[str, str] = { "name": "name", "guid": "guid", - "unit_mappings": "unitMappings", } - subtype_mapping: dict[str, str] = { - "unitMappings": "GsaCreateUnitMapping", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -83,7 +79,6 @@ def __init__( *, name: "str", guid: "str | Unset_Type" = Unset, - unit_mappings: "list[GsaCreateUnitMapping] | None | Unset_Type" = Unset, ) -> None: """GsaCreateUnitSystem - a model defined in Swagger @@ -91,44 +86,14 @@ def __init__( ---------- name: str guid: str, optional - unit_mappings: list[GsaCreateUnitMapping] | None, optional """ - self._unit_mappings: list[GsaCreateUnitMapping] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset - if unit_mappings is not Unset: - self.unit_mappings = unit_mappings self.name = name if guid is not Unset: self.guid = guid - @property - def unit_mappings(self) -> "list[GsaCreateUnitMapping] | None | Unset_Type": - """Gets the unit_mappings of this GsaCreateUnitSystem. - Unit mappings will default to each unit being mapped to itself but optionally one or more non-default mappings can be specified here. - - Returns - ------- - list[GsaCreateUnitMapping] | None | Unset_Type - The unit_mappings of this GsaCreateUnitSystem. - """ - return self._unit_mappings - - @unit_mappings.setter - def unit_mappings( - self, unit_mappings: "list[GsaCreateUnitMapping] | None | Unset_Type" - ) -> None: - """Sets the unit_mappings of this GsaCreateUnitSystem. - Unit mappings will default to each unit being mapped to itself but optionally one or more non-default mappings can be specified here. - - Parameters - ---------- - unit_mappings: list[GsaCreateUnitMapping] | None | Unset_Type - The unit_mappings of this GsaCreateUnitSystem. - """ - self._unit_mappings = unit_mappings - @property def name(self) -> "str": """Gets the name of this GsaCreateUnitSystem. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link.py deleted file mode 100644 index 42f7b277..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link.py +++ /dev/null @@ -1,189 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "include_indirect_links": "bool", - "link_info": "GsaLinkInfo", - "name": "str", - "reverse_name": "str", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "include_indirect_links": "includeIndirectLinks", - "link_info": "linkInfo", - "name": "name", - "reverse_name": "reverseName", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - include_indirect_links: "bool", - link_info: "GsaLinkInfo", - name: "str", - reverse_name: "str", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.CROSSDATABASELINK, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaCrossDatabaseLink - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - include_indirect_links: bool - link_info: GsaLinkInfo - name: str - reverse_name: str - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._include_indirect_links: bool - - self.include_indirect_links = include_indirect_links - - @property - def include_indirect_links(self) -> "bool": - """Gets the include_indirect_links of this GsaCrossDatabaseLink. - - Returns - ------- - bool - The include_indirect_links of this GsaCrossDatabaseLink. - """ - return self._include_indirect_links - - @include_indirect_links.setter - def include_indirect_links(self, include_indirect_links: "bool") -> None: - """Sets the include_indirect_links of this GsaCrossDatabaseLink. - - Parameters - ---------- - include_indirect_links: bool - The include_indirect_links of this GsaCrossDatabaseLink. - """ - # Field is not nullable - if include_indirect_links is None: - raise ValueError("Invalid value for 'include_indirect_links', must not be 'None'") - # Field is required - if include_indirect_links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'include_indirect_links', must not be 'Unset'") - self._include_indirect_links = include_indirect_links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link_create_put_layout_item.py deleted file mode 100644 index 84c2e4ec..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_link_create_put_layout_item.py +++ /dev/null @@ -1,232 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseLinkCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "link_group_guid": "str", - "source_database_guid": "str", - "source_table_guid": "str", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "link_group_guid": "linkGroupGuid", - "source_database_guid": "sourceDatabaseGuid", - "source_table_guid": "sourceTableGuid", - "type": "type", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.CROSSDATABASELINK, - link_group_guid: "str", - source_database_guid: "str", - source_table_guid: "str", - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaCrossDatabaseLinkCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - link_group_guid: str - source_database_guid: str - source_table_guid: str - type: GsaPutType - """ - super().__init__(item_type=item_type, type=type) - self._source_database_guid: str - self._source_table_guid: str - self._link_group_guid: str - - self.source_database_guid = source_database_guid - self.source_table_guid = source_table_guid - self.link_group_guid = link_group_guid - - @property - def source_database_guid(self) -> "str": - """Gets the source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Returns - ------- - str - The source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - return self._source_database_guid - - @source_database_guid.setter - def source_database_guid(self, source_database_guid: "str") -> None: - """Sets the source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Parameters - ---------- - source_database_guid: str - The source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - # Field is not nullable - if source_database_guid is None: - raise ValueError("Invalid value for 'source_database_guid', must not be 'None'") - # Field is required - if source_database_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_database_guid', must not be 'Unset'") - self._source_database_guid = source_database_guid - - @property - def source_table_guid(self) -> "str": - """Gets the source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Returns - ------- - str - The source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - return self._source_table_guid - - @source_table_guid.setter - def source_table_guid(self, source_table_guid: "str") -> None: - """Sets the source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Parameters - ---------- - source_table_guid: str - The source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - # Field is not nullable - if source_table_guid is None: - raise ValueError("Invalid value for 'source_table_guid', must not be 'None'") - # Field is required - if source_table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_table_guid', must not be 'Unset'") - self._source_table_guid = source_table_guid - - @property - def link_group_guid(self) -> "str": - """Gets the link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Returns - ------- - str - The link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - return self._link_group_guid - - @link_group_guid.setter - def link_group_guid(self, link_group_guid: "str") -> None: - """Sets the link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Parameters - ---------- - link_group_guid: str - The link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - # Field is not nullable - if link_group_guid is None: - raise ValueError("Invalid value for 'link_group_guid', must not be 'None'") - # Field is required - if link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_group_guid', must not be 'Unset'") - self._link_group_guid = link_group_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseLinkCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link.py deleted file mode 100644 index 6cb96757..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link.py +++ /dev/null @@ -1,176 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_base import ( # noqa: F401 - GsaRecordLinkBase, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseRecordLink(GsaRecordLinkBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "record_link_group_type": "GsaRecordLinkGroupType", - "source_record_history_guid": "str", - "target_record_history_guid": "str", - "notes": "str", - "reverse_notes": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "record_link_group_type": "recordLinkGroupType", - "source_record_history_guid": "sourceRecordHistoryGuid", - "target_record_history_guid": "targetRecordHistoryGuid", - "notes": "notes", - "reverse_notes": "reverseNotes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.CROSSDATABASE, - source_record_history_guid: "str", - target_record_history_guid: "str", - notes: "str | None | Unset_Type" = Unset, - reverse_notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCrossDatabaseRecordLink - a model defined in Swagger - - Parameters - ---------- - guid: str - record_link_group_type: GsaRecordLinkGroupType - source_record_history_guid: str - target_record_history_guid: str - notes: str | None, optional - reverse_notes: str | None, optional - """ - super().__init__( - guid=guid, - record_link_group_type=record_link_group_type, - source_record_history_guid=source_record_history_guid, - target_record_history_guid=target_record_history_guid, - notes=notes, - ) - self._reverse_notes: str | None | Unset_Type = Unset - - if reverse_notes is not Unset: - self.reverse_notes = reverse_notes - - @property - def reverse_notes(self) -> "str | None | Unset_Type": - """Gets the reverse_notes of this GsaCrossDatabaseRecordLink. - - Returns - ------- - str | None | Unset_Type - The reverse_notes of this GsaCrossDatabaseRecordLink. - """ - return self._reverse_notes - - @reverse_notes.setter - def reverse_notes(self, reverse_notes: "str | None | Unset_Type") -> None: - """Sets the reverse_notes of this GsaCrossDatabaseRecordLink. - - Parameters - ---------- - reverse_notes: str | None | Unset_Type - The reverse_notes of this GsaCrossDatabaseRecordLink. - """ - self._reverse_notes = reverse_notes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseRecordLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link_result.py deleted file mode 100644 index b63d69b6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_cross_database_record_link_result.py +++ /dev/null @@ -1,192 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_result import ( # noqa: F401 - GsaRecordLinkResult, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseRecordLinkResult(GsaRecordLinkResult): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "linked_database_key": "str", - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "linked_database_key": "linkedDatabaseKey", - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - linked_database_key: "str", - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.CROSSDATABASE, - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCrossDatabaseRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - linked_database_key: str - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - notes: str | None, optional - """ - super().__init__(linked_record=linked_record, record_link_group_type=record_link_group_type) - self._linked_database_key: str - self._notes: str | None | Unset_Type = Unset - - self.linked_database_key = linked_database_key - if notes is not Unset: - self.notes = notes - - @property - def linked_database_key(self) -> "str": - """Gets the linked_database_key of this GsaCrossDatabaseRecordLinkResult. - - Returns - ------- - str - The linked_database_key of this GsaCrossDatabaseRecordLinkResult. - """ - return self._linked_database_key - - @linked_database_key.setter - def linked_database_key(self, linked_database_key: "str") -> None: - """Sets the linked_database_key of this GsaCrossDatabaseRecordLinkResult. - - Parameters - ---------- - linked_database_key: str - The linked_database_key of this GsaCrossDatabaseRecordLinkResult. - """ - # Field is not nullable - if linked_database_key is None: - raise ValueError("Invalid value for 'linked_database_key', must not be 'None'") - # Field is required - if linked_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'linked_database_key', must not be 'Unset'") - self._linked_database_key = linked_database_key - - @property - def notes(self) -> "str | None | Unset_Type": - """Gets the notes of this GsaCrossDatabaseRecordLinkResult. - - Returns - ------- - str | None | Unset_Type - The notes of this GsaCrossDatabaseRecordLinkResult. - """ - return self._notes - - @notes.setter - def notes(self, notes: "str | None | Unset_Type") -> None: - """Sets the notes of this GsaCrossDatabaseRecordLinkResult. - - Parameters - ---------- - notes: str | None | Unset_Type - The notes of this GsaCrossDatabaseRecordLinkResult. - """ - self._notes = notes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currencies_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currencies_info.py deleted file mode 100644 index 3e7fb031..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currencies_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCurrenciesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "currencies": "list[GsaCurrency]", - } - - attribute_map: dict[str, str] = { - "currencies": "currencies", - } - - subtype_mapping: dict[str, str] = { - "currencies": "GsaCurrency", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - currencies: "list[GsaCurrency]", - ) -> None: - """GsaCurrenciesInfo - a model defined in Swagger - - Parameters - ---------- - currencies: list[GsaCurrency] - """ - self._currencies: list[GsaCurrency] - - self.currencies = currencies - - @property - def currencies(self) -> "list[GsaCurrency]": - """Gets the currencies of this GsaCurrenciesInfo. - - Returns - ------- - list[GsaCurrency] - The currencies of this GsaCurrenciesInfo. - """ - return self._currencies - - @currencies.setter - def currencies(self, currencies: "list[GsaCurrency]") -> None: - """Sets the currencies of this GsaCurrenciesInfo. - - Parameters - ---------- - currencies: list[GsaCurrency] - The currencies of this GsaCurrenciesInfo. - """ - # Field is not nullable - if currencies is None: - raise ValueError("Invalid value for 'currencies', must not be 'None'") - # Field is required - if currencies is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'currencies', must not be 'Unset'") - self._currencies = currencies - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCurrenciesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency.py deleted file mode 100644 index ed2f5199..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency.py +++ /dev/null @@ -1,221 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCurrency(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "str", - "factor": "float", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "factor": "factor", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "str", - factor: "float", - name: "str", - ) -> None: - """GsaCurrency - a model defined in Swagger - - Parameters - ---------- - code: str - factor: float - name: str - """ - self._code: str - self._name: str - self._factor: float - - self.code = code - self.name = name - self.factor = factor - - @property - def code(self) -> "str": - """Gets the code of this GsaCurrency. - The code of the currency. - - Returns - ------- - str - The code of this GsaCurrency. - """ - return self._code - - @code.setter - def code(self, code: "str") -> None: - """Sets the code of this GsaCurrency. - The code of the currency. - - Parameters - ---------- - code: str - The code of this GsaCurrency. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - # Field is required - if code is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'code', must not be 'Unset'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaCurrency. - The unique name of the currency. - - Returns - ------- - str - The name of this GsaCurrency. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCurrency. - The unique name of the currency. - - Parameters - ---------- - name: str - The name of this GsaCurrency. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def factor(self) -> "float": - """Gets the factor of this GsaCurrency. - The conversion factor of the currency. - - Returns - ------- - float - The factor of this GsaCurrency. - """ - return self._factor - - @factor.setter - def factor(self, factor: "float") -> None: - """Sets the factor of this GsaCurrency. - The conversion factor of the currency. - - Parameters - ---------- - factor: float - The factor of this GsaCurrency. - """ - # Field is not nullable - if factor is None: - raise ValueError("Invalid value for 'factor', must not be 'None'") - # Field is required - if factor is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'factor', must not be 'Unset'") - self._factor = factor - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCurrency): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_detail.py deleted file mode 100644 index fe165249..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_detail.py +++ /dev/null @@ -1,201 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCurrencyErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaCurrencyErrorReason", - } - - discriminator_value_class_map = { - "nameMissing".lower(): "#/components/schemas/GsaNameMissingCurrencyErrorDetail", - "duplicateName".lower(): "#/components/schemas/GsaDuplicateNameCurrencyErrorDetail", - "nameWhitespace".lower(): "#/components/schemas/GsaNameWhitespaceCurrencyErrorDetail", - "codeMissing".lower(): "#/components/schemas/GsaCodeMissingCurrencyErrorDetail", - "duplicateCode".lower(): "#/components/schemas/GsaDuplicateCodeCurrencyErrorDetail", - "codeWhitespace".lower(): "#/components/schemas/GsaCodeWhitespaceCurrencyErrorDetail", - "tooLongCode".lower(): "#/components/schemas/GsaTooLongCodeCurrencyErrorDetail", - "invalidExchangeRate".lower(): "#/components/schemas/GsaInvalidExchangeRateCurrencyErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason", - ) -> None: - """GsaCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - self._message: str - self._reason: GsaCurrencyErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaCurrencyErrorDetail. - - Returns - ------- - str - The message of this GsaCurrencyErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaCurrencyErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaCurrencyErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaCurrencyErrorReason": - """Gets the reason of this GsaCurrencyErrorDetail. - - Returns - ------- - GsaCurrencyErrorReason - The reason of this GsaCurrencyErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaCurrencyErrorReason") -> None: - """Sets the reason of this GsaCurrencyErrorDetail. - - Parameters - ---------- - reason: GsaCurrencyErrorReason - The reason of this GsaCurrencyErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_reason.py deleted file mode 100644 index 9c58e12a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_currency_error_reason.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaCurrencyErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEMISSING = "nameMissing" - DUPLICATENAME = "duplicateName" - NAMEWHITESPACE = "nameWhitespace" - CODEMISSING = "codeMissing" - DUPLICATECODE = "duplicateCode" - CODEWHITESPACE = "codeWhitespace" - TOOLONGCODE = "tooLongCode" - INVALIDEXCHANGERATE = "invalidExchangeRate" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_export_range.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_export_range.py index 2003ef4f..d36cfe1d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_export_range.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_export_range.py @@ -61,92 +61,147 @@ class GsaDataExportRange(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "high_endpoint": "GsaRangeEndpoint", - "low_endpoint": "GsaRangeEndpoint", + "high_value": "float", + "high_value_is_inclusive": "bool", + "low_value": "float", + "low_value_is_inclusive": "bool", } attribute_map: dict[str, str] = { - "high_endpoint": "highEndpoint", - "low_endpoint": "lowEndpoint", + "high_value": "highValue", + "high_value_is_inclusive": "highValueIsInclusive", + "low_value": "lowValue", + "low_value_is_inclusive": "lowValueIsInclusive", } - subtype_mapping: dict[str, str] = { - "highEndpoint": "GsaRangeEndpoint", - "lowEndpoint": "GsaRangeEndpoint", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - high_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, - low_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, + high_value: "float | None | Unset_Type" = Unset, + high_value_is_inclusive: "bool | Unset_Type" = Unset, + low_value: "float | None | Unset_Type" = Unset, + low_value_is_inclusive: "bool | Unset_Type" = Unset, ) -> None: """GsaDataExportRange - a model defined in Swagger Parameters ---------- - high_endpoint: GsaRangeEndpoint, optional - low_endpoint: GsaRangeEndpoint, optional + high_value: float | None, optional + high_value_is_inclusive: bool, optional + low_value: float | None, optional + low_value_is_inclusive: bool, optional + """ + self._high_value: float | None | Unset_Type = Unset + self._low_value: float | None | Unset_Type = Unset + self._high_value_is_inclusive: bool | Unset_Type = Unset + self._low_value_is_inclusive: bool | Unset_Type = Unset + + if high_value is not Unset: + self.high_value = high_value + if low_value is not Unset: + self.low_value = low_value + if high_value_is_inclusive is not Unset: + self.high_value_is_inclusive = high_value_is_inclusive + if low_value_is_inclusive is not Unset: + self.low_value_is_inclusive = low_value_is_inclusive + + @property + def high_value(self) -> "float | None | Unset_Type": + """Gets the high_value of this GsaDataExportRange. + + Returns + ------- + float | None | Unset_Type + The high_value of this GsaDataExportRange. + """ + return self._high_value + + @high_value.setter + def high_value(self, high_value: "float | None | Unset_Type") -> None: + """Sets the high_value of this GsaDataExportRange. + + Parameters + ---------- + high_value: float | None | Unset_Type + The high_value of this GsaDataExportRange. """ - self._high_endpoint: GsaRangeEndpoint | Unset_Type = Unset - self._low_endpoint: GsaRangeEndpoint | Unset_Type = Unset + self._high_value = high_value + + @property + def low_value(self) -> "float | None | Unset_Type": + """Gets the low_value of this GsaDataExportRange. - if high_endpoint is not Unset: - self.high_endpoint = high_endpoint - if low_endpoint is not Unset: - self.low_endpoint = low_endpoint + Returns + ------- + float | None | Unset_Type + The low_value of this GsaDataExportRange. + """ + return self._low_value + + @low_value.setter + def low_value(self, low_value: "float | None | Unset_Type") -> None: + """Sets the low_value of this GsaDataExportRange. + + Parameters + ---------- + low_value: float | None | Unset_Type + The low_value of this GsaDataExportRange. + """ + self._low_value = low_value @property - def high_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the high_endpoint of this GsaDataExportRange. + def high_value_is_inclusive(self) -> "bool | Unset_Type": + """Gets the high_value_is_inclusive of this GsaDataExportRange. Returns ------- - GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaDataExportRange. + bool | Unset_Type + The high_value_is_inclusive of this GsaDataExportRange. """ - return self._high_endpoint + return self._high_value_is_inclusive - @high_endpoint.setter - def high_endpoint(self, high_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the high_endpoint of this GsaDataExportRange. + @high_value_is_inclusive.setter + def high_value_is_inclusive(self, high_value_is_inclusive: "bool | Unset_Type") -> None: + """Sets the high_value_is_inclusive of this GsaDataExportRange. Parameters ---------- - high_endpoint: GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaDataExportRange. + high_value_is_inclusive: bool | Unset_Type + The high_value_is_inclusive of this GsaDataExportRange. """ # Field is not nullable - if high_endpoint is None: - raise ValueError("Invalid value for 'high_endpoint', must not be 'None'") - self._high_endpoint = high_endpoint + if high_value_is_inclusive is None: + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'None'") + self._high_value_is_inclusive = high_value_is_inclusive @property - def low_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the low_endpoint of this GsaDataExportRange. + def low_value_is_inclusive(self) -> "bool | Unset_Type": + """Gets the low_value_is_inclusive of this GsaDataExportRange. Returns ------- - GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaDataExportRange. + bool | Unset_Type + The low_value_is_inclusive of this GsaDataExportRange. """ - return self._low_endpoint + return self._low_value_is_inclusive - @low_endpoint.setter - def low_endpoint(self, low_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the low_endpoint of this GsaDataExportRange. + @low_value_is_inclusive.setter + def low_value_is_inclusive(self, low_value_is_inclusive: "bool | Unset_Type") -> None: + """Sets the low_value_is_inclusive of this GsaDataExportRange. Parameters ---------- - low_endpoint: GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaDataExportRange. + low_value_is_inclusive: bool | Unset_Type + The low_value_is_inclusive of this GsaDataExportRange. """ # Field is not nullable - if low_endpoint is None: - raise ValueError("Invalid value for 'low_endpoint', must not be 'None'") - self._low_endpoint = low_endpoint + if low_value_is_inclusive is None: + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'None'") + self._low_value_is_inclusive = low_value_is_inclusive @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update.py deleted file mode 100644 index e32978a7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "header": "GsaDataUpdateHeader", - "token": "GsaDataUpdateToken", - "run_info": "GsaDataUpdateRunInfo", - } - - attribute_map: dict[str, str] = { - "header": "header", - "token": "token", - "run_info": "runInfo", - } - - subtype_mapping: dict[str, str] = { - "token": "GsaDataUpdateToken", - "header": "GsaDataUpdateHeader", - "runInfo": "GsaDataUpdateRunInfo", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - header: "GsaDataUpdateHeader", - token: "GsaDataUpdateToken", - run_info: "GsaDataUpdateRunInfo | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdate - a model defined in Swagger - - Parameters - ---------- - header: GsaDataUpdateHeader - token: GsaDataUpdateToken - run_info: GsaDataUpdateRunInfo, optional - """ - self._token: GsaDataUpdateToken - self._header: GsaDataUpdateHeader - self._run_info: GsaDataUpdateRunInfo | Unset_Type = Unset - - self.token = token - self.header = header - if run_info is not Unset: - self.run_info = run_info - - @property - def token(self) -> "GsaDataUpdateToken": - """Gets the token of this GsaDataUpdate. - - Returns - ------- - GsaDataUpdateToken - The token of this GsaDataUpdate. - """ - return self._token - - @token.setter - def token(self, token: "GsaDataUpdateToken") -> None: - """Sets the token of this GsaDataUpdate. - - Parameters - ---------- - token: GsaDataUpdateToken - The token of this GsaDataUpdate. - """ - # Field is not nullable - if token is None: - raise ValueError("Invalid value for 'token', must not be 'None'") - # Field is required - if token is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'token', must not be 'Unset'") - self._token = token - - @property - def header(self) -> "GsaDataUpdateHeader": - """Gets the header of this GsaDataUpdate. - - Returns - ------- - GsaDataUpdateHeader - The header of this GsaDataUpdate. - """ - return self._header - - @header.setter - def header(self, header: "GsaDataUpdateHeader") -> None: - """Sets the header of this GsaDataUpdate. - - Parameters - ---------- - header: GsaDataUpdateHeader - The header of this GsaDataUpdate. - """ - # Field is not nullable - if header is None: - raise ValueError("Invalid value for 'header', must not be 'None'") - # Field is required - if header is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'header', must not be 'Unset'") - self._header = header - - @property - def run_info(self) -> "GsaDataUpdateRunInfo | Unset_Type": - """Gets the run_info of this GsaDataUpdate. - - Returns - ------- - GsaDataUpdateRunInfo | Unset_Type - The run_info of this GsaDataUpdate. - """ - return self._run_info - - @run_info.setter - def run_info(self, run_info: "GsaDataUpdateRunInfo | Unset_Type") -> None: - """Sets the run_info of this GsaDataUpdate. - - Parameters - ---------- - run_info: GsaDataUpdateRunInfo | Unset_Type - The run_info of this GsaDataUpdate. - """ - # Field is not nullable - if run_info is None: - raise ValueError("Invalid value for 'run_info', must not be 'None'") - self._run_info = run_info - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_deletion_exception.py deleted file mode 100644 index caf11aad..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_deletion_exception.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdateDeletionException(GsaDeletionException): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", - "errors": "list[GsaDataModificationErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.DATAUPDATE, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdateDeletionException - a model defined in Swagger - - Parameters - ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional - errors: list[GsaDataModificationErrorDetail] | None, optional - message: str | None, optional - """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdateDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_header.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_header.py deleted file mode 100644 index ed654e3f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_header.py +++ /dev/null @@ -1,622 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdateHeader(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "contains_fallback_identifiers": "bool", - "create_date": "datetime", - "name": "str", - "project_guid": "str", - "source_volume_guid": "str", - "supported_objects_version": "int", - "update_format_version": "int", - "update_guid": "str", - "description": "str", - "mi_version": "str", - "new_version_guid": "str", - "prerequisite_update_guid": "str", - "prerequisite_update_name": "str", - "project_name": "str", - "source_database_key": "str", - } - - attribute_map: dict[str, str] = { - "contains_fallback_identifiers": "containsFallbackIdentifiers", - "create_date": "createDate", - "name": "name", - "project_guid": "projectGuid", - "source_volume_guid": "sourceVolumeGuid", - "supported_objects_version": "supportedObjectsVersion", - "update_format_version": "updateFormatVersion", - "update_guid": "updateGuid", - "description": "description", - "mi_version": "miVersion", - "new_version_guid": "newVersionGuid", - "prerequisite_update_guid": "prerequisiteUpdateGuid", - "prerequisite_update_name": "prerequisiteUpdateName", - "project_name": "projectName", - "source_database_key": "sourceDatabaseKey", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - contains_fallback_identifiers: "bool", - create_date: "datetime", - name: "str", - project_guid: "str", - source_volume_guid: "str", - supported_objects_version: "int", - update_format_version: "int", - update_guid: "str", - description: "str | None | Unset_Type" = Unset, - mi_version: "str | None | Unset_Type" = Unset, - new_version_guid: "str | None | Unset_Type" = Unset, - prerequisite_update_guid: "str | None | Unset_Type" = Unset, - prerequisite_update_name: "str | None | Unset_Type" = Unset, - project_name: "str | None | Unset_Type" = Unset, - source_database_key: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdateHeader - a model defined in Swagger - - Parameters - ---------- - contains_fallback_identifiers: bool - create_date: datetime - name: str - project_guid: str - source_volume_guid: str - supported_objects_version: int - update_format_version: int - update_guid: str - description: str | None, optional - mi_version: str | None, optional - new_version_guid: str | None, optional - prerequisite_update_guid: str | None, optional - prerequisite_update_name: str | None, optional - project_name: str | None, optional - source_database_key: str | None, optional - """ - self._create_date: datetime - self._update_guid: str - self._prerequisite_update_guid: str | None | Unset_Type = Unset - self._prerequisite_update_name: str | None | Unset_Type = Unset - self._mi_version: str | None | Unset_Type = Unset - self._supported_objects_version: int - self._update_format_version: int - self._source_database_key: str | None | Unset_Type = Unset - self._source_volume_guid: str - self._name: str - self._description: str | None | Unset_Type = Unset - self._project_name: str | None | Unset_Type = Unset - self._project_guid: str - self._contains_fallback_identifiers: bool - self._new_version_guid: str | None | Unset_Type = Unset - - self.create_date = create_date - self.update_guid = update_guid - if prerequisite_update_guid is not Unset: - self.prerequisite_update_guid = prerequisite_update_guid - if prerequisite_update_name is not Unset: - self.prerequisite_update_name = prerequisite_update_name - if mi_version is not Unset: - self.mi_version = mi_version - self.supported_objects_version = supported_objects_version - self.update_format_version = update_format_version - if source_database_key is not Unset: - self.source_database_key = source_database_key - self.source_volume_guid = source_volume_guid - self.name = name - if description is not Unset: - self.description = description - if project_name is not Unset: - self.project_name = project_name - self.project_guid = project_guid - self.contains_fallback_identifiers = contains_fallback_identifiers - if new_version_guid is not Unset: - self.new_version_guid = new_version_guid - - @property - def create_date(self) -> "datetime": - """Gets the create_date of this GsaDataUpdateHeader. - The date and time that the update was created. - - Returns - ------- - datetime - The create_date of this GsaDataUpdateHeader. - """ - return self._create_date - - @create_date.setter - def create_date(self, create_date: "datetime") -> None: - """Sets the create_date of this GsaDataUpdateHeader. - The date and time that the update was created. - - Parameters - ---------- - create_date: datetime - The create_date of this GsaDataUpdateHeader. - """ - # Field is not nullable - if create_date is None: - raise ValueError("Invalid value for 'create_date', must not be 'None'") - # Field is required - if create_date is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'create_date', must not be 'Unset'") - self._create_date = create_date - - @property - def update_guid(self) -> "str": - """Gets the update_guid of this GsaDataUpdateHeader. - A unique identity to disambiguate this update from all other updates. - - Returns - ------- - str - The update_guid of this GsaDataUpdateHeader. - """ - return self._update_guid - - @update_guid.setter - def update_guid(self, update_guid: "str") -> None: - """Sets the update_guid of this GsaDataUpdateHeader. - A unique identity to disambiguate this update from all other updates. - - Parameters - ---------- - update_guid: str - The update_guid of this GsaDataUpdateHeader. - """ - # Field is not nullable - if update_guid is None: - raise ValueError("Invalid value for 'update_guid', must not be 'None'") - # Field is required - if update_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'update_guid', must not be 'Unset'") - self._update_guid = update_guid - - @property - def prerequisite_update_guid(self) -> "str | None | Unset_Type": - """Gets the prerequisite_update_guid of this GsaDataUpdateHeader. - GUID for the previous update that need to have been applied before this update can be applied. - - Returns - ------- - str | None | Unset_Type - The prerequisite_update_guid of this GsaDataUpdateHeader. - """ - return self._prerequisite_update_guid - - @prerequisite_update_guid.setter - def prerequisite_update_guid(self, prerequisite_update_guid: "str | None | Unset_Type") -> None: - """Sets the prerequisite_update_guid of this GsaDataUpdateHeader. - GUID for the previous update that need to have been applied before this update can be applied. - - Parameters - ---------- - prerequisite_update_guid: str | None | Unset_Type - The prerequisite_update_guid of this GsaDataUpdateHeader. - """ - self._prerequisite_update_guid = prerequisite_update_guid - - @property - def prerequisite_update_name(self) -> "str | None | Unset_Type": - """Gets the prerequisite_update_name of this GsaDataUpdateHeader. - Name of the previous update that need to have been applied before this update can be applied. This is used only for display purposes. - - Returns - ------- - str | None | Unset_Type - The prerequisite_update_name of this GsaDataUpdateHeader. - """ - return self._prerequisite_update_name - - @prerequisite_update_name.setter - def prerequisite_update_name(self, prerequisite_update_name: "str | None | Unset_Type") -> None: - """Sets the prerequisite_update_name of this GsaDataUpdateHeader. - Name of the previous update that need to have been applied before this update can be applied. This is used only for display purposes. - - Parameters - ---------- - prerequisite_update_name: str | None | Unset_Type - The prerequisite_update_name of this GsaDataUpdateHeader. - """ - self._prerequisite_update_name = prerequisite_update_name - - @property - def mi_version(self) -> "str | None | Unset_Type": - """Gets the mi_version of this GsaDataUpdateHeader. - Gets the version of MI that was used to create this update. - - Returns - ------- - str | None | Unset_Type - The mi_version of this GsaDataUpdateHeader. - """ - return self._mi_version - - @mi_version.setter - def mi_version(self, mi_version: "str | None | Unset_Type") -> None: - """Sets the mi_version of this GsaDataUpdateHeader. - Gets the version of MI that was used to create this update. - - Parameters - ---------- - mi_version: str | None | Unset_Type - The mi_version of this GsaDataUpdateHeader. - """ - self._mi_version = mi_version - - @property - def supported_objects_version(self) -> "int": - """Gets the supported_objects_version of this GsaDataUpdateHeader. - Gets or sets the version number indicating the kinds of object that this update supports. A client will be able to process updates with an unrecognised SupportedObjectsVersion (although in doing so it will have to ignore fields describing objects it does not recognise). - - Returns - ------- - int - The supported_objects_version of this GsaDataUpdateHeader. - """ - return self._supported_objects_version - - @supported_objects_version.setter - def supported_objects_version(self, supported_objects_version: "int") -> None: - """Sets the supported_objects_version of this GsaDataUpdateHeader. - Gets or sets the version number indicating the kinds of object that this update supports. A client will be able to process updates with an unrecognised SupportedObjectsVersion (although in doing so it will have to ignore fields describing objects it does not recognise). - - Parameters - ---------- - supported_objects_version: int - The supported_objects_version of this GsaDataUpdateHeader. - """ - # Field is not nullable - if supported_objects_version is None: - raise ValueError("Invalid value for 'supported_objects_version', must not be 'None'") - # Field is required - if supported_objects_version is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'supported_objects_version', must not be 'Unset'") - self._supported_objects_version = supported_objects_version - - @property - def update_format_version(self) -> "int": - """Gets the update_format_version of this GsaDataUpdateHeader. - Gets or sets the version number of the format of the update. This will change if the meaning of any of the fields in the update changes. A client must not process an update with an UpdateFormatVersion field that it does not recognise, as it cannot be sure of the meaning of the fields it reads. - - Returns - ------- - int - The update_format_version of this GsaDataUpdateHeader. - """ - return self._update_format_version - - @update_format_version.setter - def update_format_version(self, update_format_version: "int") -> None: - """Sets the update_format_version of this GsaDataUpdateHeader. - Gets or sets the version number of the format of the update. This will change if the meaning of any of the fields in the update changes. A client must not process an update with an UpdateFormatVersion field that it does not recognise, as it cannot be sure of the meaning of the fields it reads. - - Parameters - ---------- - update_format_version: int - The update_format_version of this GsaDataUpdateHeader. - """ - # Field is not nullable - if update_format_version is None: - raise ValueError("Invalid value for 'update_format_version', must not be 'None'") - # Field is required - if update_format_version is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'update_format_version', must not be 'Unset'") - self._update_format_version = update_format_version - - @property - def source_database_key(self) -> "str | None | Unset_Type": - """Gets the source_database_key of this GsaDataUpdateHeader. - Gets or sets the database key of the database from which this update was generated. - - Returns - ------- - str | None | Unset_Type - The source_database_key of this GsaDataUpdateHeader. - """ - return self._source_database_key - - @source_database_key.setter - def source_database_key(self, source_database_key: "str | None | Unset_Type") -> None: - """Sets the source_database_key of this GsaDataUpdateHeader. - Gets or sets the database key of the database from which this update was generated. - - Parameters - ---------- - source_database_key: str | None | Unset_Type - The source_database_key of this GsaDataUpdateHeader. - """ - self._source_database_key = source_database_key - - @property - def source_volume_guid(self) -> "str": - """Gets the source_volume_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the volume from which the update was generated. - - Returns - ------- - str - The source_volume_guid of this GsaDataUpdateHeader. - """ - return self._source_volume_guid - - @source_volume_guid.setter - def source_volume_guid(self, source_volume_guid: "str") -> None: - """Sets the source_volume_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the volume from which the update was generated. - - Parameters - ---------- - source_volume_guid: str - The source_volume_guid of this GsaDataUpdateHeader. - """ - # Field is not nullable - if source_volume_guid is None: - raise ValueError("Invalid value for 'source_volume_guid', must not be 'None'") - # Field is required - if source_volume_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_volume_guid', must not be 'Unset'") - self._source_volume_guid = source_volume_guid - - @property - def name(self) -> "str": - """Gets the name of this GsaDataUpdateHeader. - Gets or sets the name of the update. - - Returns - ------- - str - The name of this GsaDataUpdateHeader. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaDataUpdateHeader. - Gets or sets the name of the update. - - Parameters - ---------- - name: str - The name of this GsaDataUpdateHeader. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaDataUpdateHeader. - Gets or sets the description of the update. - - Returns - ------- - str | None | Unset_Type - The description of this GsaDataUpdateHeader. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaDataUpdateHeader. - Gets or sets the description of the update. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaDataUpdateHeader. - """ - self._description = description - - @property - def project_name(self) -> "str | None | Unset_Type": - """Gets the project_name of this GsaDataUpdateHeader. - Gets or sets the name of the project this update was created for. - - Returns - ------- - str | None | Unset_Type - The project_name of this GsaDataUpdateHeader. - """ - return self._project_name - - @project_name.setter - def project_name(self, project_name: "str | None | Unset_Type") -> None: - """Sets the project_name of this GsaDataUpdateHeader. - Gets or sets the name of the project this update was created for. - - Parameters - ---------- - project_name: str | None | Unset_Type - The project_name of this GsaDataUpdateHeader. - """ - self._project_name = project_name - - @property - def project_guid(self) -> "str": - """Gets the project_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the project this update was created for. - - Returns - ------- - str - The project_guid of this GsaDataUpdateHeader. - """ - return self._project_guid - - @project_guid.setter - def project_guid(self, project_guid: "str") -> None: - """Sets the project_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the project this update was created for. - - Parameters - ---------- - project_guid: str - The project_guid of this GsaDataUpdateHeader. - """ - # Field is not nullable - if project_guid is None: - raise ValueError("Invalid value for 'project_guid', must not be 'None'") - # Field is required - if project_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'project_guid', must not be 'Unset'") - self._project_guid = project_guid - - @property - def contains_fallback_identifiers(self) -> "bool": - """Gets the contains_fallback_identifiers of this GsaDataUpdateHeader. - Gets or sets the flag informing whether or not this update contains fallback identifiers (mostly names). - - Returns - ------- - bool - The contains_fallback_identifiers of this GsaDataUpdateHeader. - """ - return self._contains_fallback_identifiers - - @contains_fallback_identifiers.setter - def contains_fallback_identifiers(self, contains_fallback_identifiers: "bool") -> None: - """Sets the contains_fallback_identifiers of this GsaDataUpdateHeader. - Gets or sets the flag informing whether or not this update contains fallback identifiers (mostly names). - - Parameters - ---------- - contains_fallback_identifiers: bool - The contains_fallback_identifiers of this GsaDataUpdateHeader. - """ - # Field is not nullable - if contains_fallback_identifiers is None: - raise ValueError( - "Invalid value for 'contains_fallback_identifiers', must not be 'None'" - ) - # Field is required - if contains_fallback_identifiers is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'contains_fallback_identifiers', must not be 'Unset'" - ) - self._contains_fallback_identifiers = contains_fallback_identifiers - - @property - def new_version_guid(self) -> "str | None | Unset_Type": - """Gets the new_version_guid of this GsaDataUpdateHeader. - Gets or sets the value Database Version GUID should be updated to. If this field is set then we propose to retarget tabular attributes to link to new version of the database. - - Returns - ------- - str | None | Unset_Type - The new_version_guid of this GsaDataUpdateHeader. - """ - return self._new_version_guid - - @new_version_guid.setter - def new_version_guid(self, new_version_guid: "str | None | Unset_Type") -> None: - """Sets the new_version_guid of this GsaDataUpdateHeader. - Gets or sets the value Database Version GUID should be updated to. If this field is set then we propose to retarget tabular attributes to link to new version of the database. - - Parameters - ---------- - new_version_guid: str | None | Unset_Type - The new_version_guid of this GsaDataUpdateHeader. - """ - self._new_version_guid = new_version_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdateHeader): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_run_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_run_info.py deleted file mode 100644 index 3c8c3efc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_run_info.py +++ /dev/null @@ -1,373 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdateRunInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "apply_adds_as_state": "bool", - "database_key": "str", - "match_mode": "GsaMatchMode", - "retarget_tabular_attributes": "bool", - "status": "GsaUpdateRunStatus", - "applied_date": "datetime", - "error_message": "str", - "progress_percentage": "float", - } - - attribute_map: dict[str, str] = { - "apply_adds_as_state": "applyAddsAsState", - "database_key": "databaseKey", - "match_mode": "matchMode", - "retarget_tabular_attributes": "retargetTabularAttributes", - "status": "status", - "applied_date": "appliedDate", - "error_message": "errorMessage", - "progress_percentage": "progressPercentage", - } - - subtype_mapping: dict[str, str] = { - "matchMode": "GsaMatchMode", - "status": "GsaUpdateRunStatus", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - apply_adds_as_state: "bool", - database_key: "str", - match_mode: "GsaMatchMode", - retarget_tabular_attributes: "bool", - status: "GsaUpdateRunStatus", - applied_date: "datetime | None | Unset_Type" = Unset, - error_message: "str | None | Unset_Type" = Unset, - progress_percentage: "float | None | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdateRunInfo - a model defined in Swagger - - Parameters - ---------- - apply_adds_as_state: bool - database_key: str - match_mode: GsaMatchMode - retarget_tabular_attributes: bool - status: GsaUpdateRunStatus - applied_date: datetime | None, optional - error_message: str | None, optional - progress_percentage: float | None, optional - """ - self._database_key: str - self._match_mode: GsaMatchMode - self._apply_adds_as_state: bool - self._retarget_tabular_attributes: bool - self._status: GsaUpdateRunStatus - self._progress_percentage: float | None | Unset_Type = Unset - self._applied_date: datetime | None | Unset_Type = Unset - self._error_message: str | None | Unset_Type = Unset - - self.database_key = database_key - self.match_mode = match_mode - self.apply_adds_as_state = apply_adds_as_state - self.retarget_tabular_attributes = retarget_tabular_attributes - self.status = status - if progress_percentage is not Unset: - self.progress_percentage = progress_percentage - if applied_date is not Unset: - self.applied_date = applied_date - if error_message is not Unset: - self.error_message = error_message - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDataUpdateRunInfo. - - Returns - ------- - str - The database_key of this GsaDataUpdateRunInfo. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDataUpdateRunInfo. - - Parameters - ---------- - database_key: str - The database_key of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def match_mode(self) -> "GsaMatchMode": - """Gets the match_mode of this GsaDataUpdateRunInfo. - - Returns - ------- - GsaMatchMode - The match_mode of this GsaDataUpdateRunInfo. - """ - return self._match_mode - - @match_mode.setter - def match_mode(self, match_mode: "GsaMatchMode") -> None: - """Sets the match_mode of this GsaDataUpdateRunInfo. - - Parameters - ---------- - match_mode: GsaMatchMode - The match_mode of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if match_mode is None: - raise ValueError("Invalid value for 'match_mode', must not be 'None'") - # Field is required - if match_mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'match_mode', must not be 'Unset'") - self._match_mode = match_mode - - @property - def apply_adds_as_state(self) -> "bool": - """Gets the apply_adds_as_state of this GsaDataUpdateRunInfo. - - Returns - ------- - bool - The apply_adds_as_state of this GsaDataUpdateRunInfo. - """ - return self._apply_adds_as_state - - @apply_adds_as_state.setter - def apply_adds_as_state(self, apply_adds_as_state: "bool") -> None: - """Sets the apply_adds_as_state of this GsaDataUpdateRunInfo. - - Parameters - ---------- - apply_adds_as_state: bool - The apply_adds_as_state of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if apply_adds_as_state is None: - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'None'") - # Field is required - if apply_adds_as_state is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'Unset'") - self._apply_adds_as_state = apply_adds_as_state - - @property - def retarget_tabular_attributes(self) -> "bool": - """Gets the retarget_tabular_attributes of this GsaDataUpdateRunInfo. - - Returns - ------- - bool - The retarget_tabular_attributes of this GsaDataUpdateRunInfo. - """ - return self._retarget_tabular_attributes - - @retarget_tabular_attributes.setter - def retarget_tabular_attributes(self, retarget_tabular_attributes: "bool") -> None: - """Sets the retarget_tabular_attributes of this GsaDataUpdateRunInfo. - - Parameters - ---------- - retarget_tabular_attributes: bool - The retarget_tabular_attributes of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if retarget_tabular_attributes is None: - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'None'") - # Field is required - if retarget_tabular_attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'Unset'") - self._retarget_tabular_attributes = retarget_tabular_attributes - - @property - def status(self) -> "GsaUpdateRunStatus": - """Gets the status of this GsaDataUpdateRunInfo. - - Returns - ------- - GsaUpdateRunStatus - The status of this GsaDataUpdateRunInfo. - """ - return self._status - - @status.setter - def status(self, status: "GsaUpdateRunStatus") -> None: - """Sets the status of this GsaDataUpdateRunInfo. - - Parameters - ---------- - status: GsaUpdateRunStatus - The status of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if status is None: - raise ValueError("Invalid value for 'status', must not be 'None'") - # Field is required - if status is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'status', must not be 'Unset'") - self._status = status - - @property - def progress_percentage(self) -> "float | None | Unset_Type": - """Gets the progress_percentage of this GsaDataUpdateRunInfo. - - Returns - ------- - float | None | Unset_Type - The progress_percentage of this GsaDataUpdateRunInfo. - """ - return self._progress_percentage - - @progress_percentage.setter - def progress_percentage(self, progress_percentage: "float | None | Unset_Type") -> None: - """Sets the progress_percentage of this GsaDataUpdateRunInfo. - - Parameters - ---------- - progress_percentage: float | None | Unset_Type - The progress_percentage of this GsaDataUpdateRunInfo. - """ - self._progress_percentage = progress_percentage - - @property - def applied_date(self) -> "datetime | None | Unset_Type": - """Gets the applied_date of this GsaDataUpdateRunInfo. - - Returns - ------- - datetime | None | Unset_Type - The applied_date of this GsaDataUpdateRunInfo. - """ - return self._applied_date - - @applied_date.setter - def applied_date(self, applied_date: "datetime | None | Unset_Type") -> None: - """Sets the applied_date of this GsaDataUpdateRunInfo. - - Parameters - ---------- - applied_date: datetime | None | Unset_Type - The applied_date of this GsaDataUpdateRunInfo. - """ - self._applied_date = applied_date - - @property - def error_message(self) -> "str | None | Unset_Type": - """Gets the error_message of this GsaDataUpdateRunInfo. - - Returns - ------- - str | None | Unset_Type - The error_message of this GsaDataUpdateRunInfo. - """ - return self._error_message - - @error_message.setter - def error_message(self, error_message: "str | None | Unset_Type") -> None: - """Sets the error_message of this GsaDataUpdateRunInfo. - - Parameters - ---------- - error_message: str | None | Unset_Type - The error_message of this GsaDataUpdateRunInfo. - """ - self._error_message = error_message - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdateRunInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_token.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_token.py deleted file mode 100644 index d0e68dbb..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_update_token.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdateToken(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key": "str", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "database_key": "databaseKey", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key: "str", - guid: "str", - ) -> None: - """GsaDataUpdateToken - a model defined in Swagger - - Parameters - ---------- - database_key: str - guid: str - """ - self._guid: str - self._database_key: str - - self.guid = guid - self.database_key = database_key - - @property - def guid(self) -> "str": - """Gets the guid of this GsaDataUpdateToken. - - Returns - ------- - str - The guid of this GsaDataUpdateToken. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaDataUpdateToken. - - Parameters - ---------- - guid: str - The guid of this GsaDataUpdateToken. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDataUpdateToken. - - Returns - ------- - str - The database_key of this GsaDataUpdateToken. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDataUpdateToken. - - Parameters - ---------- - database_key: str - The database_key of this GsaDataUpdateToken. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdateToken): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job.py deleted file mode 100644 index 66d4b905..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job.py +++ /dev/null @@ -1,480 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdaterJob(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key": "str", - "id": "str", - "job_type": "GsaDataUpdaterJobType", - "status": "GsaDataUpdaterJobStatus", - "time_started": "datetime", - "description": "str", - "error": "str", - "name": "str", - "project_name": "str", - "time_completed": "datetime", - "update_token": "GsaDataUpdateToken", - } - - attribute_map: dict[str, str] = { - "database_key": "databaseKey", - "id": "id", - "job_type": "jobType", - "status": "status", - "time_started": "timeStarted", - "description": "description", - "error": "error", - "name": "name", - "project_name": "projectName", - "time_completed": "timeCompleted", - "update_token": "updateToken", - } - - subtype_mapping: dict[str, str] = { - "updateToken": "GsaDataUpdateToken", - "jobType": "GsaDataUpdaterJobType", - "status": "GsaDataUpdaterJobStatus", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key: "str", - id: "str", - job_type: "GsaDataUpdaterJobType", - status: "GsaDataUpdaterJobStatus", - time_started: "datetime", - description: "str | None | Unset_Type" = Unset, - error: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - project_name: "str | None | Unset_Type" = Unset, - time_completed: "datetime | None | Unset_Type" = Unset, - update_token: "GsaDataUpdateToken | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdaterJob - a model defined in Swagger - - Parameters - ---------- - database_key: str - id: str - job_type: GsaDataUpdaterJobType - status: GsaDataUpdaterJobStatus - time_started: datetime - description: str | None, optional - error: str | None, optional - name: str | None, optional - project_name: str | None, optional - time_completed: datetime | None, optional - update_token: GsaDataUpdateToken, optional - """ - self._id: str - self._update_token: GsaDataUpdateToken | Unset_Type = Unset - self._job_type: GsaDataUpdaterJobType - self._database_key: str - self._name: str | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._status: GsaDataUpdaterJobStatus - self._project_name: str | None | Unset_Type = Unset - self._time_started: datetime - self._time_completed: datetime | None | Unset_Type = Unset - self._error: str | None | Unset_Type = Unset - - self.id = id - if update_token is not Unset: - self.update_token = update_token - self.job_type = job_type - self.database_key = database_key - if name is not Unset: - self.name = name - if description is not Unset: - self.description = description - self.status = status - if project_name is not Unset: - self.project_name = project_name - self.time_started = time_started - if time_completed is not Unset: - self.time_completed = time_completed - if error is not Unset: - self.error = error - - @property - def id(self) -> "str": - """Gets the id of this GsaDataUpdaterJob. - Gets or sets the token which identifies this job. - - Returns - ------- - str - The id of this GsaDataUpdaterJob. - """ - return self._id - - @id.setter - def id(self, id: "str") -> None: - """Sets the id of this GsaDataUpdaterJob. - Gets or sets the token which identifies this job. - - Parameters - ---------- - id: str - The id of this GsaDataUpdaterJob. - """ - # Field is not nullable - if id is None: - raise ValueError("Invalid value for 'id', must not be 'None'") - # Field is required - if id is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'id', must not be 'Unset'") - self._id = id - - @property - def update_token(self) -> "GsaDataUpdateToken | Unset_Type": - """Gets the update_token of this GsaDataUpdaterJob. - - Returns - ------- - GsaDataUpdateToken | Unset_Type - The update_token of this GsaDataUpdaterJob. - """ - return self._update_token - - @update_token.setter - def update_token(self, update_token: "GsaDataUpdateToken | Unset_Type") -> None: - """Sets the update_token of this GsaDataUpdaterJob. - - Parameters - ---------- - update_token: GsaDataUpdateToken | Unset_Type - The update_token of this GsaDataUpdaterJob. - """ - # Field is not nullable - if update_token is None: - raise ValueError("Invalid value for 'update_token', must not be 'None'") - self._update_token = update_token - - @property - def job_type(self) -> "GsaDataUpdaterJobType": - """Gets the job_type of this GsaDataUpdaterJob. - - Returns - ------- - GsaDataUpdaterJobType - The job_type of this GsaDataUpdaterJob. - """ - return self._job_type - - @job_type.setter - def job_type(self, job_type: "GsaDataUpdaterJobType") -> None: - """Sets the job_type of this GsaDataUpdaterJob. - - Parameters - ---------- - job_type: GsaDataUpdaterJobType - The job_type of this GsaDataUpdaterJob. - """ - # Field is not nullable - if job_type is None: - raise ValueError("Invalid value for 'job_type', must not be 'None'") - # Field is required - if job_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'job_type', must not be 'Unset'") - self._job_type = job_type - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDataUpdaterJob. - Gets or sets the key of the database against which this job has been / will be run. - - Returns - ------- - str - The database_key of this GsaDataUpdaterJob. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDataUpdaterJob. - Gets or sets the key of the database against which this job has been / will be run. - - Parameters - ---------- - database_key: str - The database_key of this GsaDataUpdaterJob. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaDataUpdaterJob. - Gets or sets the name of the update. - - Returns - ------- - str | None | Unset_Type - The name of this GsaDataUpdaterJob. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaDataUpdaterJob. - Gets or sets the name of the update. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaDataUpdaterJob. - """ - self._name = name - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaDataUpdaterJob. - Gets or sets the description of the job. - - Returns - ------- - str | None | Unset_Type - The description of this GsaDataUpdaterJob. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaDataUpdaterJob. - Gets or sets the description of the job. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaDataUpdaterJob. - """ - self._description = description - - @property - def status(self) -> "GsaDataUpdaterJobStatus": - """Gets the status of this GsaDataUpdaterJob. - - Returns - ------- - GsaDataUpdaterJobStatus - The status of this GsaDataUpdaterJob. - """ - return self._status - - @status.setter - def status(self, status: "GsaDataUpdaterJobStatus") -> None: - """Sets the status of this GsaDataUpdaterJob. - - Parameters - ---------- - status: GsaDataUpdaterJobStatus - The status of this GsaDataUpdaterJob. - """ - # Field is not nullable - if status is None: - raise ValueError("Invalid value for 'status', must not be 'None'") - # Field is required - if status is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'status', must not be 'Unset'") - self._status = status - - @property - def project_name(self) -> "str | None | Unset_Type": - """Gets the project_name of this GsaDataUpdaterJob. - Gets or sets the project. - - Returns - ------- - str | None | Unset_Type - The project_name of this GsaDataUpdaterJob. - """ - return self._project_name - - @project_name.setter - def project_name(self, project_name: "str | None | Unset_Type") -> None: - """Sets the project_name of this GsaDataUpdaterJob. - Gets or sets the project. - - Parameters - ---------- - project_name: str | None | Unset_Type - The project_name of this GsaDataUpdaterJob. - """ - self._project_name = project_name - - @property - def time_started(self) -> "datetime": - """Gets the time_started of this GsaDataUpdaterJob. - Gets or sets the time that the job started. - - Returns - ------- - datetime - The time_started of this GsaDataUpdaterJob. - """ - return self._time_started - - @time_started.setter - def time_started(self, time_started: "datetime") -> None: - """Sets the time_started of this GsaDataUpdaterJob. - Gets or sets the time that the job started. - - Parameters - ---------- - time_started: datetime - The time_started of this GsaDataUpdaterJob. - """ - # Field is not nullable - if time_started is None: - raise ValueError("Invalid value for 'time_started', must not be 'None'") - # Field is required - if time_started is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'time_started', must not be 'Unset'") - self._time_started = time_started - - @property - def time_completed(self) -> "datetime | None | Unset_Type": - """Gets the time_completed of this GsaDataUpdaterJob. - Gets or sets the time that the job completed. - - Returns - ------- - datetime | None | Unset_Type - The time_completed of this GsaDataUpdaterJob. - """ - return self._time_completed - - @time_completed.setter - def time_completed(self, time_completed: "datetime | None | Unset_Type") -> None: - """Sets the time_completed of this GsaDataUpdaterJob. - Gets or sets the time that the job completed. - - Parameters - ---------- - time_completed: datetime | None | Unset_Type - The time_completed of this GsaDataUpdaterJob. - """ - self._time_completed = time_completed - - @property - def error(self) -> "str | None | Unset_Type": - """Gets the error of this GsaDataUpdaterJob. - The error that occurred (if any) when the job was run. If the job has not yet been run, or if the job completed successfully, this will be null. - - Returns - ------- - str | None | Unset_Type - The error of this GsaDataUpdaterJob. - """ - return self._error - - @error.setter - def error(self, error: "str | None | Unset_Type") -> None: - """Sets the error of this GsaDataUpdaterJob. - The error that occurred (if any) when the job was run. If the job has not yet been run, or if the job completed successfully, this will be null. - - Parameters - ---------- - error: str | None | Unset_Type - The error of this GsaDataUpdaterJob. - """ - self._error = error - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdaterJob): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_status.py deleted file mode 100644 index ef1b391c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_status.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDataUpdaterJobStatus(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNKNOWN = "Unknown" - QUEUED = "Queued" - INPROGRESS = "InProgress" - COMPLETED = "Completed" - CANCELLED = "Cancelled" - CANCELLING = "Cancelling" - FAILED = "Failed" - NOTFOUND = "NotFound" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_type.py deleted file mode 100644 index bcd1e645..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_job_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDataUpdaterJobType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOACTION = "NoAction" - CREATEUPDATE = "CreateUpdate" - SHIP = "Ship" - DRYRUNUPDATE = "DryRunUpdate" - APPLYUPDATE = "ApplyUpdate" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_project.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_project.py deleted file mode 100644 index 63d7e529..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_updater_project.py +++ /dev/null @@ -1,602 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdaterProject(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "include_db_dependencies": "bool", - "include_deselected_db_dependencies": "bool", - "include_foreign_category_items": "bool", - "name": "str", - "record_and_attribute_selection_type": "GsaRecordAndAttributeSelectionType", - "last_marked_ready_for_sending_at_revision": "int", - "last_marked_ready_for_sending_by_user_name": "str", - "last_update_file_name": "str", - "last_update_generated_by_user_name": "str", - "profile_id": "str", - "selection": "GsaSelection", - "time_last_update_generated": "datetime", - "time_last_update_marked_ready_for_sending": "datetime", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "include_db_dependencies": "includeDbDependencies", - "include_deselected_db_dependencies": "includeDeselectedDbDependencies", - "include_foreign_category_items": "includeForeignCategoryItems", - "name": "name", - "record_and_attribute_selection_type": "recordAndAttributeSelectionType", - "last_marked_ready_for_sending_at_revision": "lastMarkedReadyForSendingAtRevision", - "last_marked_ready_for_sending_by_user_name": "lastMarkedReadyForSendingByUserName", - "last_update_file_name": "lastUpdateFileName", - "last_update_generated_by_user_name": "lastUpdateGeneratedByUserName", - "profile_id": "profileId", - "selection": "selection", - "time_last_update_generated": "timeLastUpdateGenerated", - "time_last_update_marked_ready_for_sending": "timeLastUpdateMarkedReadyForSending", - } - - subtype_mapping: dict[str, str] = { - "recordAndAttributeSelectionType": "GsaRecordAndAttributeSelectionType", - "selection": "GsaSelection", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - include_db_dependencies: "bool", - include_deselected_db_dependencies: "bool", - include_foreign_category_items: "bool", - name: "str", - record_and_attribute_selection_type: "GsaRecordAndAttributeSelectionType", - last_marked_ready_for_sending_at_revision: "int | Unset_Type" = Unset, - last_marked_ready_for_sending_by_user_name: "str | None | Unset_Type" = Unset, - last_update_file_name: "str | None | Unset_Type" = Unset, - last_update_generated_by_user_name: "str | None | Unset_Type" = Unset, - profile_id: "str | None | Unset_Type" = Unset, - selection: "GsaSelection | Unset_Type" = Unset, - time_last_update_generated: "datetime | Unset_Type" = Unset, - time_last_update_marked_ready_for_sending: "datetime | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdaterProject - a model defined in Swagger - - Parameters - ---------- - guid: str - include_db_dependencies: bool - include_deselected_db_dependencies: bool - include_foreign_category_items: bool - name: str - record_and_attribute_selection_type: GsaRecordAndAttributeSelectionType - last_marked_ready_for_sending_at_revision: int, optional - last_marked_ready_for_sending_by_user_name: str | None, optional - last_update_file_name: str | None, optional - last_update_generated_by_user_name: str | None, optional - profile_id: str | None, optional - selection: GsaSelection, optional - time_last_update_generated: datetime, optional - time_last_update_marked_ready_for_sending: datetime, optional - """ - self._guid: str - self._name: str - self._record_and_attribute_selection_type: GsaRecordAndAttributeSelectionType - self._include_db_dependencies: bool - self._include_deselected_db_dependencies: bool - self._include_foreign_category_items: bool - self._last_update_file_name: str | None | Unset_Type = Unset - self._last_marked_ready_for_sending_by_user_name: str | None | Unset_Type = Unset - self._time_last_update_marked_ready_for_sending: datetime | Unset_Type = Unset - self._last_marked_ready_for_sending_at_revision: int | Unset_Type = Unset - self._last_update_generated_by_user_name: str | None | Unset_Type = Unset - self._time_last_update_generated: datetime | Unset_Type = Unset - self._profile_id: str | None | Unset_Type = Unset - self._selection: GsaSelection | Unset_Type = Unset - - self.guid = guid - self.name = name - self.record_and_attribute_selection_type = record_and_attribute_selection_type - self.include_db_dependencies = include_db_dependencies - self.include_deselected_db_dependencies = include_deselected_db_dependencies - self.include_foreign_category_items = include_foreign_category_items - if last_update_file_name is not Unset: - self.last_update_file_name = last_update_file_name - if last_marked_ready_for_sending_by_user_name is not Unset: - self.last_marked_ready_for_sending_by_user_name = ( - last_marked_ready_for_sending_by_user_name - ) - if time_last_update_marked_ready_for_sending is not Unset: - self.time_last_update_marked_ready_for_sending = ( - time_last_update_marked_ready_for_sending - ) - if last_marked_ready_for_sending_at_revision is not Unset: - self.last_marked_ready_for_sending_at_revision = ( - last_marked_ready_for_sending_at_revision - ) - if last_update_generated_by_user_name is not Unset: - self.last_update_generated_by_user_name = last_update_generated_by_user_name - if time_last_update_generated is not Unset: - self.time_last_update_generated = time_last_update_generated - if profile_id is not Unset: - self.profile_id = profile_id - if selection is not Unset: - self.selection = selection - - @property - def guid(self) -> "str": - """Gets the guid of this GsaDataUpdaterProject. - - Returns - ------- - str - The guid of this GsaDataUpdaterProject. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaDataUpdaterProject. - - Parameters - ---------- - guid: str - The guid of this GsaDataUpdaterProject. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def name(self) -> "str": - """Gets the name of this GsaDataUpdaterProject. - - Returns - ------- - str - The name of this GsaDataUpdaterProject. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaDataUpdaterProject. - - Parameters - ---------- - name: str - The name of this GsaDataUpdaterProject. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def record_and_attribute_selection_type(self) -> "GsaRecordAndAttributeSelectionType": - """Gets the record_and_attribute_selection_type of this GsaDataUpdaterProject. - - Returns - ------- - GsaRecordAndAttributeSelectionType - The record_and_attribute_selection_type of this GsaDataUpdaterProject. - """ - return self._record_and_attribute_selection_type - - @record_and_attribute_selection_type.setter - def record_and_attribute_selection_type( - self, record_and_attribute_selection_type: "GsaRecordAndAttributeSelectionType" - ) -> None: - """Sets the record_and_attribute_selection_type of this GsaDataUpdaterProject. - - Parameters - ---------- - record_and_attribute_selection_type: GsaRecordAndAttributeSelectionType - The record_and_attribute_selection_type of this GsaDataUpdaterProject. - """ - # Field is not nullable - if record_and_attribute_selection_type is None: - raise ValueError( - "Invalid value for 'record_and_attribute_selection_type', must not be 'None'" - ) - # Field is required - if record_and_attribute_selection_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'record_and_attribute_selection_type', must not be 'Unset'" - ) - self._record_and_attribute_selection_type = record_and_attribute_selection_type - - @property - def include_db_dependencies(self) -> "bool": - """Gets the include_db_dependencies of this GsaDataUpdaterProject. - - Returns - ------- - bool - The include_db_dependencies of this GsaDataUpdaterProject. - """ - return self._include_db_dependencies - - @include_db_dependencies.setter - def include_db_dependencies(self, include_db_dependencies: "bool") -> None: - """Sets the include_db_dependencies of this GsaDataUpdaterProject. - - Parameters - ---------- - include_db_dependencies: bool - The include_db_dependencies of this GsaDataUpdaterProject. - """ - # Field is not nullable - if include_db_dependencies is None: - raise ValueError("Invalid value for 'include_db_dependencies', must not be 'None'") - # Field is required - if include_db_dependencies is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'include_db_dependencies', must not be 'Unset'") - self._include_db_dependencies = include_db_dependencies - - @property - def include_deselected_db_dependencies(self) -> "bool": - """Gets the include_deselected_db_dependencies of this GsaDataUpdaterProject. - - Returns - ------- - bool - The include_deselected_db_dependencies of this GsaDataUpdaterProject. - """ - return self._include_deselected_db_dependencies - - @include_deselected_db_dependencies.setter - def include_deselected_db_dependencies( - self, include_deselected_db_dependencies: "bool" - ) -> None: - """Sets the include_deselected_db_dependencies of this GsaDataUpdaterProject. - - Parameters - ---------- - include_deselected_db_dependencies: bool - The include_deselected_db_dependencies of this GsaDataUpdaterProject. - """ - # Field is not nullable - if include_deselected_db_dependencies is None: - raise ValueError( - "Invalid value for 'include_deselected_db_dependencies', must not be 'None'" - ) - # Field is required - if include_deselected_db_dependencies is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'include_deselected_db_dependencies', must not be 'Unset'" - ) - self._include_deselected_db_dependencies = include_deselected_db_dependencies - - @property - def include_foreign_category_items(self) -> "bool": - """Gets the include_foreign_category_items of this GsaDataUpdaterProject. - - Returns - ------- - bool - The include_foreign_category_items of this GsaDataUpdaterProject. - """ - return self._include_foreign_category_items - - @include_foreign_category_items.setter - def include_foreign_category_items(self, include_foreign_category_items: "bool") -> None: - """Sets the include_foreign_category_items of this GsaDataUpdaterProject. - - Parameters - ---------- - include_foreign_category_items: bool - The include_foreign_category_items of this GsaDataUpdaterProject. - """ - # Field is not nullable - if include_foreign_category_items is None: - raise ValueError( - "Invalid value for 'include_foreign_category_items', must not be 'None'" - ) - # Field is required - if include_foreign_category_items is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'include_foreign_category_items', must not be 'Unset'" - ) - self._include_foreign_category_items = include_foreign_category_items - - @property - def last_update_file_name(self) -> "str | None | Unset_Type": - """Gets the last_update_file_name of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The last_update_file_name of this GsaDataUpdaterProject. - """ - return self._last_update_file_name - - @last_update_file_name.setter - def last_update_file_name(self, last_update_file_name: "str | None | Unset_Type") -> None: - """Sets the last_update_file_name of this GsaDataUpdaterProject. - - Parameters - ---------- - last_update_file_name: str | None | Unset_Type - The last_update_file_name of this GsaDataUpdaterProject. - """ - self._last_update_file_name = last_update_file_name - - @property - def last_marked_ready_for_sending_by_user_name(self) -> "str | None | Unset_Type": - """Gets the last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - """ - return self._last_marked_ready_for_sending_by_user_name - - @last_marked_ready_for_sending_by_user_name.setter - def last_marked_ready_for_sending_by_user_name( - self, last_marked_ready_for_sending_by_user_name: "str | None | Unset_Type" - ) -> None: - """Sets the last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - - Parameters - ---------- - last_marked_ready_for_sending_by_user_name: str | None | Unset_Type - The last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - """ - self._last_marked_ready_for_sending_by_user_name = ( - last_marked_ready_for_sending_by_user_name - ) - - @property - def time_last_update_marked_ready_for_sending(self) -> "datetime | Unset_Type": - """Gets the time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - - Returns - ------- - datetime | Unset_Type - The time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - """ - return self._time_last_update_marked_ready_for_sending - - @time_last_update_marked_ready_for_sending.setter - def time_last_update_marked_ready_for_sending( - self, time_last_update_marked_ready_for_sending: "datetime | Unset_Type" - ) -> None: - """Sets the time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - - Parameters - ---------- - time_last_update_marked_ready_for_sending: datetime | Unset_Type - The time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - """ - # Field is not nullable - if time_last_update_marked_ready_for_sending is None: - raise ValueError( - "Invalid value for 'time_last_update_marked_ready_for_sending', must not be 'None'" - ) - self._time_last_update_marked_ready_for_sending = time_last_update_marked_ready_for_sending - - @property - def last_marked_ready_for_sending_at_revision(self) -> "int | Unset_Type": - """Gets the last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - - Returns - ------- - int | Unset_Type - The last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - """ - return self._last_marked_ready_for_sending_at_revision - - @last_marked_ready_for_sending_at_revision.setter - def last_marked_ready_for_sending_at_revision( - self, last_marked_ready_for_sending_at_revision: "int | Unset_Type" - ) -> None: - """Sets the last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - - Parameters - ---------- - last_marked_ready_for_sending_at_revision: int | Unset_Type - The last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - """ - # Field is not nullable - if last_marked_ready_for_sending_at_revision is None: - raise ValueError( - "Invalid value for 'last_marked_ready_for_sending_at_revision', must not be 'None'" - ) - self._last_marked_ready_for_sending_at_revision = last_marked_ready_for_sending_at_revision - - @property - def last_update_generated_by_user_name(self) -> "str | None | Unset_Type": - """Gets the last_update_generated_by_user_name of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The last_update_generated_by_user_name of this GsaDataUpdaterProject. - """ - return self._last_update_generated_by_user_name - - @last_update_generated_by_user_name.setter - def last_update_generated_by_user_name( - self, last_update_generated_by_user_name: "str | None | Unset_Type" - ) -> None: - """Sets the last_update_generated_by_user_name of this GsaDataUpdaterProject. - - Parameters - ---------- - last_update_generated_by_user_name: str | None | Unset_Type - The last_update_generated_by_user_name of this GsaDataUpdaterProject. - """ - self._last_update_generated_by_user_name = last_update_generated_by_user_name - - @property - def time_last_update_generated(self) -> "datetime | Unset_Type": - """Gets the time_last_update_generated of this GsaDataUpdaterProject. - - Returns - ------- - datetime | Unset_Type - The time_last_update_generated of this GsaDataUpdaterProject. - """ - return self._time_last_update_generated - - @time_last_update_generated.setter - def time_last_update_generated( - self, time_last_update_generated: "datetime | Unset_Type" - ) -> None: - """Sets the time_last_update_generated of this GsaDataUpdaterProject. - - Parameters - ---------- - time_last_update_generated: datetime | Unset_Type - The time_last_update_generated of this GsaDataUpdaterProject. - """ - # Field is not nullable - if time_last_update_generated is None: - raise ValueError("Invalid value for 'time_last_update_generated', must not be 'None'") - self._time_last_update_generated = time_last_update_generated - - @property - def profile_id(self) -> "str | None | Unset_Type": - """Gets the profile_id of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The profile_id of this GsaDataUpdaterProject. - """ - return self._profile_id - - @profile_id.setter - def profile_id(self, profile_id: "str | None | Unset_Type") -> None: - """Sets the profile_id of this GsaDataUpdaterProject. - - Parameters - ---------- - profile_id: str | None | Unset_Type - The profile_id of this GsaDataUpdaterProject. - """ - self._profile_id = profile_id - - @property - def selection(self) -> "GsaSelection | Unset_Type": - """Gets the selection of this GsaDataUpdaterProject. - - Returns - ------- - GsaSelection | Unset_Type - The selection of this GsaDataUpdaterProject. - """ - return self._selection - - @selection.setter - def selection(self, selection: "GsaSelection | Unset_Type") -> None: - """Sets the selection of this GsaDataUpdaterProject. - - Parameters - ---------- - selection: GsaSelection | Unset_Type - The selection of this GsaDataUpdaterProject. - """ - # Field is not nullable - if selection is None: - raise ValueError("Invalid value for 'selection', must not be 'None'") - self._selection = selection - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdaterProject): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database.py index e0ce3978..ddbdc47d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database.py @@ -65,19 +65,14 @@ class GsaDatabase(ModelBase): "is_read_only": "bool", "key": "str", "status": "GsaDatabaseStatus", - "user_capabilities": "GsaDatabaseUserCapabilities", "author": "str", "company": "str", - "configuration_details": "GsaConfigurationDetails", "currency_code": "str", - "default_table": "GsaSlimNamedEntity", "guid": "str", "index_in_sync": "bool", "index_out_of_date_duration": "str", "index_up_to_date": "bool", "is_access_controlled": "bool", - "is_implicit_profile_disabled": "bool", - "issues": "GsaDatabaseIssues", "name": "str", "notes": "str", "schema_version": "str", @@ -89,19 +84,14 @@ class GsaDatabase(ModelBase): "is_read_only": "isReadOnly", "key": "key", "status": "status", - "user_capabilities": "userCapabilities", "author": "author", "company": "company", - "configuration_details": "configurationDetails", "currency_code": "currencyCode", - "default_table": "defaultTable", "guid": "guid", "index_in_sync": "indexInSync", "index_out_of_date_duration": "indexOutOfDateDuration", "index_up_to_date": "indexUpToDate", "is_access_controlled": "isAccessControlled", - "is_implicit_profile_disabled": "isImplicitProfileDisabled", - "issues": "issues", "name": "name", "notes": "notes", "schema_version": "schemaVersion", @@ -109,11 +99,7 @@ class GsaDatabase(ModelBase): } subtype_mapping: dict[str, str] = { - "defaultTable": "GsaSlimNamedEntity", "status": "GsaDatabaseStatus", - "userCapabilities": "GsaDatabaseUserCapabilities", - "configurationDetails": "GsaConfigurationDetails", - "issues": "GsaDatabaseIssues", } discriminator: Optional[str] = None @@ -125,19 +111,14 @@ def __init__( is_read_only: "bool", key: "str", status: "GsaDatabaseStatus", - user_capabilities: "GsaDatabaseUserCapabilities", author: "str | None | Unset_Type" = Unset, company: "str | None | Unset_Type" = Unset, - configuration_details: "GsaConfigurationDetails | Unset_Type" = Unset, currency_code: "str | None | Unset_Type" = Unset, - default_table: "GsaSlimNamedEntity | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, index_in_sync: "bool | None | Unset_Type" = Unset, index_out_of_date_duration: "str | None | Unset_Type" = Unset, index_up_to_date: "bool | None | Unset_Type" = Unset, is_access_controlled: "bool | None | Unset_Type" = Unset, - is_implicit_profile_disabled: "bool | None | Unset_Type" = Unset, - issues: "GsaDatabaseIssues | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, notes: "str | None | Unset_Type" = Unset, schema_version: "str | None | Unset_Type" = Unset, @@ -151,19 +132,14 @@ def __init__( is_read_only: bool key: str status: GsaDatabaseStatus - user_capabilities: GsaDatabaseUserCapabilities author: str | None, optional company: str | None, optional - configuration_details: GsaConfigurationDetails, optional currency_code: str | None, optional - default_table: GsaSlimNamedEntity, optional guid: str | None, optional index_in_sync: bool | None, optional index_out_of_date_duration: str | None, optional index_up_to_date: bool | None, optional is_access_controlled: bool | None, optional - is_implicit_profile_disabled: bool | None, optional - issues: GsaDatabaseIssues, optional name: str | None, optional notes: str | None, optional schema_version: str | None, optional @@ -174,8 +150,6 @@ def __init__( self._notes: str | None | Unset_Type = Unset self._currency_code: str | None | Unset_Type = Unset self._is_access_controlled: bool | None | Unset_Type = Unset - self._is_implicit_profile_disabled: bool | None | Unset_Type = Unset - self._default_table: GsaSlimNamedEntity | Unset_Type = Unset self._key: str self._status: GsaDatabaseStatus self._is_read_only: bool @@ -187,9 +161,6 @@ def __init__( self._index_up_to_date: bool | None | Unset_Type = Unset self._index_out_of_date_duration: str | None | Unset_Type = Unset self._schema_version: str | None | Unset_Type = Unset - self._user_capabilities: GsaDatabaseUserCapabilities - self._configuration_details: GsaConfigurationDetails | Unset_Type = Unset - self._issues: GsaDatabaseIssues | Unset_Type = Unset if author is not Unset: self.author = author @@ -201,10 +172,6 @@ def __init__( self.currency_code = currency_code if is_access_controlled is not Unset: self.is_access_controlled = is_access_controlled - if is_implicit_profile_disabled is not Unset: - self.is_implicit_profile_disabled = is_implicit_profile_disabled - if default_table is not Unset: - self.default_table = default_table self.key = key self.status = status self.is_read_only = is_read_only @@ -223,11 +190,6 @@ def __init__( self.index_out_of_date_duration = index_out_of_date_duration if schema_version is not Unset: self.schema_version = schema_version - self.user_capabilities = user_capabilities - if configuration_details is not Unset: - self.configuration_details = configuration_details - if issues is not Unset: - self.issues = issues @property def author(self) -> "str | None | Unset_Type": @@ -339,57 +301,6 @@ def is_access_controlled(self, is_access_controlled: "bool | None | Unset_Type") """ self._is_access_controlled = is_access_controlled - @property - def is_implicit_profile_disabled(self) -> "bool | None | Unset_Type": - """Gets the is_implicit_profile_disabled of this GsaDatabase. - When a database is added to the Granta MI system, it automatically has a standalone database Profile known as an implicit Profile. The implicit Profile for this database can be disabled by setting this flag. - - Returns - ------- - bool | None | Unset_Type - The is_implicit_profile_disabled of this GsaDatabase. - """ - return self._is_implicit_profile_disabled - - @is_implicit_profile_disabled.setter - def is_implicit_profile_disabled( - self, is_implicit_profile_disabled: "bool | None | Unset_Type" - ) -> None: - """Sets the is_implicit_profile_disabled of this GsaDatabase. - When a database is added to the Granta MI system, it automatically has a standalone database Profile known as an implicit Profile. The implicit Profile for this database can be disabled by setting this flag. - - Parameters - ---------- - is_implicit_profile_disabled: bool | None | Unset_Type - The is_implicit_profile_disabled of this GsaDatabase. - """ - self._is_implicit_profile_disabled = is_implicit_profile_disabled - - @property - def default_table(self) -> "GsaSlimNamedEntity | Unset_Type": - """Gets the default_table of this GsaDatabase. - - Returns - ------- - GsaSlimNamedEntity | Unset_Type - The default_table of this GsaDatabase. - """ - return self._default_table - - @default_table.setter - def default_table(self, default_table: "GsaSlimNamedEntity | Unset_Type") -> None: - """Sets the default_table of this GsaDatabase. - - Parameters - ---------- - default_table: GsaSlimNamedEntity | Unset_Type - The default_table of this GsaDatabase. - """ - # Field is not nullable - if default_table is None: - raise ValueError("Invalid value for 'default_table', must not be 'None'") - self._default_table = default_table - @property def key(self) -> "str": """Gets the key of this GsaDatabase. @@ -658,86 +569,6 @@ def schema_version(self, schema_version: "str | None | Unset_Type") -> None: """ self._schema_version = schema_version - @property - def user_capabilities(self) -> "GsaDatabaseUserCapabilities": - """Gets the user_capabilities of this GsaDatabase. - - Returns - ------- - GsaDatabaseUserCapabilities - The user_capabilities of this GsaDatabase. - """ - return self._user_capabilities - - @user_capabilities.setter - def user_capabilities(self, user_capabilities: "GsaDatabaseUserCapabilities") -> None: - """Sets the user_capabilities of this GsaDatabase. - - Parameters - ---------- - user_capabilities: GsaDatabaseUserCapabilities - The user_capabilities of this GsaDatabase. - """ - # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") - # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities - - @property - def configuration_details(self) -> "GsaConfigurationDetails | Unset_Type": - """Gets the configuration_details of this GsaDatabase. - - Returns - ------- - GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaDatabase. - """ - return self._configuration_details - - @configuration_details.setter - def configuration_details( - self, configuration_details: "GsaConfigurationDetails | Unset_Type" - ) -> None: - """Sets the configuration_details of this GsaDatabase. - - Parameters - ---------- - configuration_details: GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaDatabase. - """ - # Field is not nullable - if configuration_details is None: - raise ValueError("Invalid value for 'configuration_details', must not be 'None'") - self._configuration_details = configuration_details - - @property - def issues(self) -> "GsaDatabaseIssues | Unset_Type": - """Gets the issues of this GsaDatabase. - - Returns - ------- - GsaDatabaseIssues | Unset_Type - The issues of this GsaDatabase. - """ - return self._issues - - @issues.setter - def issues(self, issues: "GsaDatabaseIssues | Unset_Type") -> None: - """Sets the issues of this GsaDatabase. - - Parameters - ---------- - issues: GsaDatabaseIssues | Unset_Type - The issues of this GsaDatabase. - """ - # Field is not nullable - if issues is None: - raise ValueError("Invalid value for 'issues', must not be 'None'") - self._issues = issues - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_access_control_entity.py deleted file mode 100644 index 02a57244..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_access_control_entity.py +++ /dev/null @@ -1,124 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity import ( # noqa: F401 - GsaAccessControlEntity, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity_type import ( - GsaAccessControlEntityType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseAccessControlEntity(GsaAccessControlEntity): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlEntityType", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlEntityType" = GsaAccessControlEntityType.DATABASE, - ) -> None: - """GsaDatabaseAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - """ - super().__init__(entity_type=entity_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_currency_unit_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_currency_unit_usage_data_modification_error_detail.py deleted file mode 100644 index f21ec6a6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_currency_unit_usage_data_modification_error_detail.py +++ /dev/null @@ -1,135 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.DATABASECURRENCYUNIT, - ) -> None: - """GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_issues.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_issues.py deleted file mode 100644 index 80551399..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_issues.py +++ /dev/null @@ -1,189 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseIssues(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_revision_identity_has_decreased": "bool", - "loading_exception_info": "GsaExceptionInformation", - } - - attribute_map: dict[str, str] = { - "database_revision_identity_has_decreased": "databaseRevisionIdentityHasDecreased", - "loading_exception_info": "loadingExceptionInfo", - } - - subtype_mapping: dict[str, str] = { - "loadingExceptionInfo": "GsaExceptionInformation", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_revision_identity_has_decreased: "bool", - loading_exception_info: "GsaExceptionInformation | Unset_Type" = Unset, - ) -> None: - """GsaDatabaseIssues - a model defined in Swagger - - Parameters - ---------- - database_revision_identity_has_decreased: bool - loading_exception_info: GsaExceptionInformation, optional - """ - self._database_revision_identity_has_decreased: bool - self._loading_exception_info: GsaExceptionInformation | Unset_Type = Unset - - self.database_revision_identity_has_decreased = database_revision_identity_has_decreased - if loading_exception_info is not Unset: - self.loading_exception_info = loading_exception_info - - @property - def database_revision_identity_has_decreased(self) -> "bool": - """Gets the database_revision_identity_has_decreased of this GsaDatabaseIssues. - - Returns - ------- - bool - The database_revision_identity_has_decreased of this GsaDatabaseIssues. - """ - return self._database_revision_identity_has_decreased - - @database_revision_identity_has_decreased.setter - def database_revision_identity_has_decreased( - self, database_revision_identity_has_decreased: "bool" - ) -> None: - """Sets the database_revision_identity_has_decreased of this GsaDatabaseIssues. - - Parameters - ---------- - database_revision_identity_has_decreased: bool - The database_revision_identity_has_decreased of this GsaDatabaseIssues. - """ - # Field is not nullable - if database_revision_identity_has_decreased is None: - raise ValueError( - "Invalid value for 'database_revision_identity_has_decreased', must not be 'None'" - ) - # Field is required - if database_revision_identity_has_decreased is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'database_revision_identity_has_decreased', must not be 'Unset'" - ) - self._database_revision_identity_has_decreased = database_revision_identity_has_decreased - - @property - def loading_exception_info(self) -> "GsaExceptionInformation | Unset_Type": - """Gets the loading_exception_info of this GsaDatabaseIssues. - - Returns - ------- - GsaExceptionInformation | Unset_Type - The loading_exception_info of this GsaDatabaseIssues. - """ - return self._loading_exception_info - - @loading_exception_info.setter - def loading_exception_info( - self, loading_exception_info: "GsaExceptionInformation | Unset_Type" - ) -> None: - """Sets the loading_exception_info of this GsaDatabaseIssues. - - Parameters - ---------- - loading_exception_info: GsaExceptionInformation | Unset_Type - The loading_exception_info of this GsaDatabaseIssues. - """ - # Field is not nullable - if loading_exception_info is None: - raise ValueError("Invalid value for 'loading_exception_info', must not be 'None'") - self._loading_exception_info = loading_exception_info - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseIssues): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups.py deleted file mode 100644 index f6c151d6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups.py +++ /dev/null @@ -1,317 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "database_key": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "database_key": "databaseKey", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str", - database_key: "str", - grant_group: "str", - power_user_group: "str", - read_group: "str", - write_group: "str", - ) -> None: - """GsaDatabaseSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str - database_key: str - grant_group: str - power_user_group: str - read_group: str - write_group: str - """ - self._database_key: str - self._admin_group: str - self._grant_group: str - self._power_user_group: str - self._write_group: str - self._read_group: str - - self.database_key = database_key - self.admin_group = admin_group - self.grant_group = grant_group - self.power_user_group = power_user_group - self.write_group = write_group - self.read_group = read_group - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The database_key of this GsaDatabaseSecurityGroups. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - database_key: str - The database_key of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def admin_group(self) -> "str": - """Gets the admin_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The admin_group of this GsaDatabaseSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str") -> None: - """Sets the admin_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - admin_group: str - The admin_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if admin_group is None: - raise ValueError("Invalid value for 'admin_group', must not be 'None'") - # Field is required - if admin_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'admin_group', must not be 'Unset'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str": - """Gets the grant_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The grant_group of this GsaDatabaseSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str") -> None: - """Sets the grant_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - grant_group: str - The grant_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if grant_group is None: - raise ValueError("Invalid value for 'grant_group', must not be 'None'") - # Field is required - if grant_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'grant_group', must not be 'Unset'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str": - """Gets the power_user_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The power_user_group of this GsaDatabaseSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str") -> None: - """Sets the power_user_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - power_user_group: str - The power_user_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if power_user_group is None: - raise ValueError("Invalid value for 'power_user_group', must not be 'None'") - # Field is required - if power_user_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'power_user_group', must not be 'Unset'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str": - """Gets the write_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The write_group of this GsaDatabaseSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str") -> None: - """Sets the write_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - write_group: str - The write_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if write_group is None: - raise ValueError("Invalid value for 'write_group', must not be 'None'") - # Field is required - if write_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'write_group', must not be 'Unset'") - self._write_group = write_group - - @property - def read_group(self) -> "str": - """Gets the read_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The read_group of this GsaDatabaseSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str") -> None: - """Sets the read_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - read_group: str - The read_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if read_group is None: - raise ValueError("Invalid value for 'read_group', must not be 'None'") - # Field is required - if read_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'read_group', must not be 'Unset'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups_info.py deleted file mode 100644 index 5f950b80..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_security_groups_info.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseSecurityGroupsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_security_groups": "list[GsaDatabaseSecurityGroups]", - } - - attribute_map: dict[str, str] = { - "database_security_groups": "databaseSecurityGroups", - } - - subtype_mapping: dict[str, str] = { - "databaseSecurityGroups": "GsaDatabaseSecurityGroups", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_security_groups: "list[GsaDatabaseSecurityGroups]", - ) -> None: - """GsaDatabaseSecurityGroupsInfo - a model defined in Swagger - - Parameters - ---------- - database_security_groups: list[GsaDatabaseSecurityGroups] - """ - self._database_security_groups: list[GsaDatabaseSecurityGroups] - - self.database_security_groups = database_security_groups - - @property - def database_security_groups(self) -> "list[GsaDatabaseSecurityGroups]": - """Gets the database_security_groups of this GsaDatabaseSecurityGroupsInfo. - - Returns - ------- - list[GsaDatabaseSecurityGroups] - The database_security_groups of this GsaDatabaseSecurityGroupsInfo. - """ - return self._database_security_groups - - @database_security_groups.setter - def database_security_groups( - self, database_security_groups: "list[GsaDatabaseSecurityGroups]" - ) -> None: - """Sets the database_security_groups of this GsaDatabaseSecurityGroupsInfo. - - Parameters - ---------- - database_security_groups: list[GsaDatabaseSecurityGroups] - The database_security_groups of this GsaDatabaseSecurityGroupsInfo. - """ - # Field is not nullable - if database_security_groups is None: - raise ValueError("Invalid value for 'database_security_groups', must not be 'None'") - # Field is required - if database_security_groups is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_security_groups', must not be 'Unset'") - self._database_security_groups = database_security_groups - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseSecurityGroupsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_status.py index a64db5ad..6a420f60 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_status.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_status.py @@ -49,6 +49,6 @@ class GsaDatabaseStatus(Enum): UNLOADING = "Unloading" FAILEDTOLOAD = "FailedToLoad" FAILEDTOUNLOAD = "FailedToUnload" + DISABLED = "Disabled" SCHEMAUPGRADEREQUIRED = "SchemaUpgradeRequired" SCHEMADOWNGRADEREQUIRED = "SchemaDowngradeRequired" - MISSING = "Missing" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_user_capabilities.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_user_capabilities.py deleted file mode 100644 index 804dd2df..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_database_user_capabilities.py +++ /dev/null @@ -1,185 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseUserCapabilities(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "can_read": "bool", - "can_write": "bool", - } - - attribute_map: dict[str, str] = { - "can_read": "canRead", - "can_write": "canWrite", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - can_read: "bool", - can_write: "bool", - ) -> None: - """GsaDatabaseUserCapabilities - a model defined in Swagger - - Parameters - ---------- - can_read: bool - can_write: bool - """ - self._can_read: bool - self._can_write: bool - - self.can_read = can_read - self.can_write = can_write - - @property - def can_read(self) -> "bool": - """Gets the can_read of this GsaDatabaseUserCapabilities. - Specifies whether the current user can read from the database. - - Returns - ------- - bool - The can_read of this GsaDatabaseUserCapabilities. - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read: "bool") -> None: - """Sets the can_read of this GsaDatabaseUserCapabilities. - Specifies whether the current user can read from the database. - - Parameters - ---------- - can_read: bool - The can_read of this GsaDatabaseUserCapabilities. - """ - # Field is not nullable - if can_read is None: - raise ValueError("Invalid value for 'can_read', must not be 'None'") - # Field is required - if can_read is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_read', must not be 'Unset'") - self._can_read = can_read - - @property - def can_write(self) -> "bool": - """Gets the can_write of this GsaDatabaseUserCapabilities. - Specifies whether the current user can write to the database. - - Returns - ------- - bool - The can_write of this GsaDatabaseUserCapabilities. - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write: "bool") -> None: - """Sets the can_write of this GsaDatabaseUserCapabilities. - Specifies whether the current user can write to the database. - - Parameters - ---------- - can_write: bool - The can_write of this GsaDatabaseUserCapabilities. - """ - # Field is not nullable - if can_write is None: - raise ValueError("Invalid value for 'can_write', must not be 'None'") - # Field is required - if can_write is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_write', must not be 'Unset'") - self._can_write = can_write - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseUserCapabilities): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_databases_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_databases_info.py index 84872e43..38399ecd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_databases_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_databases_info.py @@ -61,7 +61,7 @@ class GsaDatabasesInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "databases": "list[GsaDatabase]", + "databases": "list[GsaSlimDatabase]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaDatabasesInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "databases": "GsaDatabase", + "databases": "GsaSlimDatabase", } discriminator: Optional[str] = None @@ -77,37 +77,37 @@ class GsaDatabasesInfo(ModelBase): def __init__( self, *, - databases: "list[GsaDatabase] | None | Unset_Type" = Unset, + databases: "list[GsaSlimDatabase] | None | Unset_Type" = Unset, ) -> None: """GsaDatabasesInfo - a model defined in Swagger Parameters ---------- - databases: list[GsaDatabase] | None, optional + databases: list[GsaSlimDatabase] | None, optional """ - self._databases: list[GsaDatabase] | None | Unset_Type = Unset + self._databases: list[GsaSlimDatabase] | None | Unset_Type = Unset if databases is not Unset: self.databases = databases @property - def databases(self) -> "list[GsaDatabase] | None | Unset_Type": + def databases(self) -> "list[GsaSlimDatabase] | None | Unset_Type": """Gets the databases of this GsaDatabasesInfo. Returns ------- - list[GsaDatabase] | None | Unset_Type + list[GsaSlimDatabase] | None | Unset_Type The databases of this GsaDatabasesInfo. """ return self._databases @databases.setter - def databases(self, databases: "list[GsaDatabase] | None | Unset_Type") -> None: + def databases(self, databases: "list[GsaSlimDatabase] | None | Unset_Type") -> None: """Sets the databases of this GsaDatabasesInfo. Parameters ---------- - databases: list[GsaDatabase] | None | Unset_Type + databases: list[GsaSlimDatabase] | None | Unset_Type The databases of this GsaDatabasesInfo. """ self._databases = databases diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_date_time_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_date_time_attribute.py index 88b45998..0327756c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_date_time_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_date_time_attribute.py @@ -69,7 +69,6 @@ class GsaDateTimeAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaDateTimeAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.DATETIME, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion.py index ea81376e..c330c4c5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion.py @@ -103,7 +103,7 @@ class GsaDatumCriterion(ModelBase): "range".lower(): "#/components/schemas/GsaRangeDatumCriterion", "shortText".lower(): "#/components/schemas/GsaShortTextDatumCriterion", "shortTextPrefix".lower(): "#/components/schemas/GsaShortTextPrefixDatumCriterion", - "smartLinkingValue".lower(): "#/components/schemas/GsaLinkingValueExistsDatumCriterion", + "dynamicLinkingValue".lower(): "#/components/schemas/GsaLinkingValueExistsDatumCriterion", } discriminator: Optional[str] = "type" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion_type.py index bb5b3cde..ac2f8a4c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_datum_criterion_type.py @@ -70,4 +70,4 @@ class GsaDatumCriterionType(Enum): RANGE = "range" SHORTTEXT = "shortText" SHORTTEXTPREFIX = "shortTextPrefix" - SMARTLINKINGVALUE = "smartLinkingValue" + DYNAMICLINKINGVALUE = "dynamicLinkingValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_fallback_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_fallback_security_groups.py deleted file mode 100644 index 6a3a3faf..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_fallback_security_groups.py +++ /dev/null @@ -1,317 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultFallbackSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "system_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "system_group": "systemGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str", - grant_group: "str", - power_user_group: "str", - read_group: "str", - system_group: "str", - write_group: "str", - ) -> None: - """GsaDefaultFallbackSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str - grant_group: str - power_user_group: str - read_group: str - system_group: str - write_group: str - """ - self._system_group: str - self._admin_group: str - self._grant_group: str - self._power_user_group: str - self._write_group: str - self._read_group: str - - self.system_group = system_group - self.admin_group = admin_group - self.grant_group = grant_group - self.power_user_group = power_user_group - self.write_group = write_group - self.read_group = read_group - - @property - def system_group(self) -> "str": - """Gets the system_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The system_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._system_group - - @system_group.setter - def system_group(self, system_group: "str") -> None: - """Sets the system_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - system_group: str - The system_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if system_group is None: - raise ValueError("Invalid value for 'system_group', must not be 'None'") - # Field is required - if system_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'system_group', must not be 'Unset'") - self._system_group = system_group - - @property - def admin_group(self) -> "str": - """Gets the admin_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The admin_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str") -> None: - """Sets the admin_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - admin_group: str - The admin_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if admin_group is None: - raise ValueError("Invalid value for 'admin_group', must not be 'None'") - # Field is required - if admin_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'admin_group', must not be 'Unset'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str": - """Gets the grant_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The grant_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str") -> None: - """Sets the grant_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - grant_group: str - The grant_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if grant_group is None: - raise ValueError("Invalid value for 'grant_group', must not be 'None'") - # Field is required - if grant_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'grant_group', must not be 'Unset'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str": - """Gets the power_user_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The power_user_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str") -> None: - """Sets the power_user_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - power_user_group: str - The power_user_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if power_user_group is None: - raise ValueError("Invalid value for 'power_user_group', must not be 'None'") - # Field is required - if power_user_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'power_user_group', must not be 'Unset'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str": - """Gets the write_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The write_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str") -> None: - """Sets the write_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - write_group: str - The write_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if write_group is None: - raise ValueError("Invalid value for 'write_group', must not be 'None'") - # Field is required - if write_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'write_group', must not be 'Unset'") - self._write_group = write_group - - @property - def read_group(self) -> "str": - """Gets the read_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The read_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str") -> None: - """Sets the read_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - read_group: str - The read_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if read_group is None: - raise ValueError("Invalid value for 'read_group', must not be 'None'") - # Field is required - if read_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'read_group', must not be 'Unset'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultFallbackSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_layout_guid_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_layout_guid_error_detail.py deleted file mode 100644 index 0d5723ff..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_layout_guid_error_detail.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultLayoutGuidErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - "layout_guid": "str", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "layout_guid": "layoutGuid", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.DEFAULTLAYOUTGUID, - layout_guid: "str | Unset_Type" = Unset, - table_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaDefaultLayoutGuidErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - layout_guid: str, optional - table_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._table_guid: str | Unset_Type = Unset - self._layout_guid: str | Unset_Type = Unset - - if table_guid is not Unset: - self.table_guid = table_guid - if layout_guid is not Unset: - self.layout_guid = layout_guid - - @property - def table_guid(self) -> "str | Unset_Type": - """Gets the table_guid of this GsaDefaultLayoutGuidErrorDetail. - - Returns - ------- - str | Unset_Type - The table_guid of this GsaDefaultLayoutGuidErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | Unset_Type") -> None: - """Sets the table_guid of this GsaDefaultLayoutGuidErrorDetail. - - Parameters - ---------- - table_guid: str | Unset_Type - The table_guid of this GsaDefaultLayoutGuidErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - self._table_guid = table_guid - - @property - def layout_guid(self) -> "str | Unset_Type": - """Gets the layout_guid of this GsaDefaultLayoutGuidErrorDetail. - - Returns - ------- - str | Unset_Type - The layout_guid of this GsaDefaultLayoutGuidErrorDetail. - """ - return self._layout_guid - - @layout_guid.setter - def layout_guid(self, layout_guid: "str | Unset_Type") -> None: - """Sets the layout_guid of this GsaDefaultLayoutGuidErrorDetail. - - Parameters - ---------- - layout_guid: str | Unset_Type - The layout_guid of this GsaDefaultLayoutGuidErrorDetail. - """ - # Field is not nullable - if layout_guid is None: - raise ValueError("Invalid value for 'layout_guid', must not be 'None'") - self._layout_guid = layout_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultLayoutGuidErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_guid_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_guid_parameter_error_detail.py deleted file mode 100644 index 7e314832..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_guid_parameter_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueGuidParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "default_parameter_value_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "default_parameter_value_guid": "defaultParameterValueGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEGUID, - default_parameter_value_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaDefaultParameterValueGuidParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - default_parameter_value_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._default_parameter_value_guid: str | Unset_Type = Unset - - if default_parameter_value_guid is not Unset: - self.default_parameter_value_guid = default_parameter_value_guid - - @property - def default_parameter_value_guid(self) -> "str | Unset_Type": - """Gets the default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - - Returns - ------- - str | Unset_Type - The default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - """ - return self._default_parameter_value_guid - - @default_parameter_value_guid.setter - def default_parameter_value_guid( - self, default_parameter_value_guid: "str | Unset_Type" - ) -> None: - """Sets the default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - - Parameters - ---------- - default_parameter_value_guid: str | Unset_Type - The default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - """ - # Field is not nullable - if default_parameter_value_guid is None: - raise ValueError("Invalid value for 'default_parameter_value_guid', must not be 'None'") - self._default_parameter_value_guid = default_parameter_value_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueGuidParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_and_guid_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_and_guid_parameter_error_detail.py deleted file mode 100644 index 14325dda..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_and_guid_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueIndexAndGuidParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEINDEXANDGUID, - ) -> None: - """GsaDefaultParameterValueIndexAndGuidParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueIndexAndGuidParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_parameter_error_detail.py deleted file mode 100644 index 9feb3544..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_parameter_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueIndexParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "default_parameter_value_index": "int", - "number_of_parameter_values": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "default_parameter_value_index": "defaultParameterValueIndex", - "number_of_parameter_values": "numberOfParameterValues", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEINDEX, - default_parameter_value_index: "int | Unset_Type" = Unset, - number_of_parameter_values: "int | Unset_Type" = Unset, - ) -> None: - """GsaDefaultParameterValueIndexParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - default_parameter_value_index: int, optional - number_of_parameter_values: int, optional - """ - super().__init__(message=message, reason=reason) - self._default_parameter_value_index: int | Unset_Type = Unset - self._number_of_parameter_values: int | Unset_Type = Unset - - if default_parameter_value_index is not Unset: - self.default_parameter_value_index = default_parameter_value_index - if number_of_parameter_values is not Unset: - self.number_of_parameter_values = number_of_parameter_values - - @property - def default_parameter_value_index(self) -> "int | Unset_Type": - """Gets the default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Returns - ------- - int | Unset_Type - The default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - return self._default_parameter_value_index - - @default_parameter_value_index.setter - def default_parameter_value_index( - self, default_parameter_value_index: "int | Unset_Type" - ) -> None: - """Sets the default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Parameters - ---------- - default_parameter_value_index: int | Unset_Type - The default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - # Field is not nullable - if default_parameter_value_index is None: - raise ValueError( - "Invalid value for 'default_parameter_value_index', must not be 'None'" - ) - self._default_parameter_value_index = default_parameter_value_index - - @property - def number_of_parameter_values(self) -> "int | Unset_Type": - """Gets the number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Returns - ------- - int | Unset_Type - The number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - return self._number_of_parameter_values - - @number_of_parameter_values.setter - def number_of_parameter_values(self, number_of_parameter_values: "int | Unset_Type") -> None: - """Sets the number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Parameters - ---------- - number_of_parameter_values: int | Unset_Type - The number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - # Field is not nullable - if number_of_parameter_values is None: - raise ValueError("Invalid value for 'number_of_parameter_values', must not be 'None'") - self._number_of_parameter_values = number_of_parameter_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueIndexParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_without_values_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_without_values_parameter_error_detail.py deleted file mode 100644 index 41f73dd7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_parameter_value_index_without_values_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEINDEXWITHOUTVALUES, - ) -> None: - """GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_subset_guid_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_subset_guid_error_detail.py deleted file mode 100644 index 59039c49..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_default_subset_guid_error_detail.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultSubsetGuidErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - "subset_guid": "str", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "subset_guid": "subsetGuid", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.DEFAULTSUBSETGUID, - subset_guid: "str | Unset_Type" = Unset, - table_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaDefaultSubsetGuidErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - subset_guid: str, optional - table_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._table_guid: str | Unset_Type = Unset - self._subset_guid: str | Unset_Type = Unset - - if table_guid is not Unset: - self.table_guid = table_guid - if subset_guid is not Unset: - self.subset_guid = subset_guid - - @property - def table_guid(self) -> "str | Unset_Type": - """Gets the table_guid of this GsaDefaultSubsetGuidErrorDetail. - - Returns - ------- - str | Unset_Type - The table_guid of this GsaDefaultSubsetGuidErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | Unset_Type") -> None: - """Sets the table_guid of this GsaDefaultSubsetGuidErrorDetail. - - Parameters - ---------- - table_guid: str | Unset_Type - The table_guid of this GsaDefaultSubsetGuidErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - self._table_guid = table_guid - - @property - def subset_guid(self) -> "str | Unset_Type": - """Gets the subset_guid of this GsaDefaultSubsetGuidErrorDetail. - - Returns - ------- - str | Unset_Type - The subset_guid of this GsaDefaultSubsetGuidErrorDetail. - """ - return self._subset_guid - - @subset_guid.setter - def subset_guid(self, subset_guid: "str | Unset_Type") -> None: - """Sets the subset_guid of this GsaDefaultSubsetGuidErrorDetail. - - Parameters - ---------- - subset_guid: str | Unset_Type - The subset_guid of this GsaDefaultSubsetGuidErrorDetail. - """ - # Field is not nullable - if subset_guid is None: - raise ValueError("Invalid value for 'subset_guid', must not be 'None'") - self._subset_guid = subset_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultSubsetGuidErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_entity_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_entity_type.py deleted file mode 100644 index e34b6e9c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_entity_type.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDeletionEntityType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTE = "attribute" - CONSTANT = "constant" - DATAUPDATE = "dataUpdate" - DISCRETETYPE = "discreteType" - EXPRESSION = "expression" - PARAMETER = "parameter" - PARAMETERVALUE = "parameterValue" - TABLE = "table" - UNIT = "unit" - QUALITYSYSTEM = "qualitySystem" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_exception.py deleted file mode 100644 index 2cbed796..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_deletion_exception.py +++ /dev/null @@ -1,295 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", - "errors": "list[GsaDataModificationErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "entityType": "GsaDeletionEntityType", - "errors": "GsaDataModificationErrorDetail", - } - - discriminator_value_class_map = { - "attribute".lower(): "#/components/schemas/GsaAttributeDeletionException", - "constant".lower(): "#/components/schemas/GsaConstantDeletionException", - "dataUpdate".lower(): "#/components/schemas/GsaDataUpdateDeletionException", - "discreteType".lower(): "#/components/schemas/GsaDiscreteTypeDeletionException", - "expression".lower(): "#/components/schemas/GsaExpressionDeletionException", - "parameter".lower(): "#/components/schemas/GsaParameterDeletionException", - "parameterValue".lower(): "#/components/schemas/GsaParameterValueDeletionException", - "table".lower(): "#/components/schemas/GsaTableDeletionException", - "unit".lower(): "#/components/schemas/GsaUnitDeletionException", - "qualitySystem".lower(): "#/components/schemas/GsaQualitySystemDeletionException", - } - - discriminator: Optional[str] = "entityType" - - def __init__( - self, - *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDeletionException - a model defined in Swagger - - Parameters - ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional - errors: list[GsaDataModificationErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._entity_type: GsaDeletionEntityType - self._entity_guid: str - self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.entity_type = entity_type - self.entity_guid = entity_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def entity_type(self) -> "GsaDeletionEntityType": - """Gets the entity_type of this GsaDeletionException. - - Returns - ------- - GsaDeletionEntityType - The entity_type of this GsaDeletionException. - """ - return self._entity_type - - @entity_type.setter - def entity_type(self, entity_type: "GsaDeletionEntityType") -> None: - """Sets the entity_type of this GsaDeletionException. - - Parameters - ---------- - entity_type: GsaDeletionEntityType - The entity_type of this GsaDeletionException. - """ - # Field is not nullable - if entity_type is None: - raise ValueError("Invalid value for 'entity_type', must not be 'None'") - # Field is required - if entity_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entity_type', must not be 'Unset'") - self._entity_type = entity_type - - @property - def entity_guid(self) -> "str": - """Gets the entity_guid of this GsaDeletionException. - - Returns - ------- - str - The entity_guid of this GsaDeletionException. - """ - return self._entity_guid - - @entity_guid.setter - def entity_guid(self, entity_guid: "str") -> None: - """Sets the entity_guid of this GsaDeletionException. - - Parameters - ---------- - entity_guid: str - The entity_guid of this GsaDeletionException. - """ - # Field is not nullable - if entity_guid is None: - raise ValueError("Invalid value for 'entity_guid', must not be 'None'") - # Field is required - if entity_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entity_guid', must not be 'Unset'") - self._entity_guid = entity_guid - - @property - def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDeletionException. - - Returns - ------- - list[GsaDataModificationErrorDetail] | None | Unset_Type - The errors of this GsaDeletionException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaDeletionException. - - Parameters - ---------- - errors: list[GsaDataModificationErrorDetail] | None | Unset_Type - The errors of this GsaDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_description_length_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_description_length_file_error_detail.py deleted file mode 100644 index 105ca78f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_description_length_file_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDescriptionLengthFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "max_length_of_file_description": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "max_length_of_file_description": "maxLengthOfFileDescription", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.DESCRIPTIONLENGTH, - max_length_of_file_description: "int | Unset_Type" = Unset, - ) -> None: - """GsaDescriptionLengthFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - max_length_of_file_description: int, optional - """ - super().__init__(message=message, reason=reason) - self._max_length_of_file_description: int | Unset_Type = Unset - - if max_length_of_file_description is not Unset: - self.max_length_of_file_description = max_length_of_file_description - - @property - def max_length_of_file_description(self) -> "int | Unset_Type": - """Gets the max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - - Returns - ------- - int | Unset_Type - The max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - """ - return self._max_length_of_file_description - - @max_length_of_file_description.setter - def max_length_of_file_description( - self, max_length_of_file_description: "int | Unset_Type" - ) -> None: - """Sets the max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - - Parameters - ---------- - max_length_of_file_description: int | Unset_Type - The max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - """ - # Field is not nullable - if max_length_of_file_description is None: - raise ValueError( - "Invalid value for 'max_length_of_file_description', must not be 'None'" - ) - self._max_length_of_file_description = max_length_of_file_description - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDescriptionLengthFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_attribute.py index 0153cc29..0282c61e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_attribute.py @@ -71,7 +71,6 @@ class GsaDiscreteAttribute(GsaAttribute): "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -88,7 +87,6 @@ class GsaDiscreteAttribute(GsaAttribute): "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -113,7 +111,6 @@ def __init__( info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", is_multi_valued: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.DISCRETE, @@ -132,7 +129,6 @@ def __init__( info: GsaAttributeInfo is_hidden_from_search_criteria: bool is_multi_valued: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -146,7 +142,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_functional_attribute.py index bf790670..617811bc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_functional_attribute.py @@ -71,7 +71,6 @@ class GsaDiscreteFunctionalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -88,7 +87,6 @@ class GsaDiscreteFunctionalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -114,7 +112,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.DISCRETEFUNCTIONAL, @@ -133,7 +130,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -147,7 +143,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter.py index 3216e53f..e51e1edd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter.py @@ -70,6 +70,7 @@ class GsaDiscreteParameter(GsaParameter): "name": "str", "type": "GsaParameterType", "values": "list[GsaDiscreteParameterValue]", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -79,6 +80,7 @@ class GsaDiscreteParameter(GsaParameter): "name": "name", "type": "type", "values": "values", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -96,6 +98,7 @@ def __init__( name: "str", type: "GsaParameterType" = GsaParameterType.DISCRETE, values: "list[GsaDiscreteParameterValue]", + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaDiscreteParameter - a model defined in Swagger @@ -107,6 +110,7 @@ def __init__( name: str type: GsaParameterType values: list[GsaDiscreteParameterValue] + help_path: str | None, optional """ super().__init__( default_parameter_value_guid=default_parameter_value_guid, @@ -114,6 +118,7 @@ def __init__( guid=guid, name=name, type=type, + help_path=help_path, ) self._values: list[GsaDiscreteParameterValue] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter_value.py index 45ef881d..b2c32acc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_parameter_value.py @@ -71,14 +71,12 @@ class GsaDiscreteParameterValue(GsaParameterValue): "guid": "str", "name": "str", "type": "GsaParameterValueType", - "parameter_guid": "str", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", "type": "type", - "parameter_guid": "parameterGuid", } subtype_mapping: dict[str, str] = {} @@ -91,7 +89,6 @@ def __init__( guid: "str", name: "str", type: "GsaParameterValueType" = GsaParameterValueType.DISCRETE, - parameter_guid: "str | Unset_Type" = Unset, ) -> None: """GsaDiscreteParameterValue - a model defined in Swagger @@ -100,9 +97,8 @@ def __init__( guid: str name: str type: GsaParameterValueType - parameter_guid: str, optional """ - super().__init__(guid=guid, type=type, parameter_guid=parameter_guid) + super().__init__(guid=guid, type=type) self._name: str self.name = name diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_quality_system.py deleted file mode 100644 index 4228d279..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_quality_system.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system import ( # noqa: F401 - GsaQualitySystem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_type import ( - GsaQualitySystemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteQualitySystem(GsaQualitySystem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "quality_discrete_values": "list[GsaQualityDiscreteValue]", - "threshold_value": "GsaQualityDiscreteValue", - "type": "GsaQualitySystemType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "quality_discrete_values": "qualityDiscreteValues", - "threshold_value": "thresholdValue", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "thresholdValue": "GsaQualityDiscreteValue", - "qualityDiscreteValues": "GsaQualityDiscreteValue", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - quality_discrete_values: "list[GsaQualityDiscreteValue]", - threshold_value: "GsaQualityDiscreteValue", - type: "GsaQualitySystemType" = GsaQualitySystemType.DISCRETE, - ) -> None: - """GsaDiscreteQualitySystem - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - quality_discrete_values: list[GsaQualityDiscreteValue] - threshold_value: GsaQualityDiscreteValue - type: GsaQualitySystemType - """ - super().__init__(guid=guid, name=name, type=type) - self._threshold_value: GsaQualityDiscreteValue - self._quality_discrete_values: list[GsaQualityDiscreteValue] - - self.threshold_value = threshold_value - self.quality_discrete_values = quality_discrete_values - - @property - def threshold_value(self) -> "GsaQualityDiscreteValue": - """Gets the threshold_value of this GsaDiscreteQualitySystem. - - Returns - ------- - GsaQualityDiscreteValue - The threshold_value of this GsaDiscreteQualitySystem. - """ - return self._threshold_value - - @threshold_value.setter - def threshold_value(self, threshold_value: "GsaQualityDiscreteValue") -> None: - """Sets the threshold_value of this GsaDiscreteQualitySystem. - - Parameters - ---------- - threshold_value: GsaQualityDiscreteValue - The threshold_value of this GsaDiscreteQualitySystem. - """ - # Field is not nullable - if threshold_value is None: - raise ValueError("Invalid value for 'threshold_value', must not be 'None'") - # Field is required - if threshold_value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'threshold_value', must not be 'Unset'") - self._threshold_value = threshold_value - - @property - def quality_discrete_values(self) -> "list[GsaQualityDiscreteValue]": - """Gets the quality_discrete_values of this GsaDiscreteQualitySystem. - - Returns - ------- - list[GsaQualityDiscreteValue] - The quality_discrete_values of this GsaDiscreteQualitySystem. - """ - return self._quality_discrete_values - - @quality_discrete_values.setter - def quality_discrete_values( - self, quality_discrete_values: "list[GsaQualityDiscreteValue]" - ) -> None: - """Sets the quality_discrete_values of this GsaDiscreteQualitySystem. - - Parameters - ---------- - quality_discrete_values: list[GsaQualityDiscreteValue] - The quality_discrete_values of this GsaDiscreteQualitySystem. - """ - # Field is not nullable - if quality_discrete_values is None: - raise ValueError("Invalid value for 'quality_discrete_values', must not be 'None'") - # Field is required - if quality_discrete_values is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'quality_discrete_values', must not be 'Unset'") - self._quality_discrete_values = quality_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type.py index ed02a20c..5d0faec5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type.py @@ -64,7 +64,6 @@ class GsaDiscreteType(ModelBase): "discrete_values": "list[GsaDiscreteValuesDiscreteValue]", "guid": "str", "is_ordered": "bool", - "is_protected": "bool", "name": "str", } @@ -72,7 +71,6 @@ class GsaDiscreteType(ModelBase): "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -88,7 +86,6 @@ def __init__( discrete_values: "list[GsaDiscreteValuesDiscreteValue]", guid: "str", is_ordered: "bool", - is_protected: "bool", name: "str", ) -> None: """GsaDiscreteType - a model defined in Swagger @@ -98,18 +95,15 @@ def __init__( discrete_values: list[GsaDiscreteValuesDiscreteValue] guid: str is_ordered: bool - is_protected: bool name: str """ self._discrete_values: list[GsaDiscreteValuesDiscreteValue] self._is_ordered: bool - self._is_protected: bool self._name: str self._guid: str self.discrete_values = discrete_values self.is_ordered = is_ordered - self.is_protected = is_protected self.name = name self.guid = guid @@ -169,36 +163,6 @@ def is_ordered(self, is_ordered: "bool") -> None: raise ValueError("Invalid value for 'is_ordered', must not be 'Unset'") self._is_ordered = is_ordered - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaDiscreteType. - If true, the discrete type is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaDiscreteType. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaDiscreteType. - If true, the discrete type is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaDiscreteType. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def name(self) -> "str": """Gets the name of this GsaDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_creation_exception.py deleted file mode 100644 index 27abf5a1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteTypeCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaDiscreteTypeErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDiscreteTypeErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDiscreteTypeErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDiscreteTypeCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaDiscreteTypeErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaDiscreteTypeErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDiscreteTypeCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDiscreteTypeCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDiscreteTypeCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDiscreteTypeCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDiscreteTypeCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDiscreteTypeCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDiscreteTypeCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDiscreteTypeCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaDiscreteTypeCreationException. - - Returns - ------- - str - The name of this GsaDiscreteTypeCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaDiscreteTypeCreationException. - - Parameters - ---------- - name: str - The name of this GsaDiscreteTypeCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaDiscreteTypeErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDiscreteTypeCreationException. - - Returns - ------- - list[GsaDiscreteTypeErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteTypeCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDiscreteTypeErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaDiscreteTypeCreationException. - - Parameters - ---------- - errors: list[GsaDiscreteTypeErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteTypeCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteTypeCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_deletion_exception.py index 748c6977..f469d901 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_deletion_exception.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaDiscreteTypeDeletionException(GsaDeletionException): +class GsaDiscreteTypeDeletionException(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,31 +61,28 @@ class GsaDiscreteTypeDeletionException(GsaDeletionException): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", "code": "code", "errors": "errors", "message": "message", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "code": "SystemNetHttpStatusCode", + "errors": "GsaDataModificationErrorDetail", + } discriminator: Optional[str] = None def __init__( self, *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.DISCRETETYPE, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -100,19 +90,89 @@ def __init__( Parameters ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) + self._message: str | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset + + if message is not Unset: + self.message = message + if code is not Unset: + self.code = code + if errors is not Unset: + self.errors = errors + + @property + def message(self) -> "str | None | Unset_Type": + """Gets the message of this GsaDiscreteTypeDeletionException. + + Returns + ------- + str | None | Unset_Type + The message of this GsaDiscreteTypeDeletionException. + """ + return self._message + + @message.setter + def message(self, message: "str | None | Unset_Type") -> None: + """Sets the message of this GsaDiscreteTypeDeletionException. + + Parameters + ---------- + message: str | None | Unset_Type + The message of this GsaDiscreteTypeDeletionException. + """ + self._message = message + + @property + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": + """Gets the code of this GsaDiscreteTypeDeletionException. + + Returns + ------- + SystemNetHttpStatusCode | Unset_Type + The code of this GsaDiscreteTypeDeletionException. + """ + return self._code + + @code.setter + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: + """Sets the code of this GsaDiscreteTypeDeletionException. + + Parameters + ---------- + code: SystemNetHttpStatusCode | Unset_Type + The code of this GsaDiscreteTypeDeletionException. + """ + # Field is not nullable + if code is None: + raise ValueError("Invalid value for 'code', must not be 'None'") + self._code = code + + @property + def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": + """Gets the errors of this GsaDiscreteTypeDeletionException. + + Returns + ------- + list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaDiscreteTypeDeletionException. + """ + return self._errors + + @errors.setter + def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: + """Sets the errors of this GsaDiscreteTypeDeletionException. + + Parameters + ---------- + errors: list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaDiscreteTypeDeletionException. + """ + self._errors = errors @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_detail.py deleted file mode 100644 index 6d80b96e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteTypeErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDiscreteTypeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaDiscreteTypeErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityDiscreteTypeErrorDetail", - "discreteValues".lower(): "#/components/schemas/GsaDiscreteValuesErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaDiscreteTypeErrorReason", - ) -> None: - """GsaDiscreteTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDiscreteTypeErrorReason - """ - self._message: str - self._reason: GsaDiscreteTypeErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaDiscreteTypeErrorDetail. - - Returns - ------- - str - The message of this GsaDiscreteTypeErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaDiscreteTypeErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaDiscreteTypeErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaDiscreteTypeErrorReason": - """Gets the reason of this GsaDiscreteTypeErrorDetail. - - Returns - ------- - GsaDiscreteTypeErrorReason - The reason of this GsaDiscreteTypeErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaDiscreteTypeErrorReason") -> None: - """Sets the reason of this GsaDiscreteTypeErrorDetail. - - Parameters - ---------- - reason: GsaDiscreteTypeErrorReason - The reason of this GsaDiscreteTypeErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_reason.py deleted file mode 100644 index 33daabe6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDiscreteTypeErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - DISCRETEVALUES = "discreteValues" - DISCRETEVALUESUPDATE = "discreteValuesUpdate" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_update_exception.py deleted file mode 100644 index 2820ffee..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteTypeUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaDiscreteTypeErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "discrete_type_guid": "discreteTypeGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDiscreteTypeErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDiscreteTypeErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDiscreteTypeUpdateException - a model defined in Swagger - - Parameters - ---------- - discrete_type_guid: str - code: GsaErrorCode, optional - errors: list[GsaDiscreteTypeErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._discrete_type_guid: str - self._errors: list[GsaDiscreteTypeErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.discrete_type_guid = discrete_type_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDiscreteTypeUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDiscreteTypeUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDiscreteTypeUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDiscreteTypeUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDiscreteTypeUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDiscreteTypeUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDiscreteTypeUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDiscreteTypeUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def discrete_type_guid(self) -> "str": - """Gets the discrete_type_guid of this GsaDiscreteTypeUpdateException. - - Returns - ------- - str - The discrete_type_guid of this GsaDiscreteTypeUpdateException. - """ - return self._discrete_type_guid - - @discrete_type_guid.setter - def discrete_type_guid(self, discrete_type_guid: "str") -> None: - """Sets the discrete_type_guid of this GsaDiscreteTypeUpdateException. - - Parameters - ---------- - discrete_type_guid: str - The discrete_type_guid of this GsaDiscreteTypeUpdateException. - """ - # Field is not nullable - if discrete_type_guid is None: - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'None'") - # Field is required - if discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'Unset'") - self._discrete_type_guid = discrete_type_guid - - @property - def errors(self) -> "list[GsaDiscreteTypeErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDiscreteTypeUpdateException. - - Returns - ------- - list[GsaDiscreteTypeErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteTypeUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDiscreteTypeErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaDiscreteTypeUpdateException. - - Parameters - ---------- - errors: list[GsaDiscreteTypeErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteTypeUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteTypeUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage.py index b3ead318..b4c81fcd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage.py @@ -80,68 +80,76 @@ class GsaDiscreteTypeUsage(ModelBase): def __init__( self, *, - attributes: "list[GsaSlimAttribute] | None | Unset_Type" = Unset, - tabular_columns: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" = Unset, + attributes: "list[GsaSlimAttribute]", + tabular_columns: "list[GsaTabularAttributeWithColumns]", ) -> None: """GsaDiscreteTypeUsage - a model defined in Swagger Parameters ---------- - attributes: list[GsaSlimAttribute] | None, optional - tabular_columns: list[GsaTabularAttributeWithColumns] | None, optional + attributes: list[GsaSlimAttribute] + tabular_columns: list[GsaTabularAttributeWithColumns] """ - self._attributes: list[GsaSlimAttribute] | None | Unset_Type = Unset - self._tabular_columns: list[GsaTabularAttributeWithColumns] | None | Unset_Type = Unset + self._attributes: list[GsaSlimAttribute] + self._tabular_columns: list[GsaTabularAttributeWithColumns] - if attributes is not Unset: - self.attributes = attributes - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns + self.attributes = attributes + self.tabular_columns = tabular_columns @property - def attributes(self) -> "list[GsaSlimAttribute] | None | Unset_Type": + def attributes(self) -> "list[GsaSlimAttribute]": """Gets the attributes of this GsaDiscreteTypeUsage. Returns ------- - list[GsaSlimAttribute] | None | Unset_Type + list[GsaSlimAttribute] The attributes of this GsaDiscreteTypeUsage. """ return self._attributes @attributes.setter - def attributes(self, attributes: "list[GsaSlimAttribute] | None | Unset_Type") -> None: + def attributes(self, attributes: "list[GsaSlimAttribute]") -> None: """Sets the attributes of this GsaDiscreteTypeUsage. Parameters ---------- - attributes: list[GsaSlimAttribute] | None | Unset_Type + attributes: list[GsaSlimAttribute] The attributes of this GsaDiscreteTypeUsage. """ + # Field is not nullable + if attributes is None: + raise ValueError("Invalid value for 'attributes', must not be 'None'") + # Field is required + if attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'attributes', must not be 'Unset'") self._attributes = attributes @property - def tabular_columns(self) -> "list[GsaTabularAttributeWithColumns] | None | Unset_Type": + def tabular_columns(self) -> "list[GsaTabularAttributeWithColumns]": """Gets the tabular_columns of this GsaDiscreteTypeUsage. Returns ------- - list[GsaTabularAttributeWithColumns] | None | Unset_Type + list[GsaTabularAttributeWithColumns] The tabular_columns of this GsaDiscreteTypeUsage. """ return self._tabular_columns @tabular_columns.setter - def tabular_columns( - self, tabular_columns: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" - ) -> None: + def tabular_columns(self, tabular_columns: "list[GsaTabularAttributeWithColumns]") -> None: """Sets the tabular_columns of this GsaDiscreteTypeUsage. Parameters ---------- - tabular_columns: list[GsaTabularAttributeWithColumns] | None | Unset_Type + tabular_columns: list[GsaTabularAttributeWithColumns] The tabular_columns of this GsaDiscreteTypeUsage. """ + # Field is not nullable + if tabular_columns is None: + raise ValueError("Invalid value for 'tabular_columns', must not be 'None'") + # Field is required + if tabular_columns is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'tabular_columns', must not be 'Unset'") self._tabular_columns = tabular_columns @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage_type.py deleted file mode 100644 index 866ef7d7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_type_usage_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDiscreteTypeUsageType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTES = "attributes" - TABULARCOLUMNS = "tabularColumns" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_mode.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_aggregate_error_reason.py similarity index 83% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_mode.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_aggregate_error_reason.py index 198fd7b7..cada9414 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_access_control_mode.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_aggregate_error_reason.py @@ -33,7 +33,7 @@ from enum import Enum -class GsaAccessControlMode(Enum): +class GsaDiscreteValueAggregateErrorReason(Enum): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -42,5 +42,7 @@ class GsaAccessControlMode(Enum): """ Allowed Enum values """ - PERMISSIONBASED = "permissionBased" - ATTRIBUTEBASED = "attributeBased" + DISCRETEVALUEADDITIONERRORS = "discreteValueAdditionErrors" + DISCRETEVALUEDELETIONERRORS = "discreteValueDeletionErrors" + DISCRETEVALUEUPDATEERRORS = "discreteValueUpdateErrors" + DISCRETEVALUEREPLACINGERRORS = "discreteValueReplacingErrors" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_aggregate_exception.py similarity index 60% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_update_exception.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_aggregate_exception.py index 212fcccd..bb8b622c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_update_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_aggregate_exception.py @@ -42,7 +42,7 @@ from . import * -class GsaPermissionCategoryUpdateException(ModelBase): +class GsaDiscreteValueAggregateException(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,22 +61,23 @@ class GsaPermissionCategoryUpdateException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionCategoryErrorDetail]", + "reason": "GsaDiscreteValueAggregateErrorReason", + "code": "SystemNetHttpStatusCode", + "errors": "list[GsaErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "guid": "guid", + "reason": "reason", "code": "code", "errors": "errors", "message": "message", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionCategoryErrorDetail", + "reason": "GsaDiscreteValueAggregateErrorReason", + "code": "SystemNetHttpStatusCode", + "errors": "GsaErrorDetail", } discriminator: Optional[str] = None @@ -84,127 +85,127 @@ class GsaPermissionCategoryUpdateException(ModelBase): def __init__( self, *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type" = Unset, + reason: "GsaDiscreteValueAggregateErrorReason", + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, + errors: "list[GsaErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: - """GsaPermissionCategoryUpdateException - a model defined in Swagger + """GsaDiscreteValueAggregateException - a model defined in Swagger Parameters ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaPermissionCategoryErrorDetail] | None, optional + reason: GsaDiscreteValueAggregateErrorReason + code: SystemNetHttpStatusCode, optional + errors: list[GsaErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type = Unset + self._reason: GsaDiscreteValueAggregateErrorReason + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message + self.reason = reason if code is not Unset: self.code = code - self.guid = guid if errors is not Unset: self.errors = errors @property def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoryUpdateException. + """Gets the message of this GsaDiscreteValueAggregateException. Returns ------- str | None | Unset_Type - The message of this GsaPermissionCategoryUpdateException. + The message of this GsaDiscreteValueAggregateException. """ return self._message @message.setter def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoryUpdateException. + """Sets the message of this GsaDiscreteValueAggregateException. Parameters ---------- message: str | None | Unset_Type - The message of this GsaPermissionCategoryUpdateException. + The message of this GsaDiscreteValueAggregateException. """ self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoryUpdateException. + def reason(self) -> "GsaDiscreteValueAggregateErrorReason": + """Gets the reason of this GsaDiscreteValueAggregateException. Returns ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryUpdateException. + GsaDiscreteValueAggregateErrorReason + The reason of this GsaDiscreteValueAggregateException. """ - return self._code + return self._reason - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoryUpdateException. + @reason.setter + def reason(self, reason: "GsaDiscreteValueAggregateErrorReason") -> None: + """Sets the reason of this GsaDiscreteValueAggregateException. Parameters ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryUpdateException. + reason: GsaDiscreteValueAggregateErrorReason + The reason of this GsaDiscreteValueAggregateException. """ # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code + if reason is None: + raise ValueError("Invalid value for 'reason', must not be 'None'") + # Field is required + if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'reason', must not be 'Unset'") + self._reason = reason @property - def guid(self) -> "str": - """Gets the guid of this GsaPermissionCategoryUpdateException. + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": + """Gets the code of this GsaDiscreteValueAggregateException. Returns ------- - str - The guid of this GsaPermissionCategoryUpdateException. + SystemNetHttpStatusCode | Unset_Type + The code of this GsaDiscreteValueAggregateException. """ - return self._guid + return self._code - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaPermissionCategoryUpdateException. + @code.setter + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: + """Sets the code of this GsaDiscreteValueAggregateException. Parameters ---------- - guid: str - The guid of this GsaPermissionCategoryUpdateException. + code: SystemNetHttpStatusCode | Unset_Type + The code of this GsaDiscreteValueAggregateException. """ # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid + if code is None: + raise ValueError("Invalid value for 'code', must not be 'None'") + self._code = code @property - def errors(self) -> "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoryUpdateException. + def errors(self) -> "list[GsaErrorDetail] | None | Unset_Type": + """Gets the errors of this GsaDiscreteValueAggregateException. Returns ------- - list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryUpdateException. + list[GsaErrorDetail] | None | Unset_Type + The errors of this GsaDiscreteValueAggregateException. """ return self._errors @errors.setter - def errors(self, errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionCategoryUpdateException. + def errors(self, errors: "list[GsaErrorDetail] | None | Unset_Type") -> None: + """Sets the errors of this GsaDiscreteValueAggregateException. Parameters ---------- - errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryUpdateException. + errors: list[GsaErrorDetail] | None | Unset_Type + The errors of this GsaDiscreteValueAggregateException. """ self._errors = errors @@ -230,7 +231,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryUpdateException): + if not isinstance(other, GsaDiscreteValueAggregateException): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_creation_exception.py deleted file mode 100644 index 1f2ab99a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValueCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaDiscreteValueErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDiscreteValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDiscreteValueErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDiscreteValueCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaDiscreteValueErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaDiscreteValueErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDiscreteValueCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDiscreteValueCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDiscreteValueCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDiscreteValueCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDiscreteValueCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDiscreteValueCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDiscreteValueCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDiscreteValueCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaDiscreteValueCreationException. - - Returns - ------- - str - The name of this GsaDiscreteValueCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaDiscreteValueCreationException. - - Parameters - ---------- - name: str - The name of this GsaDiscreteValueCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaDiscreteValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDiscreteValueCreationException. - - Returns - ------- - list[GsaDiscreteValueErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteValueCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDiscreteValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaDiscreteValueCreationException. - - Parameters - ---------- - errors: list[GsaDiscreteValueErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteValueCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValueCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_deletion_exception.py deleted file mode 100644 index e42993fd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_deletion_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValueDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "discrete_value_guid": "str", - "errors": "list[GsaDiscreteValueUsedInDataErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "discrete_value_guid": "discreteValueGuid", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDiscreteValueUsedInDataErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - discrete_value_guid: "str | Unset_Type" = Unset, - errors: "list[GsaDiscreteValueUsedInDataErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDiscreteValueDeletionException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - discrete_value_guid: str, optional - errors: list[GsaDiscreteValueUsedInDataErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._discrete_value_guid: str | Unset_Type = Unset - self._errors: list[GsaDiscreteValueUsedInDataErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if discrete_value_guid is not Unset: - self.discrete_value_guid = discrete_value_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDiscreteValueDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDiscreteValueDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDiscreteValueDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDiscreteValueDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDiscreteValueDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDiscreteValueDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDiscreteValueDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDiscreteValueDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def discrete_value_guid(self) -> "str | Unset_Type": - """Gets the discrete_value_guid of this GsaDiscreteValueDeletionException. - - Returns - ------- - str | Unset_Type - The discrete_value_guid of this GsaDiscreteValueDeletionException. - """ - return self._discrete_value_guid - - @discrete_value_guid.setter - def discrete_value_guid(self, discrete_value_guid: "str | Unset_Type") -> None: - """Sets the discrete_value_guid of this GsaDiscreteValueDeletionException. - - Parameters - ---------- - discrete_value_guid: str | Unset_Type - The discrete_value_guid of this GsaDiscreteValueDeletionException. - """ - # Field is not nullable - if discrete_value_guid is None: - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'None'") - self._discrete_value_guid = discrete_value_guid - - @property - def errors(self) -> "list[GsaDiscreteValueUsedInDataErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDiscreteValueDeletionException. - - Returns - ------- - list[GsaDiscreteValueUsedInDataErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteValueDeletionException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaDiscreteValueUsedInDataErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaDiscreteValueDeletionException. - - Parameters - ---------- - errors: list[GsaDiscreteValueUsedInDataErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteValueDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValueDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_detail.py deleted file mode 100644 index 772d738a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValueErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDiscreteValueErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaDiscreteValueErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityDiscreteValueErrorDetail", - "noSuchDiscreteValuesInDiscreteValues".lower(): "#/components/schemas/GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail", - "discreteValueUsedInData".lower(): "#/components/schemas/GsaDiscreteValueUsedInDataErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaDiscreteValueErrorReason", - ) -> None: - """GsaDiscreteValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDiscreteValueErrorReason - """ - self._message: str - self._reason: GsaDiscreteValueErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaDiscreteValueErrorDetail. - - Returns - ------- - str - The message of this GsaDiscreteValueErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaDiscreteValueErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaDiscreteValueErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaDiscreteValueErrorReason": - """Gets the reason of this GsaDiscreteValueErrorDetail. - - Returns - ------- - GsaDiscreteValueErrorReason - The reason of this GsaDiscreteValueErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaDiscreteValueErrorReason") -> None: - """Sets the reason of this GsaDiscreteValueErrorDetail. - - Parameters - ---------- - reason: GsaDiscreteValueErrorReason - The reason of this GsaDiscreteValueErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_reason.py deleted file mode 100644 index d8385fce..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDiscreteValueErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - NOSUCHDISCRETEVALUESINDISCRETEVALUES = "noSuchDiscreteValuesInDiscreteValues" - DISCRETEVALUEUSEDINDATA = "discreteValueUsedInData" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_not_in_discrete_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_not_in_discrete_type_error_detail.py deleted file mode 100644 index 09eba839..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_not_in_discrete_type_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValueNotInDiscreteTypeErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type_guid": "str", - "discrete_value_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "discrete_type_guid": "discreteTypeGuid", - "discrete_value_guid": "discreteValueGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type_guid: "str", - discrete_value_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.DISCRETEVALUENOTINDISCRETETYPE, - ) -> None: - """GsaDiscreteValueNotInDiscreteTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - discrete_type_guid: str - discrete_value_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._discrete_value_guid: str - self._discrete_type_guid: str - - self.discrete_value_guid = discrete_value_guid - self.discrete_type_guid = discrete_type_guid - - @property - def discrete_value_guid(self) -> "str": - """Gets the discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Returns - ------- - str - The discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - return self._discrete_value_guid - - @discrete_value_guid.setter - def discrete_value_guid(self, discrete_value_guid: "str") -> None: - """Sets the discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Parameters - ---------- - discrete_value_guid: str - The discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - # Field is not nullable - if discrete_value_guid is None: - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'None'") - # Field is required - if discrete_value_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'Unset'") - self._discrete_value_guid = discrete_value_guid - - @property - def discrete_type_guid(self) -> "str": - """Gets the discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Returns - ------- - str - The discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - return self._discrete_type_guid - - @discrete_type_guid.setter - def discrete_type_guid(self, discrete_type_guid: "str") -> None: - """Sets the discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Parameters - ---------- - discrete_type_guid: str - The discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - # Field is not nullable - if discrete_type_guid is None: - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'None'") - # Field is required - if discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'Unset'") - self._discrete_type_guid = discrete_type_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValueNotInDiscreteTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_update_exception.py deleted file mode 100644 index 803e65dd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValueUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_value_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaDiscreteValueErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "discrete_value_guid": "discreteValueGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDiscreteValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_value_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDiscreteValueErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDiscreteValueUpdateException - a model defined in Swagger - - Parameters - ---------- - discrete_value_guid: str - code: GsaErrorCode, optional - errors: list[GsaDiscreteValueErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._discrete_value_guid: str - self._errors: list[GsaDiscreteValueErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.discrete_value_guid = discrete_value_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDiscreteValueUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDiscreteValueUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDiscreteValueUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDiscreteValueUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDiscreteValueUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDiscreteValueUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDiscreteValueUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDiscreteValueUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def discrete_value_guid(self) -> "str": - """Gets the discrete_value_guid of this GsaDiscreteValueUpdateException. - - Returns - ------- - str - The discrete_value_guid of this GsaDiscreteValueUpdateException. - """ - return self._discrete_value_guid - - @discrete_value_guid.setter - def discrete_value_guid(self, discrete_value_guid: "str") -> None: - """Sets the discrete_value_guid of this GsaDiscreteValueUpdateException. - - Parameters - ---------- - discrete_value_guid: str - The discrete_value_guid of this GsaDiscreteValueUpdateException. - """ - # Field is not nullable - if discrete_value_guid is None: - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'None'") - # Field is required - if discrete_value_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'Unset'") - self._discrete_value_guid = discrete_value_guid - - @property - def errors(self) -> "list[GsaDiscreteValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDiscreteValueUpdateException. - - Returns - ------- - list[GsaDiscreteValueErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteValueUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDiscreteValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaDiscreteValueUpdateException. - - Parameters - ---------- - errors: list[GsaDiscreteValueErrorDetail] | None | Unset_Type - The errors of this GsaDiscreteValueUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValueUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_used_in_data_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_used_in_data_error_detail.py deleted file mode 100644 index f40e7460..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_value_used_in_data_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_value_error_detail import ( # noqa: F401 - GsaDiscreteValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_value_error_reason import ( - GsaDiscreteValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValueUsedInDataErrorDetail(GsaDiscreteValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_value_in_use": "GsaSlimNamedEntity", - "message": "str", - "reason": "GsaDiscreteValueErrorReason", - } - - attribute_map: dict[str, str] = { - "discrete_value_in_use": "discreteValueInUse", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "discreteValueInUse": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_value_in_use: "GsaSlimNamedEntity", - message: "str", - reason: "GsaDiscreteValueErrorReason" = GsaDiscreteValueErrorReason.DISCRETEVALUEUSEDINDATA, - ) -> None: - """GsaDiscreteValueUsedInDataErrorDetail - a model defined in Swagger - - Parameters - ---------- - discrete_value_in_use: GsaSlimNamedEntity - message: str - reason: GsaDiscreteValueErrorReason - """ - super().__init__(message=message, reason=reason) - self._discrete_value_in_use: GsaSlimNamedEntity - - self.discrete_value_in_use = discrete_value_in_use - - @property - def discrete_value_in_use(self) -> "GsaSlimNamedEntity": - """Gets the discrete_value_in_use of this GsaDiscreteValueUsedInDataErrorDetail. - - Returns - ------- - GsaSlimNamedEntity - The discrete_value_in_use of this GsaDiscreteValueUsedInDataErrorDetail. - """ - return self._discrete_value_in_use - - @discrete_value_in_use.setter - def discrete_value_in_use(self, discrete_value_in_use: "GsaSlimNamedEntity") -> None: - """Sets the discrete_value_in_use of this GsaDiscreteValueUsedInDataErrorDetail. - - Parameters - ---------- - discrete_value_in_use: GsaSlimNamedEntity - The discrete_value_in_use of this GsaDiscreteValueUsedInDataErrorDetail. - """ - # Field is not nullable - if discrete_value_in_use is None: - raise ValueError("Invalid value for 'discrete_value_in_use', must not be 'None'") - # Field is required - if discrete_value_in_use is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_value_in_use', must not be 'Unset'") - self._discrete_value_in_use = discrete_value_in_use - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValueUsedInDataErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_discrete_value.py index 5fa30de6..c6456282 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_discrete_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_discrete_value.py @@ -62,13 +62,11 @@ class GsaDiscreteValuesDiscreteValue(ModelBase): """ swagger_types: dict[str, str] = { "guid": "str", - "is_protected": "bool", "name": "str", } attribute_map: dict[str, str] = { "guid": "guid", - "is_protected": "isProtected", "name": "name", } @@ -80,7 +78,6 @@ def __init__( self, *, guid: "str", - is_protected: "bool", name: "str", ) -> None: """GsaDiscreteValuesDiscreteValue - a model defined in Swagger @@ -88,47 +85,14 @@ def __init__( Parameters ---------- guid: str - is_protected: bool name: str """ - self._is_protected: bool self._name: str self._guid: str - self.is_protected = is_protected self.name = name self.guid = guid - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaDiscreteValuesDiscreteValue. - If true, the discrete value is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaDiscreteValuesDiscreteValue. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaDiscreteValuesDiscreteValue. - If true, the discrete value is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaDiscreteValuesDiscreteValue. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def name(self) -> "str": """Gets the name of this GsaDiscreteValuesDiscreteValue. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_error_detail.py deleted file mode 100644 index 14a4b4a6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_type_error_detail import ( # noqa: F401 - GsaDiscreteTypeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_type_error_reason import ( - GsaDiscreteTypeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValuesErrorDetail(GsaDiscreteTypeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaDiscreteValueErrorDetail]", - "message": "str", - "reason": "GsaDiscreteTypeErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaDiscreteValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaDiscreteValueErrorDetail]", - message: "str", - reason: "GsaDiscreteTypeErrorReason" = GsaDiscreteTypeErrorReason.DISCRETEVALUES, - ) -> None: - """GsaDiscreteValuesErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaDiscreteValueErrorDetail] - message: str - reason: GsaDiscreteTypeErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaDiscreteValueErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaDiscreteValueErrorDetail]": - """Gets the errors of this GsaDiscreteValuesErrorDetail. - - Returns - ------- - list[GsaDiscreteValueErrorDetail] - The errors of this GsaDiscreteValuesErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDiscreteValueErrorDetail]") -> None: - """Sets the errors of this GsaDiscreteValuesErrorDetail. - - Parameters - ---------- - errors: list[GsaDiscreteValueErrorDetail] - The errors of this GsaDiscreteValuesErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValuesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_replace_discrete_values_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_replace_discrete_values_info.py index 39497444..478caa8e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_replace_discrete_values_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_values_replace_discrete_values_info.py @@ -61,7 +61,7 @@ class GsaDiscreteValuesReplaceDiscreteValuesInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "discrete_values": "list[GsaPutDiscreteValue]", + "discrete_values": "list[GsaDiscreteValuesCreateDiscreteValue]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaDiscreteValuesReplaceDiscreteValuesInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "discreteValues": "GsaPutDiscreteValue", + "discreteValues": "GsaDiscreteValuesCreateDiscreteValue", } discriminator: Optional[str] = None @@ -77,39 +77,41 @@ class GsaDiscreteValuesReplaceDiscreteValuesInfo(ModelBase): def __init__( self, *, - discrete_values: "list[GsaPutDiscreteValue] | None | Unset_Type" = Unset, + discrete_values: "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type" = Unset, ) -> None: """GsaDiscreteValuesReplaceDiscreteValuesInfo - a model defined in Swagger Parameters ---------- - discrete_values: list[GsaPutDiscreteValue] | None, optional + discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None, optional """ - self._discrete_values: list[GsaPutDiscreteValue] | None | Unset_Type = Unset + self._discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type = ( + Unset + ) if discrete_values is not Unset: self.discrete_values = discrete_values @property - def discrete_values(self) -> "list[GsaPutDiscreteValue] | None | Unset_Type": + def discrete_values(self) -> "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type": """Gets the discrete_values of this GsaDiscreteValuesReplaceDiscreteValuesInfo. Returns ------- - list[GsaPutDiscreteValue] | None | Unset_Type + list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type The discrete_values of this GsaDiscreteValuesReplaceDiscreteValuesInfo. """ return self._discrete_values @discrete_values.setter def discrete_values( - self, discrete_values: "list[GsaPutDiscreteValue] | None | Unset_Type" + self, discrete_values: "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type" ) -> None: """Sets the discrete_values of this GsaDiscreteValuesReplaceDiscreteValuesInfo. Parameters ---------- - discrete_values: list[GsaPutDiscreteValue] | None | Unset_Type + discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type The discrete_values of this GsaDiscreteValuesReplaceDiscreteValuesInfo. """ self._discrete_values = discrete_values diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_empty_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_empty_error_detail.py deleted file mode 100644 index 0b5d6f38..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_empty_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNameEmptyErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "language": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "language": "language", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.DISPLAYNAMEEMPTY, - language: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNameEmptyErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - language: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._language: str | None | Unset_Type = Unset - - if language is not Unset: - self.language = language - - @property - def language(self) -> "str | None | Unset_Type": - """Gets the language of this GsaDisplayNameEmptyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The language of this GsaDisplayNameEmptyErrorDetail. - """ - return self._language - - @language.setter - def language(self, language: "str | None | Unset_Type") -> None: - """Sets the language of this GsaDisplayNameEmptyErrorDetail. - - Parameters - ---------- - language: str | None | Unset_Type - The language of this GsaDisplayNameEmptyErrorDetail. - """ - self._language = language - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNameEmptyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_provided_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_provided_error_detail.py deleted file mode 100644 index b5db2277..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_provided_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNameLanguageNotProvidedErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "display_name": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "display_name": "displayName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.DISPLAYNAMELANGUAGENOTPROVIDED, - display_name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNameLanguageNotProvidedErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - display_name: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._display_name: str | None | Unset_Type = Unset - - if display_name is not Unset: - self.display_name = display_name - - @property - def display_name(self) -> "str | None | Unset_Type": - """Gets the display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - - Returns - ------- - str | None | Unset_Type - The display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name: "str | None | Unset_Type") -> None: - """Sets the display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - - Parameters - ---------- - display_name: str | None | Unset_Type - The display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - """ - self._display_name = display_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNameLanguageNotProvidedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_supported_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_supported_error_detail.py deleted file mode 100644 index c88be337..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_name_language_not_supported_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNameLanguageNotSupportedErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "language": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "language": "language", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.DISPLAYNAMELANGUAGENOTSUPPORTED, - language: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNameLanguageNotSupportedErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - language: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._language: str | None | Unset_Type = Unset - - if language is not Unset: - self.language = language - - @property - def language(self) -> "str | None | Unset_Type": - """Gets the language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - - Returns - ------- - str | None | Unset_Type - The language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - """ - return self._language - - @language.setter - def language(self, language: "str | None | Unset_Type") -> None: - """Sets the language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - - Parameters - ---------- - language: str | None | Unset_Type - The language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - """ - self._language = language - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNameLanguageNotSupportedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_detail.py deleted file mode 100644 index d8812cdb..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_detail.py +++ /dev/null @@ -1,299 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNamesImportErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDisplayNamesImportErrorReason", - "column_header": "str", - "field_value": "str", - "item_type": "str", - "row_index": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "column_header": "columnHeader", - "field_value": "fieldValue", - "item_type": "itemType", - "row_index": "rowIndex", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaDisplayNamesImportErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDisplayNamesImportErrorReason", - column_header: "str | None | Unset_Type" = Unset, - field_value: "str | None | Unset_Type" = Unset, - item_type: "str | None | Unset_Type" = Unset, - row_index: "int | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNamesImportErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDisplayNamesImportErrorReason - column_header: str | None, optional - field_value: str | None, optional - item_type: str | None, optional - row_index: int | None, optional - """ - self._message: str - self._reason: GsaDisplayNamesImportErrorReason - self._row_index: int | None | Unset_Type = Unset - self._field_value: str | None | Unset_Type = Unset - self._column_header: str | None | Unset_Type = Unset - self._item_type: str | None | Unset_Type = Unset - - self.message = message - self.reason = reason - if row_index is not Unset: - self.row_index = row_index - if field_value is not Unset: - self.field_value = field_value - if column_header is not Unset: - self.column_header = column_header - if item_type is not Unset: - self.item_type = item_type - - @property - def message(self) -> "str": - """Gets the message of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str - The message of this GsaDisplayNamesImportErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaDisplayNamesImportErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaDisplayNamesImportErrorReason": - """Gets the reason of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - GsaDisplayNamesImportErrorReason - The reason of this GsaDisplayNamesImportErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaDisplayNamesImportErrorReason") -> None: - """Sets the reason of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - reason: GsaDisplayNamesImportErrorReason - The reason of this GsaDisplayNamesImportErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @property - def row_index(self) -> "int | None | Unset_Type": - """Gets the row_index of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - int | None | Unset_Type - The row_index of this GsaDisplayNamesImportErrorDetail. - """ - return self._row_index - - @row_index.setter - def row_index(self, row_index: "int | None | Unset_Type") -> None: - """Sets the row_index of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - row_index: int | None | Unset_Type - The row_index of this GsaDisplayNamesImportErrorDetail. - """ - self._row_index = row_index - - @property - def field_value(self) -> "str | None | Unset_Type": - """Gets the field_value of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str | None | Unset_Type - The field_value of this GsaDisplayNamesImportErrorDetail. - """ - return self._field_value - - @field_value.setter - def field_value(self, field_value: "str | None | Unset_Type") -> None: - """Sets the field_value of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - field_value: str | None | Unset_Type - The field_value of this GsaDisplayNamesImportErrorDetail. - """ - self._field_value = field_value - - @property - def column_header(self) -> "str | None | Unset_Type": - """Gets the column_header of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str | None | Unset_Type - The column_header of this GsaDisplayNamesImportErrorDetail. - """ - return self._column_header - - @column_header.setter - def column_header(self, column_header: "str | None | Unset_Type") -> None: - """Sets the column_header of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - column_header: str | None | Unset_Type - The column_header of this GsaDisplayNamesImportErrorDetail. - """ - self._column_header = column_header - - @property - def item_type(self) -> "str | None | Unset_Type": - """Gets the item_type of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str | None | Unset_Type - The item_type of this GsaDisplayNamesImportErrorDetail. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "str | None | Unset_Type") -> None: - """Sets the item_type of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - item_type: str | None | Unset_Type - The item_type of this GsaDisplayNamesImportErrorDetail. - """ - self._item_type = item_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNamesImportErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_reason.py deleted file mode 100644 index 974ae3b7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_error_reason.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDisplayNamesImportErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNKNOWN = "unknown" - MALFORMEDLINE = "malformedLine" - INCORRECTNUMBEROFCOLUMNS = "incorrectNumberOfColumns" - INVALIDSCHEMATYPE = "invalidSchemaType" - INVALIDLANGUAGE = "invalidLanguage" - SCHEMAITEMNOTFOUND = "schemaItemNotFound" - EMPTYCOLUMN = "emptyColumn" - EXTRAINFOMISSING = "extraInfoMissing" - TRANSLATIONTOOLONG = "translationTooLong" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_exception.py deleted file mode 100644 index 020ae95c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_import_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNamesImportException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaDisplayNamesImportErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDisplayNamesImportErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNamesImportException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaDisplayNamesImportErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDisplayNamesImportException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDisplayNamesImportException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDisplayNamesImportException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDisplayNamesImportException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDisplayNamesImportException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDisplayNamesImportException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDisplayNamesImportException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDisplayNamesImportException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDisplayNamesImportException. - - Returns - ------- - list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type - The errors of this GsaDisplayNamesImportException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaDisplayNamesImportException. - - Parameters - ---------- - errors: list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type - The errors of this GsaDisplayNamesImportException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNamesImportException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_info.py deleted file mode 100644 index ae390d62..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_display_names_info.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNamesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "GsaGrid", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - } - - subtype_mapping: dict[str, str] = { - "displayNames": "GsaGrid", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "GsaGrid | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNamesInfo - a model defined in Swagger - - Parameters - ---------- - display_names: GsaGrid, optional - """ - self._display_names: GsaGrid | Unset_Type = Unset - - if display_names is not Unset: - self.display_names = display_names - - @property - def display_names(self) -> "GsaGrid | Unset_Type": - """Gets the display_names of this GsaDisplayNamesInfo. - - Returns - ------- - GsaGrid | Unset_Type - The display_names of this GsaDisplayNamesInfo. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "GsaGrid | Unset_Type") -> None: - """Sets the display_names of this GsaDisplayNamesInfo. - - Parameters - ---------- - display_names: GsaGrid | Unset_Type - The display_names of this GsaDisplayNamesInfo. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - self._display_names = display_names - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNamesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_divide_by_zero_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_divide_by_zero_unit_equation_error_detail.py deleted file mode 100644 index 27769dd2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_divide_by_zero_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDivideByZeroUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.DIVIDEBYZERO, - ) -> None: - """GsaDivideByZeroUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDivideByZeroUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_categories_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_categories_replace_permission_category_error_detail.py deleted file mode 100644 index 63c30042..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_categories_replace_permission_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail( - GsaReplacePermissionCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "duplicate_guids": "list[str]", - "duplicate_names": "list[str]", - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "duplicate_guids": "duplicateGuids", - "duplicate_names": "duplicateNames", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - duplicate_guids: "list[str]", - duplicate_names: "list[str]", - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.DUPLICATECATEGORIES, - ) -> None: - """GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - duplicate_guids: list[str] - duplicate_names: list[str] - message: str - reason: GsaReplacePermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._duplicate_names: list[str] - self._duplicate_guids: list[str] - - self.duplicate_names = duplicate_names - self.duplicate_guids = duplicate_guids - - @property - def duplicate_names(self) -> "list[str]": - """Gets the duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - return self._duplicate_names - - @duplicate_names.setter - def duplicate_names(self, duplicate_names: "list[str]") -> None: - """Sets the duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_names: list[str] - The duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_names is None: - raise ValueError("Invalid value for 'duplicate_names', must not be 'None'") - # Field is required - if duplicate_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_names', must not be 'Unset'") - self._duplicate_names = duplicate_names - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_category_guids_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_category_guids_access_control_error_detail.py deleted file mode 100644 index e3f0d6b0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_category_guids_access_control_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateCategoryGuidsAccessControlErrorDetail( - GsaPermissionCategoriesAccessControlErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "duplicate_guids": "list[str]", - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "duplicate_guids": "duplicateGuids", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - duplicate_guids: "list[str]", - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.DUPLICATECATEGORYGUIDS, - ) -> None: - """GsaDuplicateCategoryGuidsAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - duplicate_guids: list[str] - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._duplicate_guids: list[str] - - self.duplicate_guids = duplicate_guids - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateCategoryGuidsAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_code_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_code_currency_error_detail.py deleted file mode 100644 index 6f41c146..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_code_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateCodeCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "currency_code": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "currency_code": "currencyCode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.DUPLICATECODE, - currency_code: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDuplicateCodeCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - currency_code: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._currency_code: str | None | Unset_Type = Unset - - if currency_code is not Unset: - self.currency_code = currency_code - - @property - def currency_code(self) -> "str | None | Unset_Type": - """Gets the currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - """ - return self._currency_code - - @currency_code.setter - def currency_code(self, currency_code: "str | None | Unset_Type") -> None: - """Sets the currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - - Parameters - ---------- - currency_code: str | None | Unset_Type - The currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - """ - self._currency_code = currency_code - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateCodeCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_discrete_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_discrete_value_error_detail.py deleted file mode 100644 index d0b8a25e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_discrete_value_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateDiscreteValueErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_value_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "discrete_value_guid": "discreteValueGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_value_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.DUPLICATEDISCRETEVALUE, - ) -> None: - """GsaDuplicateDiscreteValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - discrete_value_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._discrete_value_guid: str - - self.discrete_value_guid = discrete_value_guid - - @property - def discrete_value_guid(self) -> "str": - """Gets the discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - - Returns - ------- - str - The discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - """ - return self._discrete_value_guid - - @discrete_value_guid.setter - def discrete_value_guid(self, discrete_value_guid: "str") -> None: - """Sets the discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - - Parameters - ---------- - discrete_value_guid: str - The discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - """ - # Field is not nullable - if discrete_value_guid is None: - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'None'") - # Field is required - if discrete_value_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'Unset'") - self._discrete_value_guid = discrete_value_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateDiscreteValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_attribute_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_attribute_guids_error_detail.py deleted file mode 100644 index d01f2af9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_attribute_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedAttributeGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDATTRIBUTEGUIDS, - ) -> None: - """GsaDuplicateMappedAttributeGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedAttributeGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail.py deleted file mode 100644 index 3c2b1bf0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDCROSSDATABASERECORDLINKGROUPGUIDS, - ) -> None: - """GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_parameter_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_parameter_guids_error_detail.py deleted file mode 100644 index f0ca74b7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_parameter_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedParameterGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDPARAMETERGUIDS, - ) -> None: - """GsaDuplicateMappedParameterGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedParameterGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_record_link_group_guids_error_detail.py deleted file mode 100644 index 2f1e27b3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_mapped_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDRECORDLINKGROUPGUIDS, - ) -> None: - """GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_name_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_name_currency_error_detail.py deleted file mode 100644 index 21a58d06..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_name_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateNameCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.DUPLICATENAME, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDuplicateNameCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaDuplicateNameCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaDuplicateNameCurrencyErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaDuplicateNameCurrencyErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaDuplicateNameCurrencyErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateNameCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permission_guids_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permission_guids_access_control_error_detail.py deleted file mode 100644 index 1b18343e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permission_guids_access_control_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicatePermissionGuidsAccessControlErrorDetail( - GsaPermissionCategoriesAccessControlErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "duplicate_guids": "list[str]", - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "duplicate_guids": "duplicateGuids", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - duplicate_guids: "list[str]", - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.DUPLICATEPERMISSIONGUIDS, - ) -> None: - """GsaDuplicatePermissionGuidsAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - category_guid: str - duplicate_guids: list[str] - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._category_guid: str - self._duplicate_guids: list[str] - - self.category_guid = category_guid - self.duplicate_guids = duplicate_guids - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Returns - ------- - str - The category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicatePermissionGuidsAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permissions_permission_category_error_detail.py deleted file mode 100644 index dfb68385..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicatePermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "duplicate_guids": "list[str]", - "duplicate_names": "list[str]", - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "duplicate_guids": "duplicateGuids", - "duplicate_names": "duplicateNames", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - duplicate_guids: "list[str]", - duplicate_names: "list[str]", - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.DUPLICATEPERMISSIONS, - ) -> None: - """GsaDuplicatePermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - duplicate_guids: list[str] - duplicate_names: list[str] - message: str - reason: GsaPermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._duplicate_names: list[str] - self._duplicate_guids: list[str] - - self.duplicate_names = duplicate_names - self.duplicate_guids = duplicate_guids - - @property - def duplicate_names(self) -> "list[str]": - """Gets the duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - return self._duplicate_names - - @duplicate_names.setter - def duplicate_names(self, duplicate_names: "list[str]") -> None: - """Sets the duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_names: list[str] - The duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_names is None: - raise ValueError("Invalid value for 'duplicate_names', must not be 'None'") - # Field is required - if duplicate_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_names', must not be 'Unset'") - self._duplicate_names = duplicate_names - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicatePermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_symbol_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_symbol_unit_error_detail.py deleted file mode 100644 index 81393b1e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_symbol_unit_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateSymbolUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "symbol": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "symbol": "symbol", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.DUPLICATESYMBOL, - symbol: "str", - ) -> None: - """GsaDuplicateSymbolUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - symbol: str - """ - super().__init__(message=message, reason=reason) - self._symbol: str - - self.symbol = symbol - - @property - def symbol(self) -> "str": - """Gets the symbol of this GsaDuplicateSymbolUnitErrorDetail. - - Returns - ------- - str - The symbol of this GsaDuplicateSymbolUnitErrorDetail. - """ - return self._symbol - - @symbol.setter - def symbol(self, symbol: "str") -> None: - """Sets the symbol of this GsaDuplicateSymbolUnitErrorDetail. - - Parameters - ---------- - symbol: str - The symbol of this GsaDuplicateSymbolUnitErrorDetail. - """ - # Field is not nullable - if symbol is None: - raise ValueError("Invalid value for 'symbol', must not be 'None'") - # Field is required - if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'symbol', must not be 'Unset'") - self._symbol = symbol - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateSymbolUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_table_error_detail.py deleted file mode 100644 index 58c83aac..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_table_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateTableErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.DUPLICATETABLE, - table_guid: "str", - ) -> None: - """GsaDuplicateTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._table_guid: str - - self.table_guid = table_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaDuplicateTableErrorDetail. - - Returns - ------- - str - The table_guid of this GsaDuplicateTableErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaDuplicateTableErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaDuplicateTableErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_tables_reorder_tables_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_tables_reorder_tables_error_detail.py deleted file mode 100644 index 78f9f40a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_duplicate_tables_reorder_tables_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_reorder_tables_error_detail import ( # noqa: F401 - GsaReorderTablesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_reorder_tables_error_reason import ( - GsaReorderTablesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateTablesReorderTablesErrorDetail(GsaReorderTablesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "duplicate_guids": "list[str]", - "message": "str", - "reason": "GsaReorderTablesErrorReason", - } - - attribute_map: dict[str, str] = { - "duplicate_guids": "duplicateGuids", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - duplicate_guids: "list[str]", - message: "str", - reason: "GsaReorderTablesErrorReason" = GsaReorderTablesErrorReason.DUPLICATETABLES, - ) -> None: - """GsaDuplicateTablesReorderTablesErrorDetail - a model defined in Swagger - - Parameters - ---------- - duplicate_guids: list[str] - message: str - reason: GsaReorderTablesErrorReason - """ - super().__init__(message=message, reason=reason) - self._duplicate_guids: list[str] - - self.duplicate_guids = duplicate_guids - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicateTablesReorderTablesErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicateTablesReorderTablesErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicateTablesReorderTablesErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicateTablesReorderTablesErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateTablesReorderTablesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_dynamic_link_group_usage_data_modification_error_detail.py similarity index 88% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_usage_data_modification_error_detail.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_dynamic_link_group_usage_data_modification_error_detail.py index 0e4a7e62..e8c2a31b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_usage_data_modification_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_dynamic_link_group_usage_data_modification_error_detail.py @@ -52,7 +52,7 @@ from . import * -class GsaParameterUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): +class GsaDynamicLinkGroupUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -95,10 +95,10 @@ def __init__( *, message: "str", reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.PARAMETER, + referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.DYNAMICLINKGROUP, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ) -> None: - """GsaParameterUsageDataModificationErrorDetail - a model defined in Swagger + """GsaDynamicLinkGroupUsageDataModificationErrorDetail - a model defined in Swagger Parameters ---------- @@ -115,23 +115,23 @@ def __init__( @property def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaParameterUsageDataModificationErrorDetail. + """Gets the referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. Returns ------- list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaParameterUsageDataModificationErrorDetail. + The referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. """ return self._referenced_by @referenced_by.setter def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaParameterUsageDataModificationErrorDetail. + """Sets the referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. Parameters ---------- referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaParameterUsageDataModificationErrorDetail. + The referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. """ self._referenced_by = referenced_by @@ -157,7 +157,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterUsageDataModificationErrorDetail): + if not isinstance(other, GsaDynamicLinkGroupUsageDataModificationErrorDetail): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_dynamic_record_link_group.py similarity index 89% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_record_link_group.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_dynamic_record_link_group.py index ba3934b7..6cadba35 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_dynamic_record_link_group.py @@ -49,7 +49,7 @@ from . import * -class GsaSmartRecordLinkGroup(GsaRecordLinkGroup): +class GsaDynamicRecordLinkGroup(GsaRecordLinkGroup): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -113,11 +113,11 @@ def __init__( name: "str", referential_integrity_model: "GsaReferentialIntegrityModel", reverse_name: "str", - type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, + type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.DYNAMIC, identity: "int | None | Unset_Type" = Unset, reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, ) -> None: - """GsaSmartRecordLinkGroup - a model defined in Swagger + """GsaDynamicRecordLinkGroup - a model defined in Swagger Parameters ---------- @@ -153,23 +153,23 @@ def __init__( @property def forbid_orphans(self) -> "bool": - """Gets the forbid_orphans of this GsaSmartRecordLinkGroup. + """Gets the forbid_orphans of this GsaDynamicRecordLinkGroup. Returns ------- bool - The forbid_orphans of this GsaSmartRecordLinkGroup. + The forbid_orphans of this GsaDynamicRecordLinkGroup. """ return self._forbid_orphans @forbid_orphans.setter def forbid_orphans(self, forbid_orphans: "bool") -> None: - """Sets the forbid_orphans of this GsaSmartRecordLinkGroup. + """Sets the forbid_orphans of this GsaDynamicRecordLinkGroup. Parameters ---------- forbid_orphans: bool - The forbid_orphans of this GsaSmartRecordLinkGroup. + The forbid_orphans of this GsaDynamicRecordLinkGroup. """ # Field is not nullable if forbid_orphans is None: @@ -181,12 +181,12 @@ def forbid_orphans(self, forbid_orphans: "bool") -> None: @property def referential_integrity_model(self) -> "GsaReferentialIntegrityModel": - """Gets the referential_integrity_model of this GsaSmartRecordLinkGroup. + """Gets the referential_integrity_model of this GsaDynamicRecordLinkGroup. Returns ------- GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartRecordLinkGroup. + The referential_integrity_model of this GsaDynamicRecordLinkGroup. """ return self._referential_integrity_model @@ -194,12 +194,12 @@ def referential_integrity_model(self) -> "GsaReferentialIntegrityModel": def referential_integrity_model( self, referential_integrity_model: "GsaReferentialIntegrityModel" ) -> None: - """Sets the referential_integrity_model of this GsaSmartRecordLinkGroup. + """Sets the referential_integrity_model of this GsaDynamicRecordLinkGroup. Parameters ---------- referential_integrity_model: GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartRecordLinkGroup. + The referential_integrity_model of this GsaDynamicRecordLinkGroup. """ # Field is not nullable if referential_integrity_model is None: @@ -211,23 +211,23 @@ def referential_integrity_model( @property def attribute_pairs(self) -> "list[GsaAttributeLinkPair]": - """Gets the attribute_pairs of this GsaSmartRecordLinkGroup. + """Gets the attribute_pairs of this GsaDynamicRecordLinkGroup. Returns ------- list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartRecordLinkGroup. + The attribute_pairs of this GsaDynamicRecordLinkGroup. """ return self._attribute_pairs @attribute_pairs.setter def attribute_pairs(self, attribute_pairs: "list[GsaAttributeLinkPair]") -> None: - """Sets the attribute_pairs of this GsaSmartRecordLinkGroup. + """Sets the attribute_pairs of this GsaDynamicRecordLinkGroup. Parameters ---------- attribute_pairs: list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartRecordLinkGroup. + The attribute_pairs of this GsaDynamicRecordLinkGroup. """ # Field is not nullable if attribute_pairs is None: @@ -259,7 +259,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartRecordLinkGroup): + if not isinstance(other, GsaDynamicRecordLinkGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_symbol_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_symbol_unit_error_detail.py deleted file mode 100644 index d19108b1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_symbol_unit_error_detail.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaEmptySymbolUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.EMPTYSYMBOL, - ) -> None: - """GsaEmptySymbolUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaEmptySymbolUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_table_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_table_type_error_detail.py deleted file mode 100644 index f21dd9b6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_empty_table_type_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_type_error_detail import ( # noqa: F401 - GsaTableTypeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_type_error_reason import ( - GsaTableTypeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaEmptyTableTypeErrorDetail(GsaTableTypeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableTypeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableTypeErrorReason" = GsaTableTypeErrorReason.EMPTYTABLETYPE, - ) -> None: - """GsaEmptyTableTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableTypeErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaEmptyTableTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_enabled_licenses_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_enabled_licenses_info.py index 338901c2..f275bfb1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_enabled_licenses_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_enabled_licenses_info.py @@ -61,6 +61,7 @@ class GsaEnabledLicensesInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { + "is_flex_licensing_enabled": "bool", "mi_server_enabled": "bool", "ml_enabled": "bool", "plm_sync_enabled": "bool", @@ -71,6 +72,7 @@ class GsaEnabledLicensesInfo(ModelBase): } attribute_map: dict[str, str] = { + "is_flex_licensing_enabled": "isFlexLicensingEnabled", "mi_server_enabled": "miServerEnabled", "ml_enabled": "MLEnabled", "plm_sync_enabled": "PLMSyncEnabled", @@ -87,6 +89,7 @@ class GsaEnabledLicensesInfo(ModelBase): def __init__( self, *, + is_flex_licensing_enabled: "bool", mi_server_enabled: "bool", ml_enabled: "bool", plm_sync_enabled: "bool", @@ -99,6 +102,7 @@ def __init__( Parameters ---------- + is_flex_licensing_enabled: bool mi_server_enabled: bool ml_enabled: bool plm_sync_enabled: bool @@ -107,6 +111,7 @@ def __init__( workflow_advanced_enabled: bool expiry_date: datetime | None, optional """ + self._is_flex_licensing_enabled: bool self._mi_server_enabled: bool self._workflow_advanced_enabled: bool self._restricted_substances_ba_enabled: bool @@ -115,6 +120,7 @@ def __init__( self._ml_enabled: bool self._expiry_date: datetime | None | Unset_Type = Unset + self.is_flex_licensing_enabled = is_flex_licensing_enabled self.mi_server_enabled = mi_server_enabled self.workflow_advanced_enabled = workflow_advanced_enabled self.restricted_substances_ba_enabled = restricted_substances_ba_enabled @@ -124,10 +130,40 @@ def __init__( if expiry_date is not Unset: self.expiry_date = expiry_date + @property + def is_flex_licensing_enabled(self) -> "bool": + """Gets the is_flex_licensing_enabled of this GsaEnabledLicensesInfo. + Gets a flag indicating whether FlexLM licensing is enabled. If true, MI is in Ansys licensing mode. If false, MI is in classic licensing mode. + + Returns + ------- + bool + The is_flex_licensing_enabled of this GsaEnabledLicensesInfo. + """ + return self._is_flex_licensing_enabled + + @is_flex_licensing_enabled.setter + def is_flex_licensing_enabled(self, is_flex_licensing_enabled: "bool") -> None: + """Sets the is_flex_licensing_enabled of this GsaEnabledLicensesInfo. + Gets a flag indicating whether FlexLM licensing is enabled. If true, MI is in Ansys licensing mode. If false, MI is in classic licensing mode. + + Parameters + ---------- + is_flex_licensing_enabled: bool + The is_flex_licensing_enabled of this GsaEnabledLicensesInfo. + """ + # Field is not nullable + if is_flex_licensing_enabled is None: + raise ValueError("Invalid value for 'is_flex_licensing_enabled', must not be 'None'") + # Field is required + if is_flex_licensing_enabled is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'is_flex_licensing_enabled', must not be 'Unset'") + self._is_flex_licensing_enabled = is_flex_licensing_enabled + @property def mi_server_enabled(self) -> "bool": """Gets the mi_server_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether MI Server is enabled. This corresponds to an MI Server license having been checked out. + Gets a flag indicating whether MI Server is enabled. In Ansys licensing mode, this corresponds to an MI Server license having been checked out. In classic licensing mode, it is set to true. Returns ------- @@ -139,7 +175,7 @@ def mi_server_enabled(self) -> "bool": @mi_server_enabled.setter def mi_server_enabled(self, mi_server_enabled: "bool") -> None: """Sets the mi_server_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether MI Server is enabled. This corresponds to an MI Server license having been checked out. + Gets a flag indicating whether MI Server is enabled. In Ansys licensing mode, this corresponds to an MI Server license having been checked out. In classic licensing mode, it is set to true. Parameters ---------- @@ -157,7 +193,7 @@ def mi_server_enabled(self, mi_server_enabled: "bool") -> None: @property def workflow_advanced_enabled(self) -> "bool": """Gets the workflow_advanced_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether advanced workflow features are enabled. This corresponds to a Workflow Advanced license having been checked out. + Gets a flag indicating whether advanced workflow features are enabled. In Ansys licensing mode, this corresponds to a Workflow Advanced license having been checked out. In classic licensing mode, it is set to true. Returns ------- @@ -169,7 +205,7 @@ def workflow_advanced_enabled(self) -> "bool": @workflow_advanced_enabled.setter def workflow_advanced_enabled(self, workflow_advanced_enabled: "bool") -> None: """Sets the workflow_advanced_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether advanced workflow features are enabled. This corresponds to a Workflow Advanced license having been checked out. + Gets a flag indicating whether advanced workflow features are enabled. In Ansys licensing mode, this corresponds to a Workflow Advanced license having been checked out. In classic licensing mode, it is set to true. Parameters ---------- @@ -187,7 +223,7 @@ def workflow_advanced_enabled(self, workflow_advanced_enabled: "bool") -> None: @property def restricted_substances_ba_enabled(self) -> "bool": """Gets the restricted_substances_ba_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the Restricted Substances Analytics product are enabled. This corresponds to a Restricted Substances Analytics license (granta_mi_rsba) having been checked out. + Gets a flag indicating whether features associated with the Restricted Substances Analytics product are enabled. In Ansys licensing mode, this corresponds to a Restricted Substances Analytics license (granta_mi_rsba) having been checked out. In classic licensing mode, it is set to false. Returns ------- @@ -199,7 +235,7 @@ def restricted_substances_ba_enabled(self) -> "bool": @restricted_substances_ba_enabled.setter def restricted_substances_ba_enabled(self, restricted_substances_ba_enabled: "bool") -> None: """Sets the restricted_substances_ba_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the Restricted Substances Analytics product are enabled. This corresponds to a Restricted Substances Analytics license (granta_mi_rsba) having been checked out. + Gets a flag indicating whether features associated with the Restricted Substances Analytics product are enabled. In Ansys licensing mode, this corresponds to a Restricted Substances Analytics license (granta_mi_rsba) having been checked out. In classic licensing mode, it is set to false. Parameters ---------- @@ -221,7 +257,7 @@ def restricted_substances_ba_enabled(self, restricted_substances_ba_enabled: "bo @property def sustainability_enabled_enabled(self) -> "bool": """Gets the sustainability_enabled_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the Sustainability Analytics product are enabled. This corresponds to a Sustainability Analytics license (granta_mi_sus) having been checked out. + Gets a flag indicating whether features associated with the Sustainability Analytics product are enabled. In Ansys licensing mode, this corresponds to a Sustainability Analytics license (granta_mi_sus) having been checked out. In classic licensing mode, it is set to false. Returns ------- @@ -233,7 +269,7 @@ def sustainability_enabled_enabled(self) -> "bool": @sustainability_enabled_enabled.setter def sustainability_enabled_enabled(self, sustainability_enabled_enabled: "bool") -> None: """Sets the sustainability_enabled_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the Sustainability Analytics product are enabled. This corresponds to a Sustainability Analytics license (granta_mi_sus) having been checked out. + Gets a flag indicating whether features associated with the Sustainability Analytics product are enabled. In Ansys licensing mode, this corresponds to a Sustainability Analytics license (granta_mi_sus) having been checked out. In classic licensing mode, it is set to false. Parameters ---------- @@ -255,7 +291,7 @@ def sustainability_enabled_enabled(self, sustainability_enabled_enabled: "bool") @property def plm_sync_enabled(self) -> "bool": """Gets the plm_sync_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the PLM Sync (notably MI Enterprise Connect) are enabled. This corresponds to a PLM sync license having been checked out. + Gets a flag indicating whether features associated with the PLM Sync (notably MI Enterprise Connect) are enabled. In Ansys licensing mode, this corresponds to a PLM sync license having been checked out. In classic licensing mode, it is set to true. Returns ------- @@ -267,7 +303,7 @@ def plm_sync_enabled(self) -> "bool": @plm_sync_enabled.setter def plm_sync_enabled(self, plm_sync_enabled: "bool") -> None: """Sets the plm_sync_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the PLM Sync (notably MI Enterprise Connect) are enabled. This corresponds to a PLM sync license having been checked out. + Gets a flag indicating whether features associated with the PLM Sync (notably MI Enterprise Connect) are enabled. In Ansys licensing mode, this corresponds to a PLM sync license having been checked out. In classic licensing mode, it is set to true. Parameters ---------- @@ -285,7 +321,7 @@ def plm_sync_enabled(self, plm_sync_enabled: "bool") -> None: @property def ml_enabled(self) -> "bool": """Gets the ml_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the ML (Machine Learning) are enabled. This corresponds to a ML license having been checked out. + Gets a flag indicating whether features associated with the ML (Machine Learning) are enabled. In Ansys licensing mode, this corresponds to a ML license having been checked out. In classic licensing mode, it is set to false. Returns ------- @@ -297,7 +333,7 @@ def ml_enabled(self) -> "bool": @ml_enabled.setter def ml_enabled(self, ml_enabled: "bool") -> None: """Sets the ml_enabled of this GsaEnabledLicensesInfo. - Gets a flag indicating whether features associated with the ML (Machine Learning) are enabled. This corresponds to a ML license having been checked out. + Gets a flag indicating whether features associated with the ML (Machine Learning) are enabled. In Ansys licensing mode, this corresponds to a ML license having been checked out. In classic licensing mode, it is set to false. Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_already_exists_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_already_exists_error_detail.py index 15b465eb..61e6edac 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_already_exists_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_already_exists_error_detail.py @@ -68,16 +68,16 @@ class GsaEntityAlreadyExistsErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", "guid": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", "guid": "guid", } @@ -88,21 +88,21 @@ class GsaEntityAlreadyExistsErrorDetail(GsaNamedEntityErrorDetail): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.ENTITYALREADYEXISTS, + entity_type_name: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, ) -> None: """GsaEntityAlreadyExistsErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional guid: str, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) self._guid: str | Unset_Type = Unset if guid is not Unset: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_identifier_already_specified_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_identifier_already_specified_error_detail.py index 2b450a9f..a41c4469 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_identifier_already_specified_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_identifier_already_specified_error_detail.py @@ -68,16 +68,16 @@ class GsaEntityIdentifierAlreadySpecifiedErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", "guid": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", "guid": "guid", } @@ -88,21 +88,21 @@ class GsaEntityIdentifierAlreadySpecifiedErrorDetail(GsaNamedEntityErrorDetail): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.ENTITYIDENTIFIERALREADYSPECIFIED, + entity_type_name: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, ) -> None: """GsaEntityIdentifierAlreadySpecifiedErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional guid: str, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) self._guid: str | Unset_Type = Unset if guid is not Unset: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_type.py deleted file mode 100644 index 4f2a5a04..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_entity_type.py +++ /dev/null @@ -1,63 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaEntityType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTE = "attribute" - DATABASE = "database" - DISCRETEVALUE = "discreteValue" - DISCRETETYPE = "discreteType" - METAATTRIBUTE = "metaAttribute" - PARAMETER = "parameter" - PARAMETERVALUE = "parameterValue" - TABLE = "table" - FILE = "file" - FOLDER = "folder" - RECORDHISTORY = "recordHistory" - RECORDLINKGROUP = "recordLinkGroup" - UNIT = "unit" - CONSTANT = "constant" - PERMISSION = "permission" - PERMISSIONCATEGORY = "permissionCategory" - ACCESSCONTROLCATEGORY = "accessControlCategory" - QUALITYSYSTEM = "qualitySystem" - QUALITYDISCRETEVALUE = "qualityDiscreteValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_equation_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_equation_unit_error_detail.py deleted file mode 100644 index db660f08..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_equation_unit_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaEquationUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "errors": "list[GsaUnitEquationErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaUnitEquationErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.EQUATION, - errors: "list[GsaUnitEquationErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaEquationUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - errors: list[GsaUnitEquationErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaUnitEquationErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaUnitEquationErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaEquationUnitErrorDetail. - - Returns - ------- - list[GsaUnitEquationErrorDetail] | None | Unset_Type - The errors of this GsaEquationUnitErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquationErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaEquationUnitErrorDetail. - - Parameters - ---------- - errors: list[GsaUnitEquationErrorDetail] | None | Unset_Type - The errors of this GsaEquationUnitErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaEquationUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_code.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_code.py deleted file mode 100644 index 73efca12..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_code.py +++ /dev/null @@ -1,129 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaErrorCode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNKNOWN = "unknown" - ACCESSDENIED = "accessDenied" - ADDDATABASE = "addDatabase" - ATTRIBUTECREATION = "attributeCreation" - DATAVALIDATION = "dataValidation" - DELETERECORDVERSIONCONTROL = "deleteRecordVersionControl" - DELETION = "deletion" - DISCRETEVALUECREATION = "discreteValueCreation" - DISCRETEVALUEUPDATE = "discreteValueUpdate" - DISCRETEVALUEREPLACEMENT = "discreteValueReplacement" - DISCRETETYPECREATION = "discreteTypeCreation" - DISCRETETYPEUPDATE = "discreteTypeUpdate" - DISPLAYNAMESIMPORT = "displayNamesImport" - FILECREATION = "fileCreation" - FILEMOVE = "fileMove" - FILEUPDATE = "fileUpdate" - FOLDERCREATION = "folderCreation" - FOLDERDELETION = "folderDeletion" - FOLDERMOVE = "folderMove" - FOLDERUPDATE = "folderUpdate" - GETMODIFIABLERECORDVERSIONCONTROL = "getModifiableRecordVersionControl" - IMAGETYPEVALIDATION = "imageTypeValidation" - INPUTVALIDATION = "inputValidation" - INTERNALSERVERERROR = "internalServerError" - JSONSERIALIZATION = "jsonSerialization" - NOSUCHENTITY = "noSuchEntity" - NOSUCHITEM = "noSuchItem" - NOTIMPLEMENTED = "notImplemented" - NOTSPECIFIED = "notSpecified" - NOTSUPPORTED = "notSupported" - PARAMETERCREATION = "parameterCreation" - PARAMETERUPDATE = "parameterUpdate" - PARAMETERVALUECREATION = "parameterValueCreation" - PARAMETERVALUEUPDATE = "parameterValueUpdate" - RECORDHISTORYCOPY = "recordHistoryCopy" - RECORDHISTORYCREATE = "recordHistoryCreate" - RECORDHISTORYMOVE = "recordHistoryMove" - RECORDLINKGROUPCREATION = "recordLinkGroupCreation" - RECORDLINKGROUPUPDATE = "recordLinkGroupUpdate" - RECORDLISTPUBLISH = "recordListPublish" - RECORDLISTRESETAWAITINGAPPROVAL = "recordListResetAwaitingApproval" - RECORDLISTSETAWAITINGAPPROVAL = "recordListSetAwaitingApproval" - RECORDLISTSETPERMISSIONS = "recordListSetPermissions" - RECORDLISTUNPUBLISH = "recordListUnpublish" - RELEASERECORDVERSIONCONTROL = "releaseRecordVersionControl" - RELEASETABLEVERSIONCONTROL = "releaseTableVersionControl" - SUBTYPEDESERIALIZATION = "subtypeDeserialization" - SERVERNOTAVAILABLE = "serverNotAvailable" - UPGRADEDATABASE = "upgradeDatabase" - WITHDRAWRECORDVERSIONCONTROL = "withdrawRecordVersionControl" - RECORDNOTMODIFIABLE = "recordNotModifiable" - CONFLICTING = "conflicting" - CURRENCYCREATION = "currencyCreation" - CURRENCYUPDATE = "currencyUpdate" - CURRENCYIMPORT = "currencyImport" - CURRENCYIMPORTDUPLICATES = "currencyImportDuplicates" - UNITCREATION = "unitCreation" - UNITUPDATE = "unitUpdate" - CONSTANTCREATION = "constantCreation" - CONSTANTUPDATE = "constantUpdate" - STANDARDNAMECREATION = "standardNameCreation" - STANDARDNAMEUPDATE = "standardNameUpdate" - STANDARDNAMEDELETION = "standardNameDeletion" - PERMISSIONCREATION = "permissionCreation" - PERMISSIONUPDATE = "permissionUpdate" - PERMISSIONDELETION = "permissionDeletion" - PERMISSIONCATEGORYCREATION = "permissionCategoryCreation" - PERMISSIONCATEGORYUPDATE = "permissionCategoryUpdate" - PERMISSIONCATEGORYDELETION = "permissionCategoryDeletion" - PERMISSIONCATEGORYREPLACE = "permissionCategoryReplace" - PERMISSIONCATEGORIESACCESSCONTROLUPDATE = "permissionCategoriesAccessControlUpdate" - ACCESSCONTROLCATEGORYCREATION = "accessControlCategoryCreation" - ACCESSCONTROLCATEGORYUPDATE = "accessControlCategoryUpdate" - GETUNITEQUIVALENTS = "getUnitEquivalents" - SETUNITEQUIVALENTS = "setUnitEquivalents" - TABLECREATION = "tableCreation" - TABLEUPDATE = "tableUpdate" - REORDERTABLES = "reorderTables" - LONGRUNNINGOPERATIONINVALIDSTATUS = "longRunningOperationInvalidStatus" - QUALITYSYSTEMCREATION = "qualitySystemCreation" - PERMISSIONBASEDACCESSCONTROLUPDATEOPERATION = "permissionBasedAccessControlUpdateOperation" - ATTRIBUTEUPDATE = "attributeUpdate" - PERMISSIONBASEDACCESSCONTROLAGGREGATION = "permissionBasedAccessControlAggregation" - SCHEMAVALIDATION = "schemaValidation" - SIMILARITYNODATA = "similarityNoData" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail.py similarity index 79% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_error_detail.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail.py index 878faa48..39d12967 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail.py @@ -42,7 +42,7 @@ from . import * -class GsaFolderDeletionErrorDetail(ModelBase): +class GsaErrorDetail(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -62,7 +62,7 @@ class GsaFolderDeletionErrorDetail(ModelBase): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaFolderDeletionErrorReason", + "reason": "str", } attribute_map: dict[str, str] = { @@ -70,9 +70,7 @@ class GsaFolderDeletionErrorDetail(ModelBase): "reason": "reason", } - subtype_mapping: dict[str, str] = { - "reason": "GsaFolderDeletionErrorReason", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -80,40 +78,40 @@ def __init__( self, *, message: "str", - reason: "GsaFolderDeletionErrorReason", + reason: "str", ) -> None: - """GsaFolderDeletionErrorDetail - a model defined in Swagger + """GsaErrorDetail - a model defined in Swagger Parameters ---------- message: str - reason: GsaFolderDeletionErrorReason + reason: str """ self._message: str - self._reason: GsaFolderDeletionErrorReason + self._reason: str self.message = message self.reason = reason @property def message(self) -> "str": - """Gets the message of this GsaFolderDeletionErrorDetail. + """Gets the message of this GsaErrorDetail. Returns ------- str - The message of this GsaFolderDeletionErrorDetail. + The message of this GsaErrorDetail. """ return self._message @message.setter def message(self, message: "str") -> None: - """Sets the message of this GsaFolderDeletionErrorDetail. + """Sets the message of this GsaErrorDetail. Parameters ---------- message: str - The message of this GsaFolderDeletionErrorDetail. + The message of this GsaErrorDetail. """ # Field is not nullable if message is None: @@ -124,24 +122,24 @@ def message(self, message: "str") -> None: self._message = message @property - def reason(self) -> "GsaFolderDeletionErrorReason": - """Gets the reason of this GsaFolderDeletionErrorDetail. + def reason(self) -> "str": + """Gets the reason of this GsaErrorDetail. Returns ------- - GsaFolderDeletionErrorReason - The reason of this GsaFolderDeletionErrorDetail. + str + The reason of this GsaErrorDetail. """ return self._reason @reason.setter - def reason(self, reason: "GsaFolderDeletionErrorReason") -> None: - """Sets the reason of this GsaFolderDeletionErrorDetail. + def reason(self, reason: "str") -> None: + """Sets the reason of this GsaErrorDetail. Parameters ---------- - reason: GsaFolderDeletionErrorReason - The reason of this GsaFolderDeletionErrorDetail. + reason: str + The reason of this GsaErrorDetail. """ # Field is not nullable if reason is None: @@ -173,7 +171,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderDeletionErrorDetail): + if not isinstance(other, GsaErrorDetail): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail_of_record_history_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail_of_record_history_error_reason.py deleted file mode 100644 index cd45c92c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail_of_record_history_error_reason.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaErrorDetailOfRecordHistoryErrorReason(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordHistoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaRecordHistoryErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordHistoryErrorReason", - ) -> None: - """GsaErrorDetailOfRecordHistoryErrorReason - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordHistoryErrorReason - """ - self._message: str - self._reason: GsaRecordHistoryErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaErrorDetailOfRecordHistoryErrorReason. - - Returns - ------- - str - The message of this GsaErrorDetailOfRecordHistoryErrorReason. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaErrorDetailOfRecordHistoryErrorReason. - - Parameters - ---------- - message: str - The message of this GsaErrorDetailOfRecordHistoryErrorReason. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaRecordHistoryErrorReason": - """Gets the reason of this GsaErrorDetailOfRecordHistoryErrorReason. - - Returns - ------- - GsaRecordHistoryErrorReason - The reason of this GsaErrorDetailOfRecordHistoryErrorReason. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaRecordHistoryErrorReason") -> None: - """Sets the reason of this GsaErrorDetailOfRecordHistoryErrorReason. - - Parameters - ---------- - reason: GsaRecordHistoryErrorReason - The reason of this GsaErrorDetailOfRecordHistoryErrorReason. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaErrorDetailOfRecordHistoryErrorReason): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_exception_information.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_exception_information.py deleted file mode 100644 index a19ba0e6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_exception_information.py +++ /dev/null @@ -1,293 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaExceptionInformation(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "exception_type_full_name": "str", - "localised_message": "str", - "message": "str", - "stringified_exception": "str", - "inner_exception_info": "GsaExceptionInformation", - } - - attribute_map: dict[str, str] = { - "exception_type_full_name": "exceptionTypeFullName", - "localised_message": "localisedMessage", - "message": "message", - "stringified_exception": "stringifiedException", - "inner_exception_info": "innerExceptionInfo", - } - - subtype_mapping: dict[str, str] = { - "innerExceptionInfo": "GsaExceptionInformation", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - exception_type_full_name: "str", - localised_message: "str", - message: "str", - stringified_exception: "str", - inner_exception_info: "GsaExceptionInformation | Unset_Type" = Unset, - ) -> None: - """GsaExceptionInformation - a model defined in Swagger - - Parameters - ---------- - exception_type_full_name: str - localised_message: str - message: str - stringified_exception: str - inner_exception_info: GsaExceptionInformation, optional - """ - self._exception_type_full_name: str - self._message: str - self._localised_message: str - self._stringified_exception: str - self._inner_exception_info: GsaExceptionInformation | Unset_Type = Unset - - self.exception_type_full_name = exception_type_full_name - self.message = message - self.localised_message = localised_message - self.stringified_exception = stringified_exception - if inner_exception_info is not Unset: - self.inner_exception_info = inner_exception_info - - @property - def exception_type_full_name(self) -> "str": - """Gets the exception_type_full_name of this GsaExceptionInformation. - Full type name of the original exception. - - Returns - ------- - str - The exception_type_full_name of this GsaExceptionInformation. - """ - return self._exception_type_full_name - - @exception_type_full_name.setter - def exception_type_full_name(self, exception_type_full_name: "str") -> None: - """Sets the exception_type_full_name of this GsaExceptionInformation. - Full type name of the original exception. - - Parameters - ---------- - exception_type_full_name: str - The exception_type_full_name of this GsaExceptionInformation. - """ - # Field is not nullable - if exception_type_full_name is None: - raise ValueError("Invalid value for 'exception_type_full_name', must not be 'None'") - # Field is required - if exception_type_full_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'exception_type_full_name', must not be 'Unset'") - self._exception_type_full_name = exception_type_full_name - - @property - def message(self) -> "str": - """Gets the message of this GsaExceptionInformation. - Message of the original exception. - - Returns - ------- - str - The message of this GsaExceptionInformation. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaExceptionInformation. - Message of the original exception. - - Parameters - ---------- - message: str - The message of this GsaExceptionInformation. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def localised_message(self) -> "str": - """Gets the localised_message of this GsaExceptionInformation. - Localised message of the original exception if available. Regular message of the original exception otherwise. - - Returns - ------- - str - The localised_message of this GsaExceptionInformation. - """ - return self._localised_message - - @localised_message.setter - def localised_message(self, localised_message: "str") -> None: - """Sets the localised_message of this GsaExceptionInformation. - Localised message of the original exception if available. Regular message of the original exception otherwise. - - Parameters - ---------- - localised_message: str - The localised_message of this GsaExceptionInformation. - """ - # Field is not nullable - if localised_message is None: - raise ValueError("Invalid value for 'localised_message', must not be 'None'") - # Field is required - if localised_message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'localised_message', must not be 'Unset'") - self._localised_message = localised_message - - @property - def stringified_exception(self) -> "str": - """Gets the stringified_exception of this GsaExceptionInformation. - The result of calling .ToString() on the original exception. - - Returns - ------- - str - The stringified_exception of this GsaExceptionInformation. - """ - return self._stringified_exception - - @stringified_exception.setter - def stringified_exception(self, stringified_exception: "str") -> None: - """Sets the stringified_exception of this GsaExceptionInformation. - The result of calling .ToString() on the original exception. - - Parameters - ---------- - stringified_exception: str - The stringified_exception of this GsaExceptionInformation. - """ - # Field is not nullable - if stringified_exception is None: - raise ValueError("Invalid value for 'stringified_exception', must not be 'None'") - # Field is required - if stringified_exception is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'stringified_exception', must not be 'Unset'") - self._stringified_exception = stringified_exception - - @property - def inner_exception_info(self) -> "GsaExceptionInformation | Unset_Type": - """Gets the inner_exception_info of this GsaExceptionInformation. - - Returns - ------- - GsaExceptionInformation | Unset_Type - The inner_exception_info of this GsaExceptionInformation. - """ - return self._inner_exception_info - - @inner_exception_info.setter - def inner_exception_info( - self, inner_exception_info: "GsaExceptionInformation | Unset_Type" - ) -> None: - """Sets the inner_exception_info of this GsaExceptionInformation. - - Parameters - ---------- - inner_exception_info: GsaExceptionInformation | Unset_Type - The inner_exception_info of this GsaExceptionInformation. - """ - # Field is not nullable - if inner_exception_info is None: - raise ValueError("Invalid value for 'inner_exception_info', must not be 'None'") - self._inner_exception_info = inner_exception_info - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaExceptionInformation): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression.py index ade7bf0a..c20f3cbd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression.py @@ -66,7 +66,6 @@ class GsaExpression(ModelBase): "guid": "str", "name": "str", "parameter_dependencies": "list[GsaSlimNamedEntity]", - "table": "GsaSlimEntity", "value": "str", "unit": "GsaSlimUnit", } @@ -77,7 +76,6 @@ class GsaExpression(ModelBase): "guid": "guid", "name": "name", "parameter_dependencies": "parameterDependencies", - "table": "table", "value": "value", "unit": "unit", } @@ -87,7 +85,6 @@ class GsaExpression(ModelBase): "attributeDependencies": "GsaSlimAttribute", "constantDependencies": "GsaSlimNamedEntity", "parameterDependencies": "GsaSlimNamedEntity", - "table": "GsaSlimEntity", } discriminator: Optional[str] = None @@ -100,7 +97,6 @@ def __init__( guid: "str", name: "str", parameter_dependencies: "list[GsaSlimNamedEntity]", - table: "GsaSlimEntity", value: "str", unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: @@ -113,7 +109,6 @@ def __init__( guid: str name: str parameter_dependencies: list[GsaSlimNamedEntity] - table: GsaSlimEntity value: str unit: GsaSlimUnit, optional """ @@ -122,7 +117,6 @@ def __init__( self._attribute_dependencies: list[GsaSlimAttribute] self._constant_dependencies: list[GsaSlimNamedEntity] self._parameter_dependencies: list[GsaSlimNamedEntity] - self._table: GsaSlimEntity self._name: str self._guid: str @@ -132,7 +126,6 @@ def __init__( self.attribute_dependencies = attribute_dependencies self.constant_dependencies = constant_dependencies self.parameter_dependencies = parameter_dependencies - self.table = table self.name = name self.guid = guid @@ -273,34 +266,6 @@ def parameter_dependencies(self, parameter_dependencies: "list[GsaSlimNamedEntit raise ValueError("Invalid value for 'parameter_dependencies', must not be 'Unset'") self._parameter_dependencies = parameter_dependencies - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaExpression. - - Returns - ------- - GsaSlimEntity - The table of this GsaExpression. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaExpression. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaExpression. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - @property def name(self) -> "str": """Gets the name of this GsaExpression. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_access_control_entity.py deleted file mode 100644 index 775b6e9a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_access_control_entity.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity import ( # noqa: F401 - GsaAccessControlEntity, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity_type import ( - GsaAccessControlEntityType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaExpressionAccessControlEntity(GsaAccessControlEntity): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlEntityType", - "expression_guid": "str", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "expression_guid": "expressionGuid", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlEntityType" = GsaAccessControlEntityType.EXPRESSION, - expression_guid: "str", - table_guid: "str", - ) -> None: - """GsaExpressionAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - expression_guid: str - table_guid: str - """ - super().__init__(entity_type=entity_type) - self._table_guid: str - self._expression_guid: str - - self.table_guid = table_guid - self.expression_guid = expression_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaExpressionAccessControlEntity. - - Returns - ------- - str - The table_guid of this GsaExpressionAccessControlEntity. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaExpressionAccessControlEntity. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaExpressionAccessControlEntity. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def expression_guid(self) -> "str": - """Gets the expression_guid of this GsaExpressionAccessControlEntity. - - Returns - ------- - str - The expression_guid of this GsaExpressionAccessControlEntity. - """ - return self._expression_guid - - @expression_guid.setter - def expression_guid(self, expression_guid: "str") -> None: - """Sets the expression_guid of this GsaExpressionAccessControlEntity. - - Parameters - ---------- - expression_guid: str - The expression_guid of this GsaExpressionAccessControlEntity. - """ - # Field is not nullable - if expression_guid is None: - raise ValueError("Invalid value for 'expression_guid', must not be 'None'") - # Field is required - if expression_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'expression_guid', must not be 'Unset'") - self._expression_guid = expression_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaExpressionAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_deletion_exception.py deleted file mode 100644 index 0027bb77..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_deletion_exception.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaExpressionDeletionException(GsaDeletionException): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", - "errors": "list[GsaDataModificationErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.EXPRESSION, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaExpressionDeletionException - a model defined in Swagger - - Parameters - ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional - errors: list[GsaDataModificationErrorDetail] | None, optional - message: str | None, optional - """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaExpressionDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_usage_data_modification_error_detail.py index 30cfeadb..6e5f31c6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_usage_data_modification_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_expression_usage_data_modification_error_detail.py @@ -74,7 +74,7 @@ class GsaExpressionUsageDataModificationErrorDetail(GsaUsageDataModificationErro "message": "str", "reason": "GsaDataModificationErrorReason", "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimExpression]", + "referenced_by": "list[GsaSlimNamedEntity]", } attribute_map: dict[str, str] = { @@ -85,7 +85,7 @@ class GsaExpressionUsageDataModificationErrorDetail(GsaUsageDataModificationErro } subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimExpression", + "referencedBy": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -96,7 +96,7 @@ def __init__( message: "str", reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.EXPRESSION, - referenced_by: "list[GsaSlimExpression] | None | Unset_Type" = Unset, + referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ) -> None: """GsaExpressionUsageDataModificationErrorDetail - a model defined in Swagger @@ -105,32 +105,32 @@ def __init__( message: str reason: GsaDataModificationErrorReason referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimExpression] | None, optional + referenced_by: list[GsaSlimNamedEntity] | None, optional """ super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimExpression] | None | Unset_Type = Unset + self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset if referenced_by is not Unset: self.referenced_by = referenced_by @property - def referenced_by(self) -> "list[GsaSlimExpression] | None | Unset_Type": + def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": """Gets the referenced_by of this GsaExpressionUsageDataModificationErrorDetail. Returns ------- - list[GsaSlimExpression] | None | Unset_Type + list[GsaSlimNamedEntity] | None | Unset_Type The referenced_by of this GsaExpressionUsageDataModificationErrorDetail. """ return self._referenced_by @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimExpression] | None | Unset_Type") -> None: + def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: """Sets the referenced_by of this GsaExpressionUsageDataModificationErrorDetail. Parameters ---------- - referenced_by: list[GsaSlimExpression] | None | Unset_Type + referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type The referenced_by of this GsaExpressionUsageDataModificationErrorDetail. """ self._referenced_by = referenced_by diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_already_exists_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_already_exists_file_move_error_detail.py deleted file mode 100644 index a2354743..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_already_exists_file_move_error_detail.py +++ /dev/null @@ -1,190 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_move_error_detail import ( # noqa: F401 - GsaFileMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_move_error_reason import ( - GsaFileMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileAlreadyExistsFileMoveErrorDetail(GsaFileMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - "name": "str", - "parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - "parent_folder_guid": "parentFolderGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason" = GsaFileMoveErrorReason.FILEALREADYEXISTS, - name: "str | None | Unset_Type" = Unset, - parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaFileAlreadyExistsFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - name: str | None, optional - parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._parent_folder_guid: str | Unset_Type = Unset - - if name is not Unset: - self.name = name - if parent_folder_guid is not Unset: - self.parent_folder_guid = parent_folder_guid - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - self._name = name - - @property - def parent_folder_guid(self) -> "str | Unset_Type": - """Gets the parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - return self._parent_folder_guid - - @parent_folder_guid.setter - def parent_folder_guid(self, parent_folder_guid: "str | Unset_Type") -> None: - """Sets the parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Parameters - ---------- - parent_folder_guid: str | Unset_Type - The parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - # Field is not nullable - if parent_folder_guid is None: - raise ValueError("Invalid value for 'parent_folder_guid', must not be 'None'") - self._parent_folder_guid = parent_folder_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileAlreadyExistsFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_attribute.py index b0edff80..dc209f39 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_attribute.py @@ -69,7 +69,6 @@ class GsaFileAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaFileAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.FILE, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_creation_exception.py deleted file mode 100644 index ba125b13..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_creation_exception.py +++ /dev/null @@ -1,268 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFileErrorDetail]", - "folder_type": "GsaFolderType", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_type": "folderType", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFileErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFileErrorDetail] | None | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFileErrorDetail] | None, optional - folder_type: GsaFolderType, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFileErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFileCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFileCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFileCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFileCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFileCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFileCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFileCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFileCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileCreationException. - """ - self._name = name - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFileCreationException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFileCreationException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFileCreationException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFileCreationException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFileErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFileCreationException. - - Returns - ------- - list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFileErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFileCreationException. - - Parameters - ---------- - errors: list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_detail.py deleted file mode 100644 index 54b877b5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFileErrorReason", - } - - discriminator_value_class_map = { - "configInvalidJson".lower(): "#/components/schemas/GsaConfigInvalidJsonFileErrorDetail", - "descriptionLength".lower(): "#/components/schemas/GsaDescriptionLengthFileErrorDetail", - "fileName".lower(): "#/components/schemas/GsaFileNameFileErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityFileErrorDetail", - "noData".lower(): "#/components/schemas/GsaNoDataFileErrorDetail", - "noFile".lower(): "#/components/schemas/GsaNoFileFileErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason", - ) -> None: - """GsaFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - """ - self._message: str - self._reason: GsaFileErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFileErrorDetail. - - Returns - ------- - str - The message of this GsaFileErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFileErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFileErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFileErrorReason": - """Gets the reason of this GsaFileErrorDetail. - - Returns - ------- - GsaFileErrorReason - The reason of this GsaFileErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFileErrorReason") -> None: - """Sets the reason of this GsaFileErrorDetail. - - Parameters - ---------- - reason: GsaFileErrorReason - The reason of this GsaFileErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_reason.py deleted file mode 100644 index e74dcd54..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFileErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CONFIGINVALIDJSON = "configInvalidJson" - DESCRIPTIONLENGTH = "descriptionLength" - FILENAME = "fileName" - NAMEDENTITY = "namedEntity" - NODATA = "noData" - NOFILE = "noFile" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_header_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_header_info.py deleted file mode 100644 index f934fac8..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_header_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileHeaderInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "file_headers": "list[GsaFileHeader]", - } - - attribute_map: dict[str, str] = { - "file_headers": "fileHeaders", - } - - subtype_mapping: dict[str, str] = { - "fileHeaders": "GsaFileHeader", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - file_headers: "list[GsaFileHeader]", - ) -> None: - """GsaFileHeaderInfo - a model defined in Swagger - - Parameters - ---------- - file_headers: list[GsaFileHeader] - """ - self._file_headers: list[GsaFileHeader] - - self.file_headers = file_headers - - @property - def file_headers(self) -> "list[GsaFileHeader]": - """Gets the file_headers of this GsaFileHeaderInfo. - - Returns - ------- - list[GsaFileHeader] - The file_headers of this GsaFileHeaderInfo. - """ - return self._file_headers - - @file_headers.setter - def file_headers(self, file_headers: "list[GsaFileHeader]") -> None: - """Sets the file_headers of this GsaFileHeaderInfo. - - Parameters - ---------- - file_headers: list[GsaFileHeader] - The file_headers of this GsaFileHeaderInfo. - """ - # Field is not nullable - if file_headers is None: - raise ValueError("Invalid value for 'file_headers', must not be 'None'") - # Field is required - if file_headers is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'file_headers', must not be 'Unset'") - self._file_headers = file_headers - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileHeaderInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_detail.py deleted file mode 100644 index fa665fa6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileMoveErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFileMoveErrorReason", - } - - discriminator_value_class_map = { - "fileAlreadyExists".lower(): "#/components/schemas/GsaFileAlreadyExistsFileMoveErrorDetail", - "noSuchNewParent".lower(): "#/components/schemas/GsaNoSuchNewParentFileMoveErrorDetail", - "sameParent".lower(): "#/components/schemas/GsaSameParentFileMoveErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason", - ) -> None: - """GsaFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - """ - self._message: str - self._reason: GsaFileMoveErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFileMoveErrorDetail. - - Returns - ------- - str - The message of this GsaFileMoveErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFileMoveErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFileMoveErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFileMoveErrorReason": - """Gets the reason of this GsaFileMoveErrorDetail. - - Returns - ------- - GsaFileMoveErrorReason - The reason of this GsaFileMoveErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFileMoveErrorReason") -> None: - """Sets the reason of this GsaFileMoveErrorDetail. - - Parameters - ---------- - reason: GsaFileMoveErrorReason - The reason of this GsaFileMoveErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_reason.py deleted file mode 100644 index 01924935..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFileMoveErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FILEALREADYEXISTS = "fileAlreadyExists" - NOSUCHNEWPARENT = "noSuchNewParent" - SAMEPARENT = "sameParent" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_exception.py deleted file mode 100644 index dd58931a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_move_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileMoveException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFileMoveErrorDetail]", - "file_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "file_guid": "fileGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFileMoveErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFileMoveErrorDetail] | None | Unset_Type" = Unset, - file_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileMoveException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFileMoveErrorDetail] | None, optional - file_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._file_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFileMoveErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if file_guid is not Unset: - self.file_guid = file_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFileMoveException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFileMoveException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFileMoveException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFileMoveException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFileMoveException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFileMoveException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFileMoveException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFileMoveException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def file_guid(self) -> "str | Unset_Type": - """Gets the file_guid of this GsaFileMoveException. - - Returns - ------- - str | Unset_Type - The file_guid of this GsaFileMoveException. - """ - return self._file_guid - - @file_guid.setter - def file_guid(self, file_guid: "str | Unset_Type") -> None: - """Sets the file_guid of this GsaFileMoveException. - - Parameters - ---------- - file_guid: str | Unset_Type - The file_guid of this GsaFileMoveException. - """ - # Field is not nullable - if file_guid is None: - raise ValueError("Invalid value for 'file_guid', must not be 'None'") - self._file_guid = file_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFileMoveException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFileMoveException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFileMoveException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFileMoveException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFileMoveErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFileMoveException. - - Returns - ------- - list[GsaFileMoveErrorDetail] | None | Unset_Type - The errors of this GsaFileMoveException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFileMoveErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFileMoveException. - - Parameters - ---------- - errors: list[GsaFileMoveErrorDetail] | None | Unset_Type - The errors of this GsaFileMoveException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileMoveException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_file_error_detail.py deleted file mode 100644 index a317510b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_file_error_detail.py +++ /dev/null @@ -1,156 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileNameFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.FILENAME, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileNameFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileNameFileErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileNameFileErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileNameFileErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileNameFileErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileNameFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_folder_error_detail.py deleted file mode 100644 index aa589b35..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_name_folder_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_error_detail import ( # noqa: F401 - GsaFolderErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_error_reason import ( - GsaFolderErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileNameFolderErrorDetail(GsaFolderErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason" = GsaFolderErrorReason.FILENAME, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileNameFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileNameFolderErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileNameFolderErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileNameFolderErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileNameFolderErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileNameFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_update_exception.py deleted file mode 100644 index 22c53727..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_file_update_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFileErrorDetail]", - "file_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "file_guid": "fileGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFileErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFileErrorDetail] | None | Unset_Type" = Unset, - file_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFileErrorDetail] | None, optional - file_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._file_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFileErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if file_guid is not Unset: - self.file_guid = file_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFileUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFileUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFileUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFileUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFileUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFileUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFileUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFileUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def file_guid(self) -> "str | Unset_Type": - """Gets the file_guid of this GsaFileUpdateException. - - Returns - ------- - str | Unset_Type - The file_guid of this GsaFileUpdateException. - """ - return self._file_guid - - @file_guid.setter - def file_guid(self, file_guid: "str | Unset_Type") -> None: - """Sets the file_guid of this GsaFileUpdateException. - - Parameters - ---------- - file_guid: str | Unset_Type - The file_guid of this GsaFileUpdateException. - """ - # Field is not nullable - if file_guid is None: - raise ValueError("Invalid value for 'file_guid', must not be 'None'") - self._file_guid = file_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFileUpdateException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFileUpdateException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFileUpdateException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFileUpdateException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFileErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFileUpdateException. - - Returns - ------- - list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFileErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFileUpdateException. - - Parameters - ---------- - errors: list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_source.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_search_request.py similarity index 77% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_source.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_search_request.py index 3155b1ef..815c7078 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_data_source.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_search_request.py @@ -42,7 +42,7 @@ from . import * -class GsaDataSource(ModelBase): +class GsaFindSearchRequest(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,11 +61,11 @@ class GsaDataSource(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "value": "str", + "name_contains": "str", } attribute_map: dict[str, str] = { - "value": "value", + "name_contains": "nameContains", } subtype_mapping: dict[str, str] = {} @@ -75,40 +75,40 @@ class GsaDataSource(ModelBase): def __init__( self, *, - value: "str | None | Unset_Type" = Unset, + name_contains: "str | None | Unset_Type" = Unset, ) -> None: - """GsaDataSource - a model defined in Swagger + """GsaFindSearchRequest - a model defined in Swagger Parameters ---------- - value: str | None, optional + name_contains: str | None, optional """ - self._value: str | None | Unset_Type = Unset + self._name_contains: str | None | Unset_Type = Unset - if value is not Unset: - self.value = value + if name_contains is not Unset: + self.name_contains = name_contains @property - def value(self) -> "str | None | Unset_Type": - """Gets the value of this GsaDataSource. + def name_contains(self) -> "str | None | Unset_Type": + """Gets the name_contains of this GsaFindSearchRequest. Returns ------- str | None | Unset_Type - The value of this GsaDataSource. + The name_contains of this GsaFindSearchRequest. """ - return self._value + return self._name_contains - @value.setter - def value(self, value: "str | None | Unset_Type") -> None: - """Sets the value of this GsaDataSource. + @name_contains.setter + def name_contains(self, name_contains: "str | None | Unset_Type") -> None: + """Sets the name_contains of this GsaFindSearchRequest. Parameters ---------- - value: str | None | Unset_Type - The value of this GsaDataSource. + name_contains: str | None | Unset_Type + The name_contains of this GsaFindSearchRequest. """ - self._value = value + self._name_contains = name_contains @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -132,7 +132,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaDataSource): + if not isinstance(other, GsaFindSearchRequest): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_request.py deleted file mode 100644 index 2220a632..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_request.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "similarity_settings": "GsaSimilaritySettings", - "criterion": "GsaFindSimilarSearchCriterion", - } - - attribute_map: dict[str, str] = { - "similarity_settings": "similaritySettings", - "criterion": "criterion", - } - - subtype_mapping: dict[str, str] = { - "similaritySettings": "GsaSimilaritySettings", - "criterion": "GsaFindSimilarSearchCriterion", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - similarity_settings: "GsaSimilaritySettings", - criterion: "GsaFindSimilarSearchCriterion | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarRequest - a model defined in Swagger - - Parameters - ---------- - similarity_settings: GsaSimilaritySettings - criterion: GsaFindSimilarSearchCriterion, optional - """ - self._similarity_settings: GsaSimilaritySettings - self._criterion: GsaFindSimilarSearchCriterion | Unset_Type = Unset - - self.similarity_settings = similarity_settings - if criterion is not Unset: - self.criterion = criterion - - @property - def similarity_settings(self) -> "GsaSimilaritySettings": - """Gets the similarity_settings of this GsaFindSimilarRequest. - - Returns - ------- - GsaSimilaritySettings - The similarity_settings of this GsaFindSimilarRequest. - """ - return self._similarity_settings - - @similarity_settings.setter - def similarity_settings(self, similarity_settings: "GsaSimilaritySettings") -> None: - """Sets the similarity_settings of this GsaFindSimilarRequest. - - Parameters - ---------- - similarity_settings: GsaSimilaritySettings - The similarity_settings of this GsaFindSimilarRequest. - """ - # Field is not nullable - if similarity_settings is None: - raise ValueError("Invalid value for 'similarity_settings', must not be 'None'") - # Field is required - if similarity_settings is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'similarity_settings', must not be 'Unset'") - self._similarity_settings = similarity_settings - - @property - def criterion(self) -> "GsaFindSimilarSearchCriterion | Unset_Type": - """Gets the criterion of this GsaFindSimilarRequest. - - Returns - ------- - GsaFindSimilarSearchCriterion | Unset_Type - The criterion of this GsaFindSimilarRequest. - """ - return self._criterion - - @criterion.setter - def criterion(self, criterion: "GsaFindSimilarSearchCriterion | Unset_Type") -> None: - """Sets the criterion of this GsaFindSimilarRequest. - - Parameters - ---------- - criterion: GsaFindSimilarSearchCriterion | Unset_Type - The criterion of this GsaFindSimilarRequest. - """ - # Field is not nullable - if criterion is None: - raise ValueError("Invalid value for 'criterion', must not be 'None'") - self._criterion = criterion - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_response.py deleted file mode 100644 index 0509cbef..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_response.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "error": "GsaErrorResponse", - "find_similar_id": "str", - } - - attribute_map: dict[str, str] = { - "error": "error", - "find_similar_id": "findSimilarId", - } - - subtype_mapping: dict[str, str] = { - "error": "GsaErrorResponse", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - error: "GsaErrorResponse | Unset_Type" = Unset, - find_similar_id: "str | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarResponse - a model defined in Swagger - - Parameters - ---------- - error: GsaErrorResponse, optional - find_similar_id: str, optional - """ - self._find_similar_id: str | Unset_Type = Unset - self._error: GsaErrorResponse | Unset_Type = Unset - - if find_similar_id is not Unset: - self.find_similar_id = find_similar_id - if error is not Unset: - self.error = error - - @property - def find_similar_id(self) -> "str | Unset_Type": - """Gets the find_similar_id of this GsaFindSimilarResponse. - The Identifier of the find similar calculation - - Returns - ------- - str | Unset_Type - The find_similar_id of this GsaFindSimilarResponse. - """ - return self._find_similar_id - - @find_similar_id.setter - def find_similar_id(self, find_similar_id: "str | Unset_Type") -> None: - """Sets the find_similar_id of this GsaFindSimilarResponse. - The Identifier of the find similar calculation - - Parameters - ---------- - find_similar_id: str | Unset_Type - The find_similar_id of this GsaFindSimilarResponse. - """ - # Field is not nullable - if find_similar_id is None: - raise ValueError("Invalid value for 'find_similar_id', must not be 'None'") - self._find_similar_id = find_similar_id - - @property - def error(self) -> "GsaErrorResponse | Unset_Type": - """Gets the error of this GsaFindSimilarResponse. - - Returns - ------- - GsaErrorResponse | Unset_Type - The error of this GsaFindSimilarResponse. - """ - return self._error - - @error.setter - def error(self, error: "GsaErrorResponse | Unset_Type") -> None: - """Sets the error of this GsaFindSimilarResponse. - - Parameters - ---------- - error: GsaErrorResponse | Unset_Type - The error of this GsaFindSimilarResponse. - """ - # Field is not nullable - if error is None: - raise ValueError("Invalid value for 'error', must not be 'None'") - self._error = error - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_result.py deleted file mode 100644 index 79355264..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_result.py +++ /dev/null @@ -1,178 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarResult(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_identifier": "GsaRecordVersionReference", - "score": "float", - } - - attribute_map: dict[str, str] = { - "record_identifier": "recordIdentifier", - "score": "score", - } - - subtype_mapping: dict[str, str] = { - "recordIdentifier": "GsaRecordVersionReference", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_identifier: "GsaRecordVersionReference | Unset_Type" = Unset, - score: "float | None | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarResult - a model defined in Swagger - - Parameters - ---------- - record_identifier: GsaRecordVersionReference, optional - score: float | None, optional - """ - self._record_identifier: GsaRecordVersionReference | Unset_Type = Unset - self._score: float | None | Unset_Type = Unset - - if record_identifier is not Unset: - self.record_identifier = record_identifier - if score is not Unset: - self.score = score - - @property - def record_identifier(self) -> "GsaRecordVersionReference | Unset_Type": - """Gets the record_identifier of this GsaFindSimilarResult. - - Returns - ------- - GsaRecordVersionReference | Unset_Type - The record_identifier of this GsaFindSimilarResult. - """ - return self._record_identifier - - @record_identifier.setter - def record_identifier( - self, record_identifier: "GsaRecordVersionReference | Unset_Type" - ) -> None: - """Sets the record_identifier of this GsaFindSimilarResult. - - Parameters - ---------- - record_identifier: GsaRecordVersionReference | Unset_Type - The record_identifier of this GsaFindSimilarResult. - """ - # Field is not nullable - if record_identifier is None: - raise ValueError("Invalid value for 'record_identifier', must not be 'None'") - self._record_identifier = record_identifier - - @property - def score(self) -> "float | None | Unset_Type": - """Gets the score of this GsaFindSimilarResult. - - Returns - ------- - float | None | Unset_Type - The score of this GsaFindSimilarResult. - """ - return self._score - - @score.setter - def score(self, score: "float | None | Unset_Type") -> None: - """Sets the score of this GsaFindSimilarResult. - - Parameters - ---------- - score: float | None | Unset_Type - The score of this GsaFindSimilarResult. - """ - self._score = score - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_search_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_search_criterion.py deleted file mode 100644 index e587b5fe..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_find_similar_search_criterion.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarSearchCriterion(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_type_criterion": "GsaRecordTypeCriterion", - "subset_criterion": "GsaRecordSubsetCriterion", - } - - attribute_map: dict[str, str] = { - "record_type_criterion": "recordTypeCriterion", - "subset_criterion": "subsetCriterion", - } - - subtype_mapping: dict[str, str] = { - "subsetCriterion": "GsaRecordSubsetCriterion", - "recordTypeCriterion": "GsaRecordTypeCriterion", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_type_criterion: "GsaRecordTypeCriterion | Unset_Type" = Unset, - subset_criterion: "GsaRecordSubsetCriterion | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarSearchCriterion - a model defined in Swagger - - Parameters - ---------- - record_type_criterion: GsaRecordTypeCriterion, optional - subset_criterion: GsaRecordSubsetCriterion, optional - """ - self._subset_criterion: GsaRecordSubsetCriterion | Unset_Type = Unset - self._record_type_criterion: GsaRecordTypeCriterion | Unset_Type = Unset - - if subset_criterion is not Unset: - self.subset_criterion = subset_criterion - if record_type_criterion is not Unset: - self.record_type_criterion = record_type_criterion - - @property - def subset_criterion(self) -> "GsaRecordSubsetCriterion | Unset_Type": - """Gets the subset_criterion of this GsaFindSimilarSearchCriterion. - - Returns - ------- - GsaRecordSubsetCriterion | Unset_Type - The subset_criterion of this GsaFindSimilarSearchCriterion. - """ - return self._subset_criterion - - @subset_criterion.setter - def subset_criterion(self, subset_criterion: "GsaRecordSubsetCriterion | Unset_Type") -> None: - """Sets the subset_criterion of this GsaFindSimilarSearchCriterion. - - Parameters - ---------- - subset_criterion: GsaRecordSubsetCriterion | Unset_Type - The subset_criterion of this GsaFindSimilarSearchCriterion. - """ - # Field is not nullable - if subset_criterion is None: - raise ValueError("Invalid value for 'subset_criterion', must not be 'None'") - self._subset_criterion = subset_criterion - - @property - def record_type_criterion(self) -> "GsaRecordTypeCriterion | Unset_Type": - """Gets the record_type_criterion of this GsaFindSimilarSearchCriterion. - - Returns - ------- - GsaRecordTypeCriterion | Unset_Type - The record_type_criterion of this GsaFindSimilarSearchCriterion. - """ - return self._record_type_criterion - - @record_type_criterion.setter - def record_type_criterion( - self, record_type_criterion: "GsaRecordTypeCriterion | Unset_Type" - ) -> None: - """Sets the record_type_criterion of this GsaFindSimilarSearchCriterion. - - Parameters - ---------- - record_type_criterion: GsaRecordTypeCriterion | Unset_Type - The record_type_criterion of this GsaFindSimilarSearchCriterion. - """ - # Field is not nullable - if record_type_criterion is None: - raise ValueError("Invalid value for 'record_type_criterion', must not be 'None'") - self._record_type_criterion = record_type_criterion - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarSearchCriterion): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_float_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_float_functional_attribute.py index ad5991fa..ce4ef982 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_float_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_float_functional_attribute.py @@ -70,7 +70,6 @@ class GsaFloatFunctionalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_range": "bool", "name": "str", "table": "GsaSlimEntity", @@ -88,7 +87,6 @@ class GsaFloatFunctionalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_range": "isRange", "name": "name", "table": "table", @@ -115,7 +113,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_range: "bool", name: "str", table: "GsaSlimEntity", @@ -135,7 +132,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_range: bool name: str table: GsaSlimEntity @@ -151,7 +147,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder.py index aa64d67d..c9bb5849 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder.py @@ -63,16 +63,12 @@ class GsaFolder(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "has_child_folders": "bool", - "has_files": "bool", "parent_guid": "str", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "has_child_folders": "hasChildFolders", - "has_files": "hasFiles", "parent_guid": "parentGuid", } @@ -85,8 +81,6 @@ def __init__( *, guid: "str", name: "str", - has_child_folders: "bool | Unset_Type" = Unset, - has_files: "bool | Unset_Type" = Unset, parent_guid: "str | None | Unset_Type" = Unset, ) -> None: """GsaFolder - a model defined in Swagger @@ -95,22 +89,14 @@ def __init__( ---------- guid: str name: str - has_child_folders: bool, optional - has_files: bool, optional parent_guid: str | None, optional """ self._parent_guid: str | None | Unset_Type = Unset - self._has_files: bool | Unset_Type = Unset - self._has_child_folders: bool | Unset_Type = Unset self._name: str self._guid: str if parent_guid is not Unset: self.parent_guid = parent_guid - if has_files is not Unset: - self.has_files = has_files - if has_child_folders is not Unset: - self.has_child_folders = has_child_folders self.name = name self.guid = guid @@ -136,56 +122,6 @@ def parent_guid(self, parent_guid: "str | None | Unset_Type") -> None: """ self._parent_guid = parent_guid - @property - def has_files(self) -> "bool | Unset_Type": - """Gets the has_files of this GsaFolder. - - Returns - ------- - bool | Unset_Type - The has_files of this GsaFolder. - """ - return self._has_files - - @has_files.setter - def has_files(self, has_files: "bool | Unset_Type") -> None: - """Sets the has_files of this GsaFolder. - - Parameters - ---------- - has_files: bool | Unset_Type - The has_files of this GsaFolder. - """ - # Field is not nullable - if has_files is None: - raise ValueError("Invalid value for 'has_files', must not be 'None'") - self._has_files = has_files - - @property - def has_child_folders(self) -> "bool | Unset_Type": - """Gets the has_child_folders of this GsaFolder. - - Returns - ------- - bool | Unset_Type - The has_child_folders of this GsaFolder. - """ - return self._has_child_folders - - @has_child_folders.setter - def has_child_folders(self, has_child_folders: "bool | Unset_Type") -> None: - """Sets the has_child_folders of this GsaFolder. - - Parameters - ---------- - has_child_folders: bool | Unset_Type - The has_child_folders of this GsaFolder. - """ - # Field is not nullable - if has_child_folders is None: - raise ValueError("Invalid value for 'has_child_folders', must not be 'None'") - self._has_child_folders = has_child_folders - @property def name(self) -> "str": """Gets the name of this GsaFolder. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_creation_exception.py deleted file mode 100644 index 6cf7ae09..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_creation_exception.py +++ /dev/null @@ -1,268 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderErrorDetail]", - "folder_type": "GsaFolderType", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_type": "folderType", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderErrorDetail] | None | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderErrorDetail] | None, optional - folder_type: GsaFolderType, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFolderCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFolderCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFolderCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFolderCreationException. - """ - self._name = name - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderCreationException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderCreationException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderCreationException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderCreationException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderCreationException. - - Returns - ------- - list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderCreationException. - - Parameters - ---------- - errors: list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_error_reason.py deleted file mode 100644 index 2b4cedc1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderDeletionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ROOT = "root" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_exception.py deleted file mode 100644 index bffa1bfc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_deletion_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderDeletionErrorDetail]", - "folder_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_guid": "folderGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderDeletionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderDeletionErrorDetail] | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderDeletionException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderDeletionErrorDetail] | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderDeletionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaFolderDeletionException. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaFolderDeletionException. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaFolderDeletionException. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaFolderDeletionException. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderDeletionException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderDeletionException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderDeletionException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderDeletionException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderDeletionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderDeletionException. - - Returns - ------- - list[GsaFolderDeletionErrorDetail] | None | Unset_Type - The errors of this GsaFolderDeletionException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderDeletionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderDeletionException. - - Parameters - ---------- - errors: list[GsaFolderDeletionErrorDetail] | None | Unset_Type - The errors of this GsaFolderDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_detail.py deleted file mode 100644 index e7fd1f73..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFolderErrorReason", - } - - discriminator_value_class_map = { - "fileName".lower(): "#/components/schemas/GsaFileNameFolderErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityFolderErrorDetail", - "updateRoot".lower(): "#/components/schemas/GsaUpdateRootFolderErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason", - ) -> None: - """GsaFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - """ - self._message: str - self._reason: GsaFolderErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFolderErrorDetail. - - Returns - ------- - str - The message of this GsaFolderErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFolderErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFolderErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFolderErrorReason": - """Gets the reason of this GsaFolderErrorDetail. - - Returns - ------- - GsaFolderErrorReason - The reason of this GsaFolderErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFolderErrorReason") -> None: - """Sets the reason of this GsaFolderErrorDetail. - - Parameters - ---------- - reason: GsaFolderErrorReason - The reason of this GsaFolderErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_reason.py deleted file mode 100644 index 5d9809f6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FILENAME = "fileName" - NAMEDENTITY = "namedEntity" - UPDATEROOT = "updateRoot" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_detail.py deleted file mode 100644 index e7421763..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_detail.py +++ /dev/null @@ -1,198 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderMoveErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFolderMoveErrorReason", - } - - discriminator_value_class_map = { - "circularReference".lower(): "#/components/schemas/GsaCircularReferenceFolderMoveErrorDetail", - "folderAlreadyExists".lower(): "#/components/schemas/GsaFolderAlreadyExistsFolderMoveErrorDetail", - "noSuchNewParent".lower(): "#/components/schemas/GsaNoSuchNewParentFolderMoveErrorDetail", - "root".lower(): "#/components/schemas/GsaRootFolderMoveErrorDetail", - "sameParent".lower(): "#/components/schemas/GsaSameParentFolderMoveErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason", - ) -> None: - """GsaFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - """ - self._message: str - self._reason: GsaFolderMoveErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFolderMoveErrorDetail. - - Returns - ------- - str - The message of this GsaFolderMoveErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFolderMoveErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFolderMoveErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFolderMoveErrorReason": - """Gets the reason of this GsaFolderMoveErrorDetail. - - Returns - ------- - GsaFolderMoveErrorReason - The reason of this GsaFolderMoveErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFolderMoveErrorReason") -> None: - """Sets the reason of this GsaFolderMoveErrorDetail. - - Parameters - ---------- - reason: GsaFolderMoveErrorReason - The reason of this GsaFolderMoveErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_reason.py deleted file mode 100644 index 3823b119..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_error_reason.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderMoveErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CIRCULARREFERENCE = "circularReference" - FOLDERALREADYEXISTS = "folderAlreadyExists" - NOSUCHNEWPARENT = "noSuchNewParent" - ROOT = "root" - SAMEPARENT = "sameParent" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_exception.py deleted file mode 100644 index f81827fc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_move_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderMoveException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderMoveErrorDetail]", - "folder_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_guid": "folderGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderMoveErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderMoveErrorDetail] | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderMoveException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderMoveErrorDetail] | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderMoveErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderMoveException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderMoveException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderMoveException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderMoveException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderMoveException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderMoveException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderMoveException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderMoveException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaFolderMoveException. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaFolderMoveException. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaFolderMoveException. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaFolderMoveException. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderMoveException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderMoveException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderMoveException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderMoveException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderMoveErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderMoveException. - - Returns - ------- - list[GsaFolderMoveErrorDetail] | None | Unset_Type - The errors of this GsaFolderMoveException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderMoveErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderMoveException. - - Parameters - ---------- - errors: list[GsaFolderMoveErrorDetail] | None | Unset_Type - The errors of this GsaFolderMoveException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderMoveException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_type.py deleted file mode 100644 index 2454afc1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_type.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - HOMEPAGE = "homePage" - HELPPAGE = "helpPage" - EXPORTER = "exporter" - CONFIGURATION = "configuration" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_update_exception.py deleted file mode 100644 index 3829e372..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_update_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderErrorDetail]", - "folder_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_guid": "folderGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderErrorDetail] | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderErrorDetail] | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaFolderUpdateException. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaFolderUpdateException. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaFolderUpdateException. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaFolderUpdateException. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderUpdateException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderUpdateException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderUpdateException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderUpdateException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderUpdateException. - - Returns - ------- - list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderUpdateException. - - Parameters - ---------- - errors: list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_forbid_orphans_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_forbid_orphans_record_link_group_error_detail.py deleted file mode 100644 index a697b76a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_forbid_orphans_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaForbidOrphansRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.FORBIDORPHANS, - ) -> None: - """GsaForbidOrphansRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaForbidOrphansRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_functional_data_default_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_functional_data_default_usage_data_modification_error_detail.py deleted file mode 100644 index e233711f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_functional_data_default_usage_data_modification_error_detail.py +++ /dev/null @@ -1,135 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFunctionalDataDefaultUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.FUNCTIONALDATADEFAULT, - ) -> None: - """GsaFunctionalDataDefaultUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFunctionalDataDefaultUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_general_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_general_unit_equation_error_detail.py deleted file mode 100644 index e19f04cd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_general_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaGeneralUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.GENERAL, - ) -> None: - """GsaGeneralUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaGeneralUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_find_similar_results_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_find_similar_results_response.py deleted file mode 100644 index 12fff769..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_find_similar_results_response.py +++ /dev/null @@ -1,247 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaGetFindSimilarResultsResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "calculation_complete": "bool", - "error": "GsaErrorResponse", - "find_similar_id": "str", - "results": "list[GsaFindSimilarResult]", - } - - attribute_map: dict[str, str] = { - "calculation_complete": "calculationComplete", - "error": "error", - "find_similar_id": "findSimilarId", - "results": "results", - } - - subtype_mapping: dict[str, str] = { - "results": "GsaFindSimilarResult", - "error": "GsaErrorResponse", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - calculation_complete: "bool | Unset_Type" = Unset, - error: "GsaErrorResponse | Unset_Type" = Unset, - find_similar_id: "str | Unset_Type" = Unset, - results: "list[GsaFindSimilarResult] | None | Unset_Type" = Unset, - ) -> None: - """GsaGetFindSimilarResultsResponse - a model defined in Swagger - - Parameters - ---------- - calculation_complete: bool, optional - error: GsaErrorResponse, optional - find_similar_id: str, optional - results: list[GsaFindSimilarResult] | None, optional - """ - self._find_similar_id: str | Unset_Type = Unset - self._calculation_complete: bool | Unset_Type = Unset - self._results: list[GsaFindSimilarResult] | None | Unset_Type = Unset - self._error: GsaErrorResponse | Unset_Type = Unset - - if find_similar_id is not Unset: - self.find_similar_id = find_similar_id - if calculation_complete is not Unset: - self.calculation_complete = calculation_complete - if results is not Unset: - self.results = results - if error is not Unset: - self.error = error - - @property - def find_similar_id(self) -> "str | Unset_Type": - """Gets the find_similar_id of this GsaGetFindSimilarResultsResponse. - The Identifier of the find similar calculation - - Returns - ------- - str | Unset_Type - The find_similar_id of this GsaGetFindSimilarResultsResponse. - """ - return self._find_similar_id - - @find_similar_id.setter - def find_similar_id(self, find_similar_id: "str | Unset_Type") -> None: - """Sets the find_similar_id of this GsaGetFindSimilarResultsResponse. - The Identifier of the find similar calculation - - Parameters - ---------- - find_similar_id: str | Unset_Type - The find_similar_id of this GsaGetFindSimilarResultsResponse. - """ - # Field is not nullable - if find_similar_id is None: - raise ValueError("Invalid value for 'find_similar_id', must not be 'None'") - self._find_similar_id = find_similar_id - - @property - def calculation_complete(self) -> "bool | Unset_Type": - """Gets the calculation_complete of this GsaGetFindSimilarResultsResponse. - Indicates whether the calculation is complete. Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.Results will only be populated if this is true. - - Returns - ------- - bool | Unset_Type - The calculation_complete of this GsaGetFindSimilarResultsResponse. - """ - return self._calculation_complete - - @calculation_complete.setter - def calculation_complete(self, calculation_complete: "bool | Unset_Type") -> None: - """Sets the calculation_complete of this GsaGetFindSimilarResultsResponse. - Indicates whether the calculation is complete. Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.Results will only be populated if this is true. - - Parameters - ---------- - calculation_complete: bool | Unset_Type - The calculation_complete of this GsaGetFindSimilarResultsResponse. - """ - # Field is not nullable - if calculation_complete is None: - raise ValueError("Invalid value for 'calculation_complete', must not be 'None'") - self._calculation_complete = calculation_complete - - @property - def results(self) -> "list[GsaFindSimilarResult] | None | Unset_Type": - """Gets the results of this GsaGetFindSimilarResultsResponse. - Results of the find similar calculation, only set if Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.CalculationComplete is true and Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.Error is not set. - - Returns - ------- - list[GsaFindSimilarResult] | None | Unset_Type - The results of this GsaGetFindSimilarResultsResponse. - """ - return self._results - - @results.setter - def results(self, results: "list[GsaFindSimilarResult] | None | Unset_Type") -> None: - """Sets the results of this GsaGetFindSimilarResultsResponse. - Results of the find similar calculation, only set if Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.CalculationComplete is true and Granta.Server.Api.FindSimilar.GetFindSimilarResultsResponse.Error is not set. - - Parameters - ---------- - results: list[GsaFindSimilarResult] | None | Unset_Type - The results of this GsaGetFindSimilarResultsResponse. - """ - self._results = results - - @property - def error(self) -> "GsaErrorResponse | Unset_Type": - """Gets the error of this GsaGetFindSimilarResultsResponse. - - Returns - ------- - GsaErrorResponse | Unset_Type - The error of this GsaGetFindSimilarResultsResponse. - """ - return self._error - - @error.setter - def error(self, error: "GsaErrorResponse | Unset_Type") -> None: - """Sets the error of this GsaGetFindSimilarResultsResponse. - - Parameters - ---------- - error: GsaErrorResponse | Unset_Type - The error of this GsaGetFindSimilarResultsResponse. - """ - # Field is not nullable - if error is None: - raise ValueError("Invalid value for 'error', must not be 'None'") - self._error = error - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaGetFindSimilarResultsResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_modifiable_record_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_modifiable_record_version_control_exception.py index 17a8bb04..92df4bcd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_modifiable_record_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_modifiable_record_version_control_exception.py @@ -61,21 +61,19 @@ class GsaGetModifiableRecordVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", - "record_version_guid": "str", } attribute_map: dict[str, str] = { "code": "code", "errors": "errors", "message": "message", - "record_version_guid": "recordVersionGuid", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -84,31 +82,26 @@ class GsaGetModifiableRecordVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, ) -> None: """GsaGetModifiableRecordVersionControlException - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional - record_version_guid: str, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._record_version_guid: str | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - if record_version_guid is not Unset: - self.record_version_guid = record_version_guid if errors is not Unset: self.errors = errors @@ -135,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaGetModifiableRecordVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaGetModifiableRecordVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaGetModifiableRecordVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaGetModifiableRecordVersionControlException. """ # Field is not nullable @@ -159,31 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def record_version_guid(self) -> "str | Unset_Type": - """Gets the record_version_guid of this GsaGetModifiableRecordVersionControlException. - - Returns - ------- - str | Unset_Type - The record_version_guid of this GsaGetModifiableRecordVersionControlException. - """ - return self._record_version_guid - - @record_version_guid.setter - def record_version_guid(self, record_version_guid: "str | Unset_Type") -> None: - """Sets the record_version_guid of this GsaGetModifiableRecordVersionControlException. - - Parameters - ---------- - record_version_guid: str | Unset_Type - The record_version_guid of this GsaGetModifiableRecordVersionControlException. - """ - # Field is not nullable - if record_version_guid is None: - raise ValueError("Invalid value for 'record_version_guid', must not be 'None'") - self._record_version_guid = record_version_guid - @property def errors(self) -> "list[GsaVersionControlErrorDetail] | None | Unset_Type": """Gets the errors of this GsaGetModifiableRecordVersionControlException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_conversions_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_conversions_request.py index 8752d799..b8a46ed8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_conversions_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_conversions_request.py @@ -61,15 +61,15 @@ class GsaGetUnitConversionsRequest(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "conversions": "list[GsaUnitConversionSetRequest]", + "source_units": "list[GsaUnitConversionSetRequest]", } attribute_map: dict[str, str] = { - "conversions": "conversions", + "source_units": "sourceUnits", } subtype_mapping: dict[str, str] = { - "conversions": "GsaUnitConversionSetRequest", + "sourceUnits": "GsaUnitConversionSetRequest", } discriminator: Optional[str] = None @@ -77,45 +77,45 @@ class GsaGetUnitConversionsRequest(ModelBase): def __init__( self, *, - conversions: "list[GsaUnitConversionSetRequest]", + source_units: "list[GsaUnitConversionSetRequest]", ) -> None: """GsaGetUnitConversionsRequest - a model defined in Swagger Parameters ---------- - conversions: list[GsaUnitConversionSetRequest] + source_units: list[GsaUnitConversionSetRequest] """ - self._conversions: list[GsaUnitConversionSetRequest] + self._source_units: list[GsaUnitConversionSetRequest] - self.conversions = conversions + self.source_units = source_units @property - def conversions(self) -> "list[GsaUnitConversionSetRequest]": - """Gets the conversions of this GsaGetUnitConversionsRequest. + def source_units(self) -> "list[GsaUnitConversionSetRequest]": + """Gets the source_units of this GsaGetUnitConversionsRequest. Returns ------- list[GsaUnitConversionSetRequest] - The conversions of this GsaGetUnitConversionsRequest. + The source_units of this GsaGetUnitConversionsRequest. """ - return self._conversions + return self._source_units - @conversions.setter - def conversions(self, conversions: "list[GsaUnitConversionSetRequest]") -> None: - """Sets the conversions of this GsaGetUnitConversionsRequest. + @source_units.setter + def source_units(self, source_units: "list[GsaUnitConversionSetRequest]") -> None: + """Sets the source_units of this GsaGetUnitConversionsRequest. Parameters ---------- - conversions: list[GsaUnitConversionSetRequest] - The conversions of this GsaGetUnitConversionsRequest. + source_units: list[GsaUnitConversionSetRequest] + The source_units of this GsaGetUnitConversionsRequest. """ # Field is not nullable - if conversions is None: - raise ValueError("Invalid value for 'conversions', must not be 'None'") + if source_units is None: + raise ValueError("Invalid value for 'source_units', must not be 'None'") # Field is required - if conversions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'conversions', must not be 'Unset'") - self._conversions = conversions + if source_units is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'source_units', must not be 'Unset'") + self._source_units = source_units @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_equivalents_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_equivalents_exception.py deleted file mode 100644 index dad4a8e7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_get_unit_equivalents_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaGetUnitEquivalentsException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaUnitEquivalentErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitEquivalentErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaGetUnitEquivalentsException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaUnitEquivalentErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaGetUnitEquivalentsException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaGetUnitEquivalentsException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaGetUnitEquivalentsException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaGetUnitEquivalentsException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaGetUnitEquivalentsException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaGetUnitEquivalentsException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaGetUnitEquivalentsException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaGetUnitEquivalentsException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaGetUnitEquivalentsException. - - Returns - ------- - list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaGetUnitEquivalentsException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaGetUnitEquivalentsException. - - Parameters - ---------- - errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaGetUnitEquivalentsException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaGetUnitEquivalentsException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_grid.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_grid.py deleted file mode 100644 index 3e47def1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_grid.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaGrid(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "headers": "list[str]", - "rows": "list[list[str]]", - } - - attribute_map: dict[str, str] = { - "headers": "headers", - "rows": "rows", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - headers: "list[str]", - rows: "list[list[str]]", - ) -> None: - """GsaGrid - a model defined in Swagger - - Parameters - ---------- - headers: list[str] - rows: list[list[str]] - """ - self._headers: list[str] - self._rows: list[list[str]] - - self.headers = headers - self.rows = rows - - @property - def headers(self) -> "list[str]": - """Gets the headers of this GsaGrid. - - Returns - ------- - list[str] - The headers of this GsaGrid. - """ - return self._headers - - @headers.setter - def headers(self, headers: "list[str]") -> None: - """Sets the headers of this GsaGrid. - - Parameters - ---------- - headers: list[str] - The headers of this GsaGrid. - """ - # Field is not nullable - if headers is None: - raise ValueError("Invalid value for 'headers', must not be 'None'") - # Field is required - if headers is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'headers', must not be 'Unset'") - self._headers = headers - - @property - def rows(self) -> "list[list[str]]": - """Gets the rows of this GsaGrid. - - Returns - ------- - list[list[str]] - The rows of this GsaGrid. - """ - return self._rows - - @rows.setter - def rows(self, rows: "list[list[str]]") -> None: - """Sets the rows of this GsaGrid. - - Parameters - ---------- - rows: list[list[str]] - The rows of this GsaGrid. - """ - # Field is not nullable - if rows is None: - raise ValueError("Invalid value for 'rows', must not be 'None'") - # Field is required - if rows is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'rows', must not be 'Unset'") - self._rows = rows - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaGrid): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_guid_only_integration_schema_of_object_identifier.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_guid_only_integration_schema_of_object_identifier.py index 69b326de..fb4d7d48 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_guid_only_integration_schema_of_object_identifier.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_guid_only_integration_schema_of_object_identifier.py @@ -67,7 +67,6 @@ class GsaGuidOnlyIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "str", "layouts": "list[GsaGuidOnlyLayout]", "security_groups": "GsaSecurityGroups", - "similarity_settings": "list[GsaSimilaritySettings]", "sources": "list[GsaGuidOnlySourceOfObjectIdentifier]", "unit_system": "str", "version": "int", @@ -80,7 +79,6 @@ class GsaGuidOnlyIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "key", "layouts": "layouts", "security_groups": "securityGroups", - "similarity_settings": "similaritySettings", "sources": "sources", "unit_system": "unitSystem", "version": "version", @@ -92,7 +90,6 @@ class GsaGuidOnlyIntegrationSchemaOfObjectIdentifier(ModelBase): "discreteTypes": "GsaGuidOnlyDiscreteType", "sources": "GsaGuidOnlySourceOfObjectIdentifier", "securityGroups": "GsaSecurityGroups", - "similaritySettings": "GsaSimilaritySettings", } discriminator: Optional[str] = None @@ -106,7 +103,6 @@ def __init__( key: "str | None | Unset_Type" = Unset, layouts: "list[GsaGuidOnlyLayout] | None | Unset_Type" = Unset, security_groups: "GsaSecurityGroups | Unset_Type" = Unset, - similarity_settings: "list[GsaSimilaritySettings] | None | Unset_Type" = Unset, sources: "list[GsaGuidOnlySourceOfObjectIdentifier] | None | Unset_Type" = Unset, unit_system: "str | None | Unset_Type" = Unset, version: "int | None | Unset_Type" = Unset, @@ -121,7 +117,6 @@ def __init__( key: str | None, optional layouts: list[GsaGuidOnlyLayout] | None, optional security_groups: GsaSecurityGroups, optional - similarity_settings: list[GsaSimilaritySettings] | None, optional sources: list[GsaGuidOnlySourceOfObjectIdentifier] | None, optional unit_system: str | None, optional version: int | None, optional @@ -135,7 +130,6 @@ def __init__( self._sources: list[GsaGuidOnlySourceOfObjectIdentifier] | None | Unset_Type = Unset self._access_control_category_values: dict[str, list[str]] | None | Unset_Type = Unset self._security_groups: GsaSecurityGroups | Unset_Type = Unset - self._similarity_settings: list[GsaSimilaritySettings] | None | Unset_Type = Unset if key is not Unset: self.key = key @@ -155,8 +149,6 @@ def __init__( self.access_control_category_values = access_control_category_values if security_groups is not Unset: self.security_groups = security_groups - if similarity_settings is not Unset: - self.similarity_settings = similarity_settings @property def key(self) -> "str | None | Unset_Type": @@ -365,30 +357,6 @@ def security_groups(self, security_groups: "GsaSecurityGroups | Unset_Type") -> raise ValueError("Invalid value for 'security_groups', must not be 'None'") self._security_groups = security_groups - @property - def similarity_settings(self) -> "list[GsaSimilaritySettings] | None | Unset_Type": - """Gets the similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - - Returns - ------- - list[GsaSimilaritySettings] | None | Unset_Type - The similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - """ - return self._similarity_settings - - @similarity_settings.setter - def similarity_settings( - self, similarity_settings: "list[GsaSimilaritySettings] | None | Unset_Type" - ) -> None: - """Sets the similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - - Parameters - ---------- - similarity_settings: list[GsaSimilaritySettings] | None | Unset_Type - The similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - """ - self._similarity_settings = similarity_settings - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_help_paths_validation_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_help_paths_validation_response.py deleted file mode 100644 index fa1a9776..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_help_paths_validation_response.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaHelpPathsValidationResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attributes": "list[GsaSlimAttributeWithHelpPath]", - "parameters": "list[GsaSlimParameterWithHelpPath]", - } - - attribute_map: dict[str, str] = { - "attributes": "attributes", - "parameters": "parameters", - } - - subtype_mapping: dict[str, str] = { - "attributes": "GsaSlimAttributeWithHelpPath", - "parameters": "GsaSlimParameterWithHelpPath", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attributes: "list[GsaSlimAttributeWithHelpPath]", - parameters: "list[GsaSlimParameterWithHelpPath]", - ) -> None: - """GsaHelpPathsValidationResponse - a model defined in Swagger - - Parameters - ---------- - attributes: list[GsaSlimAttributeWithHelpPath] - parameters: list[GsaSlimParameterWithHelpPath] - """ - self._attributes: list[GsaSlimAttributeWithHelpPath] - self._parameters: list[GsaSlimParameterWithHelpPath] - - self.attributes = attributes - self.parameters = parameters - - @property - def attributes(self) -> "list[GsaSlimAttributeWithHelpPath]": - """Gets the attributes of this GsaHelpPathsValidationResponse. - - Returns - ------- - list[GsaSlimAttributeWithHelpPath] - The attributes of this GsaHelpPathsValidationResponse. - """ - return self._attributes - - @attributes.setter - def attributes(self, attributes: "list[GsaSlimAttributeWithHelpPath]") -> None: - """Sets the attributes of this GsaHelpPathsValidationResponse. - - Parameters - ---------- - attributes: list[GsaSlimAttributeWithHelpPath] - The attributes of this GsaHelpPathsValidationResponse. - """ - # Field is not nullable - if attributes is None: - raise ValueError("Invalid value for 'attributes', must not be 'None'") - # Field is required - if attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attributes', must not be 'Unset'") - self._attributes = attributes - - @property - def parameters(self) -> "list[GsaSlimParameterWithHelpPath]": - """Gets the parameters of this GsaHelpPathsValidationResponse. - - Returns - ------- - list[GsaSlimParameterWithHelpPath] - The parameters of this GsaHelpPathsValidationResponse. - """ - return self._parameters - - @parameters.setter - def parameters(self, parameters: "list[GsaSlimParameterWithHelpPath]") -> None: - """Sets the parameters of this GsaHelpPathsValidationResponse. - - Parameters - ---------- - parameters: list[GsaSlimParameterWithHelpPath] - The parameters of this GsaHelpPathsValidationResponse. - """ - # Field is not nullable - if parameters is None: - raise ValueError("Invalid value for 'parameters', must not be 'None'") - # Field is required - if parameters is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'parameters', must not be 'Unset'") - self._parameters = parameters - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaHelpPathsValidationResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_hyperlink_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_hyperlink_attribute.py index fae40071..c697c698 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_hyperlink_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_hyperlink_attribute.py @@ -69,7 +69,6 @@ class GsaHyperlinkAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaHyperlinkAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.HYPERLINK, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_in_use_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_in_use_parameter_value_error_detail.py deleted file mode 100644 index fd731623..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_in_use_parameter_value_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInUseParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "parameter_value_guid": "str", - "used_by_type": "GsaParameterValueUsedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "parameter_value_guid": "parameterValueGuid", - "used_by_type": "usedByType", - } - - subtype_mapping: dict[str, str] = { - "usedByType": "GsaParameterValueUsedByType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.INUSE, - parameter_value_guid: "str | Unset_Type" = Unset, - used_by_type: "GsaParameterValueUsedByType | Unset_Type" = Unset, - ) -> None: - """GsaInUseParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - parameter_value_guid: str, optional - used_by_type: GsaParameterValueUsedByType, optional - """ - super().__init__(message=message, reason=reason) - self._parameter_value_guid: str | Unset_Type = Unset - self._used_by_type: GsaParameterValueUsedByType | Unset_Type = Unset - - if parameter_value_guid is not Unset: - self.parameter_value_guid = parameter_value_guid - if used_by_type is not Unset: - self.used_by_type = used_by_type - - @property - def parameter_value_guid(self) -> "str | Unset_Type": - """Gets the parameter_value_guid of this GsaInUseParameterValueErrorDetail. - - Returns - ------- - str | Unset_Type - The parameter_value_guid of this GsaInUseParameterValueErrorDetail. - """ - return self._parameter_value_guid - - @parameter_value_guid.setter - def parameter_value_guid(self, parameter_value_guid: "str | Unset_Type") -> None: - """Sets the parameter_value_guid of this GsaInUseParameterValueErrorDetail. - - Parameters - ---------- - parameter_value_guid: str | Unset_Type - The parameter_value_guid of this GsaInUseParameterValueErrorDetail. - """ - # Field is not nullable - if parameter_value_guid is None: - raise ValueError("Invalid value for 'parameter_value_guid', must not be 'None'") - self._parameter_value_guid = parameter_value_guid - - @property - def used_by_type(self) -> "GsaParameterValueUsedByType | Unset_Type": - """Gets the used_by_type of this GsaInUseParameterValueErrorDetail. - - Returns - ------- - GsaParameterValueUsedByType | Unset_Type - The used_by_type of this GsaInUseParameterValueErrorDetail. - """ - return self._used_by_type - - @used_by_type.setter - def used_by_type(self, used_by_type: "GsaParameterValueUsedByType | Unset_Type") -> None: - """Sets the used_by_type of this GsaInUseParameterValueErrorDetail. - - Parameters - ---------- - used_by_type: GsaParameterValueUsedByType | Unset_Type - The used_by_type of this GsaInUseParameterValueErrorDetail. - """ - # Field is not nullable - if used_by_type is None: - raise ValueError("Invalid value for 'used_by_type', must not be 'None'") - self._used_by_type = used_by_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInUseParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_inclusiveness.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_inclusiveness.py deleted file mode 100644 index 1e144c33..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_inclusiveness.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaInclusiveness(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - INCLUSIVE = "inclusive" - EXCLUSIVE = "exclusive" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_incompatible_units_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_incompatible_units_error_detail.py deleted file mode 100644 index 373df5ef..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_incompatible_units_error_detail.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaIncompatibleUnitsErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "equivalent_unit_guid": "str", - "unit_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "equivalent_unit_guid": "equivalentUnitGuid", - "unit_guid": "unitGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.INCOMPATIBLEUNITS, - equivalent_unit_guid: "str | Unset_Type" = Unset, - unit_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaIncompatibleUnitsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - equivalent_unit_guid: str, optional - unit_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._unit_guid: str | Unset_Type = Unset - self._equivalent_unit_guid: str | Unset_Type = Unset - - if unit_guid is not Unset: - self.unit_guid = unit_guid - if equivalent_unit_guid is not Unset: - self.equivalent_unit_guid = equivalent_unit_guid - - @property - def unit_guid(self) -> "str | Unset_Type": - """Gets the unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Returns - ------- - str | Unset_Type - The unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - return self._unit_guid - - @unit_guid.setter - def unit_guid(self, unit_guid: "str | Unset_Type") -> None: - """Sets the unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Parameters - ---------- - unit_guid: str | Unset_Type - The unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - # Field is not nullable - if unit_guid is None: - raise ValueError("Invalid value for 'unit_guid', must not be 'None'") - self._unit_guid = unit_guid - - @property - def equivalent_unit_guid(self) -> "str | Unset_Type": - """Gets the equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Returns - ------- - str | Unset_Type - The equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - return self._equivalent_unit_guid - - @equivalent_unit_guid.setter - def equivalent_unit_guid(self, equivalent_unit_guid: "str | Unset_Type") -> None: - """Sets the equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Parameters - ---------- - equivalent_unit_guid: str | Unset_Type - The equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - # Field is not nullable - if equivalent_unit_guid is None: - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'None'") - self._equivalent_unit_guid = equivalent_unit_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaIncompatibleUnitsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_connection_details.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_connection_details.py deleted file mode 100644 index a3fe62ae..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_connection_details.py +++ /dev/null @@ -1,324 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInputConnectionDetails(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "data_source": "str", - "initial_catalog": "str", - "additional_sql_parameters": "str", - "sql_credentials": "GsaSqlCredentials", - "use_configuration_database_credentials": "bool", - "use_integrated_security": "bool", - } - - attribute_map: dict[str, str] = { - "data_source": "dataSource", - "initial_catalog": "initialCatalog", - "additional_sql_parameters": "additionalSqlParameters", - "sql_credentials": "sqlCredentials", - "use_configuration_database_credentials": "useConfigurationDatabaseCredentials", - "use_integrated_security": "useIntegratedSecurity", - } - - subtype_mapping: dict[str, str] = { - "sqlCredentials": "GsaSqlCredentials", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - data_source: "str", - initial_catalog: "str", - additional_sql_parameters: "str | None | Unset_Type" = Unset, - sql_credentials: "GsaSqlCredentials | Unset_Type" = Unset, - use_configuration_database_credentials: "bool | Unset_Type" = Unset, - use_integrated_security: "bool | Unset_Type" = Unset, - ) -> None: - """GsaInputConnectionDetails - a model defined in Swagger - - Parameters - ---------- - data_source: str - initial_catalog: str - additional_sql_parameters: str | None, optional - sql_credentials: GsaSqlCredentials, optional - use_configuration_database_credentials: bool, optional - use_integrated_security: bool, optional - """ - self._data_source: str - self._initial_catalog: str - self._use_configuration_database_credentials: bool | Unset_Type = Unset - self._use_integrated_security: bool | Unset_Type = Unset - self._sql_credentials: GsaSqlCredentials | Unset_Type = Unset - self._additional_sql_parameters: str | None | Unset_Type = Unset - - self.data_source = data_source - self.initial_catalog = initial_catalog - if use_configuration_database_credentials is not Unset: - self.use_configuration_database_credentials = use_configuration_database_credentials - if use_integrated_security is not Unset: - self.use_integrated_security = use_integrated_security - if sql_credentials is not Unset: - self.sql_credentials = sql_credentials - if additional_sql_parameters is not Unset: - self.additional_sql_parameters = additional_sql_parameters - - @property - def data_source(self) -> "str": - """Gets the data_source of this GsaInputConnectionDetails. - The SQL server data source - - Returns - ------- - str - The data_source of this GsaInputConnectionDetails. - """ - return self._data_source - - @data_source.setter - def data_source(self, data_source: "str") -> None: - """Sets the data_source of this GsaInputConnectionDetails. - The SQL server data source - - Parameters - ---------- - data_source: str - The data_source of this GsaInputConnectionDetails. - """ - # Field is not nullable - if data_source is None: - raise ValueError("Invalid value for 'data_source', must not be 'None'") - # Field is required - if data_source is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'data_source', must not be 'Unset'") - self._data_source = data_source - - @property - def initial_catalog(self) -> "str": - """Gets the initial_catalog of this GsaInputConnectionDetails. - The name of the database in SQL server - - Returns - ------- - str - The initial_catalog of this GsaInputConnectionDetails. - """ - return self._initial_catalog - - @initial_catalog.setter - def initial_catalog(self, initial_catalog: "str") -> None: - """Sets the initial_catalog of this GsaInputConnectionDetails. - The name of the database in SQL server - - Parameters - ---------- - initial_catalog: str - The initial_catalog of this GsaInputConnectionDetails. - """ - # Field is not nullable - if initial_catalog is None: - raise ValueError("Invalid value for 'initial_catalog', must not be 'None'") - # Field is required - if initial_catalog is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'initial_catalog', must not be 'Unset'") - self._initial_catalog = initial_catalog - - @property - def use_configuration_database_credentials(self) -> "bool | Unset_Type": - """Gets the use_configuration_database_credentials of this GsaInputConnectionDetails. - Set to true if the SQL connection should use the credentials from the Configuration database. - - Returns - ------- - bool | Unset_Type - The use_configuration_database_credentials of this GsaInputConnectionDetails. - """ - return self._use_configuration_database_credentials - - @use_configuration_database_credentials.setter - def use_configuration_database_credentials( - self, use_configuration_database_credentials: "bool | Unset_Type" - ) -> None: - """Sets the use_configuration_database_credentials of this GsaInputConnectionDetails. - Set to true if the SQL connection should use the credentials from the Configuration database. - - Parameters - ---------- - use_configuration_database_credentials: bool | Unset_Type - The use_configuration_database_credentials of this GsaInputConnectionDetails. - """ - # Field is not nullable - if use_configuration_database_credentials is None: - raise ValueError( - "Invalid value for 'use_configuration_database_credentials', must not be 'None'" - ) - self._use_configuration_database_credentials = use_configuration_database_credentials - - @property - def use_integrated_security(self) -> "bool | Unset_Type": - """Gets the use_integrated_security of this GsaInputConnectionDetails. - Set to true if the SQL connection to the database should use Windows authentication - - Returns - ------- - bool | Unset_Type - The use_integrated_security of this GsaInputConnectionDetails. - """ - return self._use_integrated_security - - @use_integrated_security.setter - def use_integrated_security(self, use_integrated_security: "bool | Unset_Type") -> None: - """Sets the use_integrated_security of this GsaInputConnectionDetails. - Set to true if the SQL connection to the database should use Windows authentication - - Parameters - ---------- - use_integrated_security: bool | Unset_Type - The use_integrated_security of this GsaInputConnectionDetails. - """ - # Field is not nullable - if use_integrated_security is None: - raise ValueError("Invalid value for 'use_integrated_security', must not be 'None'") - self._use_integrated_security = use_integrated_security - - @property - def sql_credentials(self) -> "GsaSqlCredentials | Unset_Type": - """Gets the sql_credentials of this GsaInputConnectionDetails. - - Returns - ------- - GsaSqlCredentials | Unset_Type - The sql_credentials of this GsaInputConnectionDetails. - """ - return self._sql_credentials - - @sql_credentials.setter - def sql_credentials(self, sql_credentials: "GsaSqlCredentials | Unset_Type") -> None: - """Sets the sql_credentials of this GsaInputConnectionDetails. - - Parameters - ---------- - sql_credentials: GsaSqlCredentials | Unset_Type - The sql_credentials of this GsaInputConnectionDetails. - """ - # Field is not nullable - if sql_credentials is None: - raise ValueError("Invalid value for 'sql_credentials', must not be 'None'") - self._sql_credentials = sql_credentials - - @property - def additional_sql_parameters(self) -> "str | None | Unset_Type": - """Gets the additional_sql_parameters of this GsaInputConnectionDetails. - (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. - - Returns - ------- - str | None | Unset_Type - The additional_sql_parameters of this GsaInputConnectionDetails. - """ - return self._additional_sql_parameters - - @additional_sql_parameters.setter - def additional_sql_parameters( - self, additional_sql_parameters: "str | None | Unset_Type" - ) -> None: - """Sets the additional_sql_parameters of this GsaInputConnectionDetails. - (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. - - Parameters - ---------- - additional_sql_parameters: str | None | Unset_Type - The additional_sql_parameters of this GsaInputConnectionDetails. - """ - self._additional_sql_parameters = additional_sql_parameters - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInputConnectionDetails): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_detail.py index c0189241..4dc25879 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_detail.py @@ -62,7 +62,7 @@ class GsaInputValidationErrorDetail(ModelBase): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaInputValidationErrorReason", + "reason": "str", } attribute_map: dict[str, str] = { @@ -70,9 +70,7 @@ class GsaInputValidationErrorDetail(ModelBase): "reason": "reason", } - subtype_mapping: dict[str, str] = { - "reason": "GsaInputValidationErrorReason", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -80,17 +78,17 @@ def __init__( self, *, message: "str", - reason: "GsaInputValidationErrorReason", + reason: "str", ) -> None: """GsaInputValidationErrorDetail - a model defined in Swagger Parameters ---------- message: str - reason: GsaInputValidationErrorReason + reason: str """ self._message: str - self._reason: GsaInputValidationErrorReason + self._reason: str self.message = message self.reason = reason @@ -124,23 +122,23 @@ def message(self, message: "str") -> None: self._message = message @property - def reason(self) -> "GsaInputValidationErrorReason": + def reason(self) -> "str": """Gets the reason of this GsaInputValidationErrorDetail. Returns ------- - GsaInputValidationErrorReason + str The reason of this GsaInputValidationErrorDetail. """ return self._reason @reason.setter - def reason(self, reason: "GsaInputValidationErrorReason") -> None: + def reason(self, reason: "str") -> None: """Sets the reason of this GsaInputValidationErrorDetail. Parameters ---------- - reason: GsaInputValidationErrorReason + reason: str The reason of this GsaInputValidationErrorDetail. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_reason.py deleted file mode 100644 index 24a3c09d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_input_validation_error_reason.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaInputValidationErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNITCONVERSIONDOESNOTEXISTERROR = "UnitConversionDoesNotExistError" - INPUTISNULLOREMPTY = "InputIsNullOrEmpty" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_attribute.py index d1ff4137..aed314e2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_attribute.py @@ -69,7 +69,6 @@ class GsaIntegerAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_unique": "bool", "name": "str", "table": "GsaSlimEntity", @@ -85,7 +84,6 @@ class GsaIntegerAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_unique": "isUnique", "name": "name", "table": "table", @@ -107,7 +105,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_unique: "bool", name: "str", table: "GsaSlimEntity", @@ -125,7 +122,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_unique: bool name: str table: GsaSlimEntity @@ -140,7 +136,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_chart_data.py deleted file mode 100644 index c909ba8e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integer_chart_data.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaIntegerChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "record_version_guid": "str", - "value": "int", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "record_version_guid": "recordVersionGuid", - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.INTEGER, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - value: "int | Unset_Type" = Unset, - ) -> None: - """GsaIntegerChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - record_version_guid: str, optional - value: int, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._value: int | Unset_Type = Unset - - if value is not Unset: - self.value = value - - @property - def value(self) -> "int | Unset_Type": - """Gets the value of this GsaIntegerChartData. - - Returns - ------- - int | Unset_Type - The value of this GsaIntegerChartData. - """ - return self._value - - @value.setter - def value(self, value: "int | Unset_Type") -> None: - """Sets the value of this GsaIntegerChartData. - - Parameters - ---------- - value: int | Unset_Type - The value of this GsaIntegerChartData. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - self._value = value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaIntegerChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_generation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_generation_error_detail.py index fa2fae31..ee3aac93 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_generation_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_generation_error_detail.py @@ -62,7 +62,7 @@ class GsaIntegrationSchemaGenerationErrorDetail(ModelBase): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaSchemaGenerationWarningReason", + "reason": "str", } attribute_map: dict[str, str] = { @@ -70,9 +70,7 @@ class GsaIntegrationSchemaGenerationErrorDetail(ModelBase): "reason": "reason", } - subtype_mapping: dict[str, str] = { - "reason": "GsaSchemaGenerationWarningReason", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -80,17 +78,17 @@ def __init__( self, *, message: "str", - reason: "GsaSchemaGenerationWarningReason", + reason: "str", ) -> None: """GsaIntegrationSchemaGenerationErrorDetail - a model defined in Swagger Parameters ---------- message: str - reason: GsaSchemaGenerationWarningReason + reason: str """ self._message: str - self._reason: GsaSchemaGenerationWarningReason + self._reason: str self.message = message self.reason = reason @@ -124,23 +122,23 @@ def message(self, message: "str") -> None: self._message = message @property - def reason(self) -> "GsaSchemaGenerationWarningReason": + def reason(self) -> "str": """Gets the reason of this GsaIntegrationSchemaGenerationErrorDetail. Returns ------- - GsaSchemaGenerationWarningReason + str The reason of this GsaIntegrationSchemaGenerationErrorDetail. """ return self._reason @reason.setter - def reason(self, reason: "GsaSchemaGenerationWarningReason") -> None: + def reason(self, reason: "str") -> None: """Sets the reason of this GsaIntegrationSchemaGenerationErrorDetail. Parameters ---------- - reason: GsaSchemaGenerationWarningReason + reason: str The reason of this GsaIntegrationSchemaGenerationErrorDetail. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_of_object_identifier.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_of_object_identifier.py index cb247438..7ee08d98 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_of_object_identifier.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_integration_schema_of_object_identifier.py @@ -67,7 +67,6 @@ class GsaIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "str", "layouts": "list[GsaIntegrationLayout]", "security_groups": "GsaSecurityGroups", - "similarity_settings": "list[GsaSimilaritySettings]", "sources": "list[GsaSourceOfObjectIdentifier]", "unit_system": "str", "version": "int", @@ -80,7 +79,6 @@ class GsaIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "key", "layouts": "layouts", "security_groups": "securityGroups", - "similarity_settings": "similaritySettings", "sources": "sources", "unit_system": "unitSystem", "version": "version", @@ -92,7 +90,6 @@ class GsaIntegrationSchemaOfObjectIdentifier(ModelBase): "discreteTypes": "GsaIntegrationDiscreteType", "sources": "GsaSourceOfObjectIdentifier", "securityGroups": "GsaSecurityGroups", - "similaritySettings": "GsaSimilaritySettings", } discriminator: Optional[str] = None @@ -106,7 +103,6 @@ def __init__( key: "str | None | Unset_Type" = Unset, layouts: "list[GsaIntegrationLayout] | None | Unset_Type" = Unset, security_groups: "GsaSecurityGroups | Unset_Type" = Unset, - similarity_settings: "list[GsaSimilaritySettings] | None | Unset_Type" = Unset, sources: "list[GsaSourceOfObjectIdentifier] | None | Unset_Type" = Unset, unit_system: "str | None | Unset_Type" = Unset, version: "int | None | Unset_Type" = Unset, @@ -121,7 +117,6 @@ def __init__( key: str | None, optional layouts: list[GsaIntegrationLayout] | None, optional security_groups: GsaSecurityGroups, optional - similarity_settings: list[GsaSimilaritySettings] | None, optional sources: list[GsaSourceOfObjectIdentifier] | None, optional unit_system: str | None, optional version: int | None, optional @@ -135,7 +130,6 @@ def __init__( self._sources: list[GsaSourceOfObjectIdentifier] | None | Unset_Type = Unset self._access_control_category_values: dict[str, list[str]] | None | Unset_Type = Unset self._security_groups: GsaSecurityGroups | Unset_Type = Unset - self._similarity_settings: list[GsaSimilaritySettings] | None | Unset_Type = Unset if key is not Unset: self.key = key @@ -155,8 +149,6 @@ def __init__( self.access_control_category_values = access_control_category_values if security_groups is not Unset: self.security_groups = security_groups - if similarity_settings is not Unset: - self.similarity_settings = similarity_settings @property def key(self) -> "str | None | Unset_Type": @@ -363,30 +355,6 @@ def security_groups(self, security_groups: "GsaSecurityGroups | Unset_Type") -> raise ValueError("Invalid value for 'security_groups', must not be 'None'") self._security_groups = security_groups - @property - def similarity_settings(self) -> "list[GsaSimilaritySettings] | None | Unset_Type": - """Gets the similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - - Returns - ------- - list[GsaSimilaritySettings] | None | Unset_Type - The similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - """ - return self._similarity_settings - - @similarity_settings.setter - def similarity_settings( - self, similarity_settings: "list[GsaSimilaritySettings] | None | Unset_Type" - ) -> None: - """Sets the similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - - Parameters - ---------- - similarity_settings: list[GsaSimilaritySettings] | None | Unset_Type - The similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - """ - self._similarity_settings = similarity_settings - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_equivalence_target_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_equivalence_target_error_detail.py deleted file mode 100644 index 3d315370..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_equivalence_target_error_detail.py +++ /dev/null @@ -1,261 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInvalidEquivalenceTargetErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "equivalent_of_equivalent_unit_guid": "str", - "equivalent_unit_guid": "str", - "unit_guid": "str", - "unit_system_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "equivalent_of_equivalent_unit_guid": "equivalentOfEquivalentUnitGuid", - "equivalent_unit_guid": "equivalentUnitGuid", - "unit_guid": "unitGuid", - "unit_system_guid": "unitSystemGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.INVALIDEQUIVALENCETARGET, - equivalent_of_equivalent_unit_guid: "str | Unset_Type" = Unset, - equivalent_unit_guid: "str | Unset_Type" = Unset, - unit_guid: "str | Unset_Type" = Unset, - unit_system_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaInvalidEquivalenceTargetErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - equivalent_of_equivalent_unit_guid: str, optional - equivalent_unit_guid: str, optional - unit_guid: str, optional - unit_system_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._unit_guid: str | Unset_Type = Unset - self._unit_system_guid: str | Unset_Type = Unset - self._equivalent_unit_guid: str | Unset_Type = Unset - self._equivalent_of_equivalent_unit_guid: str | Unset_Type = Unset - - if unit_guid is not Unset: - self.unit_guid = unit_guid - if unit_system_guid is not Unset: - self.unit_system_guid = unit_system_guid - if equivalent_unit_guid is not Unset: - self.equivalent_unit_guid = equivalent_unit_guid - if equivalent_of_equivalent_unit_guid is not Unset: - self.equivalent_of_equivalent_unit_guid = equivalent_of_equivalent_unit_guid - - @property - def unit_guid(self) -> "str | Unset_Type": - """Gets the unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._unit_guid - - @unit_guid.setter - def unit_guid(self, unit_guid: "str | Unset_Type") -> None: - """Sets the unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - unit_guid: str | Unset_Type - The unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if unit_guid is None: - raise ValueError("Invalid value for 'unit_guid', must not be 'None'") - self._unit_guid = unit_guid - - @property - def unit_system_guid(self) -> "str | Unset_Type": - """Gets the unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._unit_system_guid - - @unit_system_guid.setter - def unit_system_guid(self, unit_system_guid: "str | Unset_Type") -> None: - """Sets the unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - unit_system_guid: str | Unset_Type - The unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if unit_system_guid is None: - raise ValueError("Invalid value for 'unit_system_guid', must not be 'None'") - self._unit_system_guid = unit_system_guid - - @property - def equivalent_unit_guid(self) -> "str | Unset_Type": - """Gets the equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._equivalent_unit_guid - - @equivalent_unit_guid.setter - def equivalent_unit_guid(self, equivalent_unit_guid: "str | Unset_Type") -> None: - """Sets the equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - equivalent_unit_guid: str | Unset_Type - The equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if equivalent_unit_guid is None: - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'None'") - self._equivalent_unit_guid = equivalent_unit_guid - - @property - def equivalent_of_equivalent_unit_guid(self) -> "str | Unset_Type": - """Gets the equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._equivalent_of_equivalent_unit_guid - - @equivalent_of_equivalent_unit_guid.setter - def equivalent_of_equivalent_unit_guid( - self, equivalent_of_equivalent_unit_guid: "str | Unset_Type" - ) -> None: - """Sets the equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - equivalent_of_equivalent_unit_guid: str | Unset_Type - The equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if equivalent_of_equivalent_unit_guid is None: - raise ValueError( - "Invalid value for 'equivalent_of_equivalent_unit_guid', must not be 'None'" - ) - self._equivalent_of_equivalent_unit_guid = equivalent_of_equivalent_unit_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInvalidEquivalenceTargetErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_exchange_rate_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_exchange_rate_currency_error_detail.py deleted file mode 100644 index 24a0f6de..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_exchange_rate_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInvalidExchangeRateCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.INVALIDEXCHANGERATE, - ) -> None: - """GsaInvalidExchangeRateCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInvalidExchangeRateCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_parent_state_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_parent_state_error_detail.py index 6171c422..31080e42 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_parent_state_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_parent_state_error_detail.py @@ -36,9 +36,6 @@ from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_detail import ( # noqa: F401 GsaVersionControlErrorDetail, ) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_reason import ( - GsaVersionControlErrorReason, -) from . import ModelBase, Unset, Unset_Type @@ -69,7 +66,7 @@ class GsaInvalidParentStateErrorDetail(GsaVersionControlErrorDetail): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaVersionControlErrorReason", + "reason": "str", } attribute_map: dict[str, str] = { @@ -85,14 +82,14 @@ def __init__( self, *, message: "str", - reason: "GsaVersionControlErrorReason" = GsaVersionControlErrorReason.INVALIDPARENTSTATE, + reason: "str" = "invalidParentState", ) -> None: """GsaInvalidParentStateErrorDetail - a model defined in Swagger Parameters ---------- message: str - reason: GsaVersionControlErrorReason + reason: str """ super().__init__(message=message, reason=reason) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_version_state_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_version_state_error_detail.py index 79aac1f4..89263187 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_version_state_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_invalid_version_state_error_detail.py @@ -36,9 +36,6 @@ from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_detail import ( # noqa: F401 GsaVersionControlErrorDetail, ) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_reason import ( - GsaVersionControlErrorReason, -) from . import ModelBase, Unset, Unset_Type @@ -69,7 +66,7 @@ class GsaInvalidVersionStateErrorDetail(GsaVersionControlErrorDetail): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaVersionControlErrorReason", + "reason": "str", "version_state": "GsaVersionState", } @@ -89,7 +86,7 @@ def __init__( self, *, message: "str", - reason: "GsaVersionControlErrorReason" = GsaVersionControlErrorReason.INVALIDVERSIONSTATE, + reason: "str" = "invalidVersionState", version_state: "GsaVersionState | Unset_Type" = Unset, ) -> None: """GsaInvalidVersionStateErrorDetail - a model defined in Swagger @@ -97,7 +94,7 @@ def __init__( Parameters ---------- message: str - reason: GsaVersionControlErrorReason + reason: str version_state: GsaVersionState, optional """ super().__init__(message=message, reason=reason) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout.py index 8f34cd94..6433a2f0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout.py @@ -174,7 +174,6 @@ def applicable_applications(self, applicable_applications: "list[str]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -186,7 +185,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_attribute_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_attribute_item.py index bdc5e531..f4e09785 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_attribute_item.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_attribute_item.py @@ -67,7 +67,6 @@ class GsaLayoutAttributeItem(GsaLayoutItem): """ swagger_types: dict[str, str] = { "attribute_type": "GsaAttributeType", - "display_names": "dict(str, str)", "guid": "str", "item_type": "GsaLayoutItemType", "name": "str", @@ -80,7 +79,6 @@ class GsaLayoutAttributeItem(GsaLayoutItem): attribute_map: dict[str, str] = { "attribute_type": "attributeType", - "display_names": "displayNames", "guid": "guid", "item_type": "itemType", "name": "name", @@ -103,7 +101,6 @@ def __init__( self, *, attribute_type: "GsaAttributeType", - display_names: "dict[str, str]", guid: "str", item_type: "GsaLayoutItemType" = GsaLayoutItemType.ATTRIBUTE, name: "str", @@ -118,7 +115,6 @@ def __init__( Parameters ---------- attribute_type: GsaAttributeType - display_names: dict[str, str] guid: str item_type: GsaLayoutItemType name: str @@ -129,11 +125,7 @@ def __init__( tabular_columns: list[GsaLayoutTabularColumn] | None, optional """ super().__init__( - display_names=display_names, - guid=guid, - item_type=item_type, - name=name, - underlying_entity_guid=underlying_entity_guid, + guid=guid, item_type=item_type, name=name, underlying_entity_guid=underlying_entity_guid ) self._attribute_type: GsaAttributeType self._required: bool diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_item.py index 76a72184..25f4f203 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_item.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_item.py @@ -63,7 +63,6 @@ class GsaLayoutItem(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", "guid": "str", "item_type": "GsaLayoutItemType", "name": "str", @@ -71,7 +70,6 @@ class GsaLayoutItem(ModelBase): } attribute_map: dict[str, str] = { - "display_names": "displayNames", "guid": "guid", "item_type": "itemType", "name": "name", @@ -92,7 +90,6 @@ class GsaLayoutItem(ModelBase): def __init__( self, *, - display_names: "dict[str, str]", guid: "str", item_type: "GsaLayoutItemType", name: "str", @@ -102,7 +99,6 @@ def __init__( Parameters ---------- - display_names: dict[str, str] guid: str item_type: GsaLayoutItemType name: str @@ -110,13 +106,11 @@ def __init__( """ self._item_type: GsaLayoutItemType self._underlying_entity_guid: str - self._display_names: dict[str, str] self._name: str self._guid: str self.item_type = item_type self.underlying_entity_guid = underlying_entity_guid - self.display_names = display_names self.name = name self.guid = guid @@ -176,36 +170,6 @@ def underlying_entity_guid(self, underlying_entity_guid: "str") -> None: raise ValueError("Invalid value for 'underlying_entity_guid', must not be 'Unset'") self._underlying_entity_guid = underlying_entity_guid - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaLayoutItem. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaLayoutItem. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaLayoutItem. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaLayoutItem. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - @property def name(self) -> "str": """Gets the name of this GsaLayoutItem. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_link_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_link_item.py index 8cff9e4f..16526bfe 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_link_item.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_link_item.py @@ -66,7 +66,6 @@ class GsaLayoutLinkItem(GsaLayoutItem): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", "forwards": "bool", "guid": "str", "item_type": "GsaLayoutItemType", @@ -80,7 +79,6 @@ class GsaLayoutLinkItem(GsaLayoutItem): } attribute_map: dict[str, str] = { - "display_names": "displayNames", "forwards": "forwards", "guid": "guid", "item_type": "itemType", @@ -103,7 +101,6 @@ class GsaLayoutLinkItem(GsaLayoutItem): def __init__( self, *, - display_names: "dict[str, str]", forwards: "bool", guid: "str", item_type: "GsaLayoutItemType" = GsaLayoutItemType.LINK, @@ -119,7 +116,6 @@ def __init__( Parameters ---------- - display_names: dict[str, str] forwards: bool guid: str item_type: GsaLayoutItemType @@ -132,11 +128,7 @@ def __init__( target_database_version: str | None, optional """ super().__init__( - display_names=display_names, - guid=guid, - item_type=item_type, - name=name, - underlying_entity_guid=underlying_entity_guid, + guid=guid, item_type=item_type, name=name, underlying_entity_guid=underlying_entity_guid ) self._link_type: GsaLayoutItemLinkType self._target_database: str | None | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_section.py index 4cd9652e..72148063 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_section.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_layout_section.py @@ -145,7 +145,6 @@ def section_detail_type(self, section_detail_type: "GsaLayoutSectionDetailType") @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaLayoutSection. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -157,7 +156,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaLayoutSection. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_attribute_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_attribute_type.py index b8356a8a..10902112 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_attribute_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_attribute_type.py @@ -44,5 +44,5 @@ class GsaLinkAttributeType(Enum): """ RECORDLINK = "recordLink" CROSSDATABASELINK = "crossDatabaseLink" - SMARTLINK = "smartLink" + DYNAMICLINK = "dynamicLink" TABULARATTRIBUTE = "tabularAttribute" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_target.py index 5b1227c1..8f1f3c2d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_target.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link_target.py @@ -61,15 +61,15 @@ class GsaLinkTarget(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "table_guid": "str", "database_guid": "str", "database_version_guid": "str", + "table_guid": "str", } attribute_map: dict[str, str] = { - "table_guid": "tableGuid", "database_guid": "databaseGuid", "database_version_guid": "databaseVersionGuid", + "table_guid": "tableGuid", } subtype_mapping: dict[str, str] = {} @@ -79,32 +79,32 @@ class GsaLinkTarget(ModelBase): def __init__( self, *, - table_guid: "str", database_guid: "str | None | Unset_Type" = Unset, database_version_guid: "str | None | Unset_Type" = Unset, + table_guid: "str | None | Unset_Type" = Unset, ) -> None: """GsaLinkTarget - a model defined in Swagger Parameters ---------- - table_guid: str database_guid: str | None, optional database_version_guid: str | None, optional + table_guid: str | None, optional """ self._database_guid: str | None | Unset_Type = Unset self._database_version_guid: str | None | Unset_Type = Unset - self._table_guid: str + self._table_guid: str | None | Unset_Type = Unset if database_guid is not Unset: self.database_guid = database_guid if database_version_guid is not Unset: self.database_version_guid = database_version_guid - self.table_guid = table_guid + if table_guid is not Unset: + self.table_guid = table_guid @property def database_guid(self) -> "str | None | Unset_Type": """Gets the database_guid of this GsaLinkTarget. - Gets the guid of the database that this link group is referencing. If `null` it means match any database with a matching table (only the case for cross database links) Returns ------- @@ -116,7 +116,6 @@ def database_guid(self) -> "str | None | Unset_Type": @database_guid.setter def database_guid(self, database_guid: "str | None | Unset_Type") -> None: """Sets the database_guid of this GsaLinkTarget. - Gets the guid of the database that this link group is referencing. If `null` it means match any database with a matching table (only the case for cross database links) Parameters ---------- @@ -128,7 +127,6 @@ def database_guid(self, database_guid: "str | None | Unset_Type") -> None: @property def database_version_guid(self) -> "str | None | Unset_Type": """Gets the database_version_guid of this GsaLinkTarget. - Database version GUID. Null for forwards cross database link targets. Returns ------- @@ -140,7 +138,6 @@ def database_version_guid(self) -> "str | None | Unset_Type": @database_version_guid.setter def database_version_guid(self, database_version_guid: "str | None | Unset_Type") -> None: """Sets the database_version_guid of this GsaLinkTarget. - Database version GUID. Null for forwards cross database link targets. Parameters ---------- @@ -150,31 +147,25 @@ def database_version_guid(self, database_version_guid: "str | None | Unset_Type" self._database_version_guid = database_version_guid @property - def table_guid(self) -> "str": + def table_guid(self) -> "str | None | Unset_Type": """Gets the table_guid of this GsaLinkTarget. Returns ------- - str + str | None | Unset_Type The table_guid of this GsaLinkTarget. """ return self._table_guid @table_guid.setter - def table_guid(self, table_guid: "str") -> None: + def table_guid(self, table_guid: "str | None | Unset_Type") -> None: """Sets the table_guid of this GsaLinkTarget. Parameters ---------- - table_guid: str + table_guid: str | None | Unset_Type The table_guid of this GsaLinkTarget. """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") self._table_guid = table_guid @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_attribute_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_attribute_tabular_column.py index 69479b49..469bc640 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_attribute_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_attribute_tabular_column.py @@ -73,13 +73,11 @@ class GsaLinkedAttributeTabularColumn(GsaTabularColumn): "guid": "str", "linked_attribute": "GsaSlimAttribute", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLinkedAttributeTabularColumn(GsaTabularColumn): "guid": "guid", "linked_attribute": "linkedAttribute", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( guid: "str", linked_attribute: "GsaSlimAttribute", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLinkedAttributeTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( guid: str linked_attribute: GsaSlimAttribute name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._linked_attribute: GsaSlimAttribute diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_column_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_column_tabular_column.py index 034cedb4..4206ca6d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_column_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_column_tabular_column.py @@ -74,13 +74,11 @@ class GsaLinkedColumnTabularColumn(GsaTabularColumn): "linked_attribute": "GsaSlimAttribute", "linked_column": "GsaTabularColumn", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", "linked_target": "GsaTabularAttributeTarget", } @@ -91,13 +89,11 @@ class GsaLinkedColumnTabularColumn(GsaTabularColumn): "linked_attribute": "linkedAttribute", "linked_column": "linkedColumn", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", "linked_target": "linkedTarget", } @@ -118,13 +114,11 @@ def __init__( linked_attribute: "GsaSlimAttribute", linked_column: "GsaTabularColumn", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", linked_target: "GsaTabularAttributeTarget | Unset_Type" = Unset, ) -> None: """GsaLinkedColumnTabularColumn - a model defined in Swagger @@ -137,13 +131,11 @@ def __init__( linked_attribute: GsaSlimAttribute linked_column: GsaTabularColumn name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] linked_target: GsaTabularAttributeTarget, optional """ super().__init__( @@ -151,13 +143,11 @@ def __init__( display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._linked_attribute: GsaSlimAttribute self._linked_column: GsaTabularColumn diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_record_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_record_tabular_column.py index eb2af643..3e02f815 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_record_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linked_record_tabular_column.py @@ -72,13 +72,11 @@ class GsaLinkedRecordTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -86,13 +84,11 @@ class GsaLinkedRecordTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = {} @@ -106,13 +102,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLinkedRecordTabularColumn - a model defined in Swagger @@ -122,26 +116,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linking_value_exists_datum_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linking_value_exists_datum_criterion.py index 7bc832a3..4b372946 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linking_value_exists_datum_criterion.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_linking_value_exists_datum_criterion.py @@ -88,7 +88,7 @@ class GsaLinkingValueExistsDatumCriterion(GsaDatumCriterion): def __init__( self, *, - type: "GsaDatumCriterionType" = GsaDatumCriterionType.SMARTLINKINGVALUE, + type: "GsaDatumCriterionType" = GsaDatumCriterionType.DYNAMICLINKINGVALUE, attribute_type: "GsaAttributeType | Unset_Type" = Unset, inner_hits_identifier: "str | Unset_Type" = Unset, ) -> None: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_links_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_links_info.py index fde7bf1e..760617df 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_links_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_links_info.py @@ -61,7 +61,7 @@ class GsaLinksInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "links": "list[GsaLink]", + "links": "list[GsaResolvedLink]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaLinksInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "links": "GsaLink", + "links": "GsaResolvedLink", } discriminator: Optional[str] = None @@ -77,36 +77,36 @@ class GsaLinksInfo(ModelBase): def __init__( self, *, - links: "list[GsaLink]", + links: "list[GsaResolvedLink]", ) -> None: """GsaLinksInfo - a model defined in Swagger Parameters ---------- - links: list[GsaLink] + links: list[GsaResolvedLink] """ - self._links: list[GsaLink] + self._links: list[GsaResolvedLink] self.links = links @property - def links(self) -> "list[GsaLink]": + def links(self) -> "list[GsaResolvedLink]": """Gets the links of this GsaLinksInfo. Returns ------- - list[GsaLink] + list[GsaResolvedLink] The links of this GsaLinksInfo. """ return self._links @links.setter - def links(self, links: "list[GsaLink]") -> None: + def links(self, links: "list[GsaResolvedLink]") -> None: """Sets the links of this GsaLinksInfo. Parameters ---------- - links: list[GsaLink] + links: list[GsaResolvedLink] The links of this GsaLinksInfo. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_date_time_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_date_time_tabular_column.py index 55155633..d2eceaf2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_date_time_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_date_time_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalDateTimeTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalDateTimeTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalDateTimeTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_discrete_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_discrete_tabular_column.py index da79f389..37f05d46 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_discrete_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_discrete_tabular_column.py @@ -74,13 +74,11 @@ class GsaLocalDiscreteTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -90,13 +88,11 @@ class GsaLocalDiscreteTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -115,13 +111,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalDiscreteTabularColumn - a model defined in Swagger @@ -133,26 +127,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType self._discrete_type: GsaSlimNamedEntity diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_file_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_file_tabular_column.py index 19589b90..f740b67f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_file_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_file_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalFileTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalFileTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalFileTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_hyperlink_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_hyperlink_tabular_column.py index 1a878b99..07b5aa9c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_hyperlink_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_hyperlink_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalHyperlinkTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalHyperlinkTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalHyperlinkTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_integer_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_integer_tabular_column.py index 3cdb966e..cee0c656 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_integer_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_integer_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalIntegerTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalIntegerTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalIntegerTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_logical_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_logical_tabular_column.py index 7b5a83b8..574201ab 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_logical_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_logical_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalLogicalTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalLogicalTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalLogicalTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_long_text_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_long_text_tabular_column.py index c6658fb7..e6ddab90 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_long_text_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_long_text_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalLongTextTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalLongTextTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalLongTextTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_picture_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_picture_tabular_column.py index ede19e64..bb09d274 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_picture_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_picture_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalPictureTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalPictureTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalPictureTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_point_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_point_tabular_column.py index 6a91a972..67af3ae4 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_point_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_point_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalPointTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", "unit": "GsaSlimUnit", } @@ -89,13 +87,11 @@ class GsaLocalPointTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", "unit": "unit", } @@ -114,13 +110,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: """GsaLocalPointTabularColumn - a model defined in Swagger @@ -132,13 +126,11 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] unit: GsaSlimUnit, optional """ super().__init__( @@ -146,13 +138,11 @@ def __init__( display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType self._unit: GsaSlimUnit | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_range_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_range_tabular_column.py index 9bec060c..f0607754 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_range_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_range_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalRangeTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", "unit": "GsaSlimUnit", } @@ -89,13 +87,11 @@ class GsaLocalRangeTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", "unit": "unit", } @@ -114,13 +110,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: """GsaLocalRangeTabularColumn - a model defined in Swagger @@ -132,13 +126,11 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] unit: GsaSlimUnit, optional """ super().__init__( @@ -146,13 +138,11 @@ def __init__( display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType self._unit: GsaSlimUnit | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_short_text_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_short_text_tabular_column.py index e3a53e75..450ef3bc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_short_text_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_local_short_text_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalShortTextTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalShortTextTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalShortTextTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_log_scale_negative_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_log_scale_negative_parameter_value_error_detail.py deleted file mode 100644 index 7455ea26..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_log_scale_negative_parameter_value_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaLogScaleNegativeParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.LOGSCALENEGATIVE, - ) -> None: - """GsaLogScaleNegativeParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaLogScaleNegativeParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_attribute.py index 28114c78..64a9548f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_attribute.py @@ -69,7 +69,6 @@ class GsaLogicalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaLogicalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.LOGICAL, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_chart_data.py deleted file mode 100644 index 5f4031f0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_logical_chart_data.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaLogicalChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "record_version_guid": "str", - "value": "bool", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "record_version_guid": "recordVersionGuid", - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.LOGICAL, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - value: "bool | Unset_Type" = Unset, - ) -> None: - """GsaLogicalChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - record_version_guid: str, optional - value: bool, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._value: bool | Unset_Type = Unset - - if value is not Unset: - self.value = value - - @property - def value(self) -> "bool | Unset_Type": - """Gets the value of this GsaLogicalChartData. - - Returns - ------- - bool | Unset_Type - The value of this GsaLogicalChartData. - """ - return self._value - - @value.setter - def value(self, value: "bool | Unset_Type") -> None: - """Sets the value of this GsaLogicalChartData. - - Parameters - ---------- - value: bool | Unset_Type - The value of this GsaLogicalChartData. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - self._value = value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaLogicalChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation.py deleted file mode 100644 index 1477bb67..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation.py +++ /dev/null @@ -1,309 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaLongRunningOperation(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "identifier": "str", - "status": "GsaLongRunningStatus", - "http_status_code": "int", - "number_of_completed_tasks": "float", - "number_of_tasks": "int", - "response": "object", - } - - attribute_map: dict[str, str] = { - "identifier": "identifier", - "status": "status", - "http_status_code": "httpStatusCode", - "number_of_completed_tasks": "numberOfCompletedTasks", - "number_of_tasks": "numberOfTasks", - "response": "response", - } - - subtype_mapping: dict[str, str] = { - "status": "GsaLongRunningStatus", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - identifier: "str", - status: "GsaLongRunningStatus", - http_status_code: "int | None | Unset_Type" = Unset, - number_of_completed_tasks: "float | None | Unset_Type" = Unset, - number_of_tasks: "int | None | Unset_Type" = Unset, - response: "object | None | Unset_Type" = Unset, - ) -> None: - """GsaLongRunningOperation - a model defined in Swagger - - Parameters - ---------- - identifier: str - status: GsaLongRunningStatus - http_status_code: int | None, optional - number_of_completed_tasks: float | None, optional - number_of_tasks: int | None, optional - response: object | None, optional - """ - self._identifier: str - self._status: GsaLongRunningStatus - self._number_of_completed_tasks: float | None | Unset_Type = Unset - self._number_of_tasks: int | None | Unset_Type = Unset - self._http_status_code: int | None | Unset_Type = Unset - self._response: object | None | Unset_Type = Unset - - self.identifier = identifier - self.status = status - if number_of_completed_tasks is not Unset: - self.number_of_completed_tasks = number_of_completed_tasks - if number_of_tasks is not Unset: - self.number_of_tasks = number_of_tasks - if http_status_code is not Unset: - self.http_status_code = http_status_code - if response is not Unset: - self.response = response - - @property - def identifier(self) -> "str": - """Gets the identifier of this GsaLongRunningOperation. - - Returns - ------- - str - The identifier of this GsaLongRunningOperation. - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier: "str") -> None: - """Sets the identifier of this GsaLongRunningOperation. - - Parameters - ---------- - identifier: str - The identifier of this GsaLongRunningOperation. - """ - # Field is not nullable - if identifier is None: - raise ValueError("Invalid value for 'identifier', must not be 'None'") - # Field is required - if identifier is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'identifier', must not be 'Unset'") - self._identifier = identifier - - @property - def status(self) -> "GsaLongRunningStatus": - """Gets the status of this GsaLongRunningOperation. - - Returns - ------- - GsaLongRunningStatus - The status of this GsaLongRunningOperation. - """ - return self._status - - @status.setter - def status(self, status: "GsaLongRunningStatus") -> None: - """Sets the status of this GsaLongRunningOperation. - - Parameters - ---------- - status: GsaLongRunningStatus - The status of this GsaLongRunningOperation. - """ - # Field is not nullable - if status is None: - raise ValueError("Invalid value for 'status', must not be 'None'") - # Field is required - if status is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'status', must not be 'Unset'") - self._status = status - - @property - def number_of_completed_tasks(self) -> "float | None | Unset_Type": - """Gets the number_of_completed_tasks of this GsaLongRunningOperation. - The total number of tasks that have been completed so far. May be null if the tasks are not easily quantifiable. Will change as the operation progresses. May be fractional if a task is partially complete. All tasks completed does not necessarily mean the operation has completed, there may be additional work. - - Returns - ------- - float | None | Unset_Type - The number_of_completed_tasks of this GsaLongRunningOperation. - """ - return self._number_of_completed_tasks - - @number_of_completed_tasks.setter - def number_of_completed_tasks( - self, number_of_completed_tasks: "float | None | Unset_Type" - ) -> None: - """Sets the number_of_completed_tasks of this GsaLongRunningOperation. - The total number of tasks that have been completed so far. May be null if the tasks are not easily quantifiable. Will change as the operation progresses. May be fractional if a task is partially complete. All tasks completed does not necessarily mean the operation has completed, there may be additional work. - - Parameters - ---------- - number_of_completed_tasks: float | None | Unset_Type - The number_of_completed_tasks of this GsaLongRunningOperation. - """ - self._number_of_completed_tasks = number_of_completed_tasks - - @property - def number_of_tasks(self) -> "int | None | Unset_Type": - """Gets the number_of_tasks of this GsaLongRunningOperation. - The total number of tasks to be completed. May be null if the tasks are not easily quantifiable, or if the total number of tasks is not known. May change as the operation progresses. - - Returns - ------- - int | None | Unset_Type - The number_of_tasks of this GsaLongRunningOperation. - """ - return self._number_of_tasks - - @number_of_tasks.setter - def number_of_tasks(self, number_of_tasks: "int | None | Unset_Type") -> None: - """Sets the number_of_tasks of this GsaLongRunningOperation. - The total number of tasks to be completed. May be null if the tasks are not easily quantifiable, or if the total number of tasks is not known. May change as the operation progresses. - - Parameters - ---------- - number_of_tasks: int | None | Unset_Type - The number_of_tasks of this GsaLongRunningOperation. - """ - self._number_of_tasks = number_of_tasks - - @property - def http_status_code(self) -> "int | None | Unset_Type": - """Gets the http_status_code of this GsaLongRunningOperation. - Will not be set if the operation has not completed. - - Returns - ------- - int | None | Unset_Type - The http_status_code of this GsaLongRunningOperation. - """ - return self._http_status_code - - @http_status_code.setter - def http_status_code(self, http_status_code: "int | None | Unset_Type") -> None: - """Sets the http_status_code of this GsaLongRunningOperation. - Will not be set if the operation has not completed. - - Parameters - ---------- - http_status_code: int | None | Unset_Type - The http_status_code of this GsaLongRunningOperation. - """ - self._http_status_code = http_status_code - - @property - def response(self) -> "object | None | Unset_Type": - """Gets the response of this GsaLongRunningOperation. - Will not be set if the operation has not completed. Could be a success response or an error response depending on whether the operation succeeded or failed. The response may be null, depending on the operation. - - Returns - ------- - object | None | Unset_Type - The response of this GsaLongRunningOperation. - """ - return self._response - - @response.setter - def response(self, response: "object | None | Unset_Type") -> None: - """Sets the response of this GsaLongRunningOperation. - Will not be set if the operation has not completed. Could be a success response or an error response depending on whether the operation succeeded or failed. The response may be null, depending on the operation. - - Parameters - ---------- - response: object | None | Unset_Type - The response of this GsaLongRunningOperation. - """ - self._response = response - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaLongRunningOperation): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_include.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_include.py deleted file mode 100644 index 76e85511..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_include.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaLongRunningOperationInclude(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - RESPONSE = "response" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_invalid_status_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_invalid_status_exception.py deleted file mode 100644 index bfe3617b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_operation_invalid_status_exception.py +++ /dev/null @@ -1,211 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaLongRunningOperationInvalidStatusException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "status": "GsaLongRunningStatus", - "code": "GsaErrorCode", - "message": "str", - } - - attribute_map: dict[str, str] = { - "status": "status", - "code": "code", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "status": "GsaLongRunningStatus", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - status: "GsaLongRunningStatus", - code: "GsaErrorCode | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaLongRunningOperationInvalidStatusException - a model defined in Swagger - - Parameters - ---------- - status: GsaLongRunningStatus - code: GsaErrorCode, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._status: GsaLongRunningStatus - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.status = status - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaLongRunningOperationInvalidStatusException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaLongRunningOperationInvalidStatusException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaLongRunningOperationInvalidStatusException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaLongRunningOperationInvalidStatusException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaLongRunningOperationInvalidStatusException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaLongRunningOperationInvalidStatusException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaLongRunningOperationInvalidStatusException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaLongRunningOperationInvalidStatusException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def status(self) -> "GsaLongRunningStatus": - """Gets the status of this GsaLongRunningOperationInvalidStatusException. - - Returns - ------- - GsaLongRunningStatus - The status of this GsaLongRunningOperationInvalidStatusException. - """ - return self._status - - @status.setter - def status(self, status: "GsaLongRunningStatus") -> None: - """Sets the status of this GsaLongRunningOperationInvalidStatusException. - - Parameters - ---------- - status: GsaLongRunningStatus - The status of this GsaLongRunningOperationInvalidStatusException. - """ - # Field is not nullable - if status is None: - raise ValueError("Invalid value for 'status', must not be 'None'") - # Field is required - if status is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'status', must not be 'Unset'") - self._status = status - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaLongRunningOperationInvalidStatusException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_status.py deleted file mode 100644 index 11a6dee4..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_running_status.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaLongRunningStatus(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - PENDING = "pending" - INPROGRESS = "inProgress" - SUCCEEDED = "succeeded" - FAILED = "failed" - CANCELLED = "cancelled" - AWAITINGCANCELLATION = "awaitingCancellation" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_text_attribute.py index d92cce16..fd458a86 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_long_text_attribute.py @@ -69,7 +69,6 @@ class GsaLongTextAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaLongTextAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.LONGTEXT, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_many_to_many_forbid_orphans_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_many_to_many_forbid_orphans_record_link_group_error_detail.py deleted file mode 100644 index 801e2c67..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_many_to_many_forbid_orphans_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.MANYTOMANYFORBIDORPHANS, - ) -> None: - """GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_match_mode.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_match_mode.py deleted file mode 100644 index 1a0fe027..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_match_mode.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaMatchMode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - BASICGUIDMATCH = "BasicGuidMatch" - MATCHONGUIDTHENNAME = "MatchOnGuidThenName" - FULLGUIDSYNC = "FullGuidSync" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_maths_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_maths_functional_attribute.py index 27c60fe2..860ede3c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_maths_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_maths_functional_attribute.py @@ -75,7 +75,6 @@ class GsaMathsFunctionalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_range": "bool", "name": "str", "table": "GsaSlimEntity", @@ -98,7 +97,6 @@ class GsaMathsFunctionalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_range": "isRange", "name": "name", "table": "table", @@ -132,7 +130,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_range: "bool", name: "str", table: "GsaSlimEntity", @@ -157,7 +154,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_range: bool name: str table: GsaSlimEntity @@ -173,7 +169,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_max_permissions_reached_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_max_permissions_reached_permission_error_detail.py deleted file mode 100644 index a3c74b28..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_max_permissions_reached_permission_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_error_detail import ( # noqa: F401 - GsaPermissionErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_error_reason import ( - GsaPermissionErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMaxPermissionsReachedPermissionErrorDetail(GsaPermissionErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "max_number_of_permissions": "int", - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "max_number_of_permissions": "maxNumberOfPermissions", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - max_number_of_permissions: "int", - message: "str", - reason: "GsaPermissionErrorReason" = GsaPermissionErrorReason.MAXPERMISSIONSREACHED, - ) -> None: - """GsaMaxPermissionsReachedPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - max_number_of_permissions: int - message: str - reason: GsaPermissionErrorReason - """ - super().__init__(message=message, reason=reason) - self._max_number_of_permissions: int - - self.max_number_of_permissions = max_number_of_permissions - - @property - def max_number_of_permissions(self) -> "int": - """Gets the max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - - Returns - ------- - int - The max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - """ - return self._max_number_of_permissions - - @max_number_of_permissions.setter - def max_number_of_permissions(self, max_number_of_permissions: "int") -> None: - """Sets the max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - - Parameters - ---------- - max_number_of_permissions: int - The max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - """ - # Field is not nullable - if max_number_of_permissions is None: - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'None'") - # Field is required - if max_number_of_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'Unset'") - self._max_number_of_permissions = max_number_of_permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMaxPermissionsReachedPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_meta_attribute_cannot_have_meta_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_meta_attribute_cannot_have_meta_attribute_error_detail.py deleted file mode 100644 index 6b0b91bf..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_meta_attribute_cannot_have_meta_attribute_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMetaAttributeCannotHaveMetaAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.METAATTRIBUTECANNOTHAVEMETAATTRIBUTE, - ) -> None: - """GsaMetaAttributeCannotHaveMetaAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMetaAttributeCannotHaveMetaAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_mfa_expression_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_mfa_expression_error_detail.py index a351759d..af8ff798 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_mfa_expression_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_mfa_expression_error_detail.py @@ -80,20 +80,21 @@ def __init__( self, *, message: "str", - reason: "GsaMfaExpressionErrorReason", + reason: "GsaMfaExpressionErrorReason | Unset_Type" = Unset, ) -> None: """GsaMfaExpressionErrorDetail - a model defined in Swagger Parameters ---------- message: str - reason: GsaMfaExpressionErrorReason + reason: GsaMfaExpressionErrorReason, optional """ self._message: str - self._reason: GsaMfaExpressionErrorReason + self._reason: GsaMfaExpressionErrorReason | Unset_Type = Unset self.message = message - self.reason = reason + if reason is not Unset: + self.reason = reason @property def message(self) -> "str": @@ -124,31 +125,28 @@ def message(self, message: "str") -> None: self._message = message @property - def reason(self) -> "GsaMfaExpressionErrorReason": + def reason(self) -> "GsaMfaExpressionErrorReason | Unset_Type": """Gets the reason of this GsaMfaExpressionErrorDetail. Returns ------- - GsaMfaExpressionErrorReason + GsaMfaExpressionErrorReason | Unset_Type The reason of this GsaMfaExpressionErrorDetail. """ return self._reason @reason.setter - def reason(self, reason: "GsaMfaExpressionErrorReason") -> None: + def reason(self, reason: "GsaMfaExpressionErrorReason | Unset_Type") -> None: """Sets the reason of this GsaMfaExpressionErrorDetail. Parameters ---------- - reason: GsaMfaExpressionErrorReason + reason: GsaMfaExpressionErrorReason | Unset_Type The reason of this GsaMfaExpressionErrorDetail. """ # Field is not nullable if reason is None: raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") self._reason = reason @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_attribute_error_detail.py deleted file mode 100644 index 0886a43c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_attribute_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMultiValuedAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "multi_valued_reasons": "list[GsaMultiValuedReason]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "multi_valued_reasons": "multiValuedReasons", - } - - subtype_mapping: dict[str, str] = { - "multiValuedReasons": "GsaMultiValuedReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.MULTIVALUED, - multi_valued_reasons: "list[GsaMultiValuedReason] | None | Unset_Type" = Unset, - ) -> None: - """GsaMultiValuedAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - multi_valued_reasons: list[GsaMultiValuedReason] | None, optional - """ - super().__init__(message=message, reason=reason) - self._multi_valued_reasons: list[GsaMultiValuedReason] | None | Unset_Type = Unset - - if multi_valued_reasons is not Unset: - self.multi_valued_reasons = multi_valued_reasons - - @property - def multi_valued_reasons(self) -> "list[GsaMultiValuedReason] | None | Unset_Type": - """Gets the multi_valued_reasons of this GsaMultiValuedAttributeErrorDetail. - - Returns - ------- - list[GsaMultiValuedReason] | None | Unset_Type - The multi_valued_reasons of this GsaMultiValuedAttributeErrorDetail. - """ - return self._multi_valued_reasons - - @multi_valued_reasons.setter - def multi_valued_reasons( - self, multi_valued_reasons: "list[GsaMultiValuedReason] | None | Unset_Type" - ) -> None: - """Sets the multi_valued_reasons of this GsaMultiValuedAttributeErrorDetail. - - Parameters - ---------- - multi_valued_reasons: list[GsaMultiValuedReason] | None | Unset_Type - The multi_valued_reasons of this GsaMultiValuedAttributeErrorDetail. - """ - self._multi_valued_reasons = multi_valued_reasons - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMultiValuedAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_point_data_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_point_data_usage_data_modification_error_detail.py deleted file mode 100644 index 1f67af96..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_point_data_usage_data_modification_error_detail.py +++ /dev/null @@ -1,135 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMultiValuedPointDataUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.MULTIVALUEDPOINTDATA, - ) -> None: - """GsaMultiValuedPointDataUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMultiValuedPointDataUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_reason.py deleted file mode 100644 index 64a02ea1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_reason.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaMultiValuedReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - HASMULTIVALUEDDATA = "hasMultiValuedData" - ISINDYNAMICLINKINDEX = "isInDynamicLinkIndex" - ISLINKEDFROMTABULARCOLUMN = "isLinkedFromTabularColumn" - ISUSEDINEXPRESSION = "isUsedInExpression" - ISUSEDINXYCHARTTEMPLATE = "isUsedInXYChartTemplate" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_smart_attributes_error_detail.py deleted file mode 100644 index c64ea004..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multi_valued_smart_attributes_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMultiValuedSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.MULTIVALUED, - ) -> None: - """GsaMultiValuedSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - message: str - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str - - self.attribute_guid = attribute_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaMultiValuedSmartAttributesErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaMultiValuedSmartAttributesErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaMultiValuedSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaMultiValuedSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMultiValuedSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail.py deleted file mode 100644 index 335be31f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail( - GsaAccessControlCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - "attribute_guid": "str", - "table_discrete_value_count": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "attribute_guid": "attributeGuid", - "table_discrete_value_count": "tableDiscreteValueCount", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.MULTIPLEDEFAULTVALUESINSINGLEVALUEDDISCRETE, - attribute_guid: "str | Unset_Type" = Unset, - table_discrete_value_count: "int | Unset_Type" = Unset, - ) -> None: - """GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - attribute_guid: str, optional - table_discrete_value_count: int, optional - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str | Unset_Type = Unset - self._table_discrete_value_count: int | Unset_Type = Unset - - if attribute_guid is not Unset: - self.attribute_guid = attribute_guid - if table_discrete_value_count is not Unset: - self.table_discrete_value_count = table_discrete_value_count - - @property - def attribute_guid(self) -> "str | Unset_Type": - """Gets the attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Returns - ------- - str | Unset_Type - The attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str | Unset_Type") -> None: - """Sets the attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Parameters - ---------- - attribute_guid: str | Unset_Type - The attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - self._attribute_guid = attribute_guid - - @property - def table_discrete_value_count(self) -> "int | Unset_Type": - """Gets the table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Returns - ------- - int | Unset_Type - The table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - return self._table_discrete_value_count - - @table_discrete_value_count.setter - def table_discrete_value_count(self, table_discrete_value_count: "int | Unset_Type") -> None: - """Sets the table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Parameters - ---------- - table_discrete_value_count: int | Unset_Type - The table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - # Field is not nullable - if table_discrete_value_count is None: - raise ValueError("Invalid value for 'table_discrete_value_count', must not be 'None'") - self._table_discrete_value_count = table_discrete_value_count - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_as_reverse_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_as_reverse_record_link_group_error_detail.py deleted file mode 100644 index a8ab5099..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_as_reverse_record_link_group_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "name": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "name": "name", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - name: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NAMEALREADYEXISTSASREVERSE, - ) -> None: - """GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - name: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - self._name: str - - self.name = name - - @property - def name(self) -> "str": - """Gets the name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - - Returns - ------- - str - The name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - - Parameters - ---------- - name: str - The name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_error_detail.py index 1de0763e..5af4489e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_exists_error_detail.py @@ -68,54 +68,45 @@ class GsaNameAlreadyExistsErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", "name": "str", - "parent_entity_type": "GsaEntityType", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", "name": "name", - "parent_entity_type": "parentEntityType", } - subtype_mapping: dict[str, str] = { - "parentEntityType": "GsaEntityType", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.NAMEALREADYEXISTS, + entity_type_name: "str | None | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - parent_entity_type: "GsaEntityType | Unset_Type" = Unset, ) -> None: """GsaNameAlreadyExistsErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional name: str | None, optional - parent_entity_type: GsaEntityType, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) self._name: str | None | Unset_Type = Unset - self._parent_entity_type: GsaEntityType | Unset_Type = Unset if name is not Unset: self.name = name - if parent_entity_type is not Unset: - self.parent_entity_type = parent_entity_type @property def name(self) -> "str | None | Unset_Type": @@ -139,31 +130,6 @@ def name(self, name: "str | None | Unset_Type") -> None: """ self._name = name - @property - def parent_entity_type(self) -> "GsaEntityType | Unset_Type": - """Gets the parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - - Returns - ------- - GsaEntityType | Unset_Type - The parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - """ - return self._parent_entity_type - - @parent_entity_type.setter - def parent_entity_type(self, parent_entity_type: "GsaEntityType | Unset_Type") -> None: - """Sets the parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - - Parameters - ---------- - parent_entity_type: GsaEntityType | Unset_Type - The parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - """ - # Field is not nullable - if parent_entity_type is None: - raise ValueError("Invalid value for 'parent_entity_type', must not be 'None'") - self._parent_entity_type = parent_entity_type - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_specified_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_specified_error_detail.py deleted file mode 100644 index c835cd0c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_already_specified_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameAlreadySpecifiedErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.NAMEALREADYSPECIFIED, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaNameAlreadySpecifiedErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - name: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaNameAlreadySpecifiedErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaNameAlreadySpecifiedErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaNameAlreadySpecifiedErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaNameAlreadySpecifiedErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameAlreadySpecifiedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_missing_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_missing_currency_error_detail.py deleted file mode 100644 index 9b11d413..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_missing_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameMissingCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.NAMEMISSING, - ) -> None: - """GsaNameMissingCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameMissingCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_not_provided_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_not_provided_error_detail.py index f0b4f257..ffe5eabf 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_not_provided_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_not_provided_error_detail.py @@ -68,15 +68,15 @@ class GsaNameNotProvidedErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", } subtype_mapping: dict[str, str] = {} @@ -86,19 +86,19 @@ class GsaNameNotProvidedErrorDetail(GsaNamedEntityErrorDetail): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.NAMENOTPROVIDED, + entity_type_name: "str | None | Unset_Type" = Unset, ) -> None: """GsaNameNotProvidedErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_same_as_reverse_name_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_same_as_reverse_name_record_link_group_error_detail.py deleted file mode 100644 index d1361100..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_same_as_reverse_name_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameSameAsReverseNameRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NAMESAMEASREVERSENAME, - ) -> None: - """GsaNameSameAsReverseNameRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameSameAsReverseNameRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_currency_error_detail.py deleted file mode 100644 index e9dae13f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameWhitespaceCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.NAMEWHITESPACE, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaNameWhitespaceCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaNameWhitespaceCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaNameWhitespaceCurrencyErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaNameWhitespaceCurrencyErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaNameWhitespaceCurrencyErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameWhitespaceCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_parameter_value_error_detail.py deleted file mode 100644 index e5dac979..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_name_whitespace_parameter_value_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameWhitespaceParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.NAMEWHITESPACE, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaNameWhitespaceParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaNameWhitespaceParameterValueErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaNameWhitespaceParameterValueErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaNameWhitespaceParameterValueErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaNameWhitespaceParameterValueErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameWhitespaceParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_access_control_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_access_control_category_error_detail.py deleted file mode 100644 index e4e0969d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_access_control_category_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityAccessControlCategoryErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityAccessControlCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityAccessControlCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_constant_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_constant_error_detail.py deleted file mode 100644 index ba6c6937..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_constant_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_constant_error_detail import ( # noqa: F401 - GsaConstantErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_constant_error_reason import ( - GsaConstantErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityConstantErrorDetail(GsaConstantErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaConstantErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaConstantErrorReason" = GsaConstantErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityConstantErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaConstantErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityConstantErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityConstantErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityConstantErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityConstantErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityConstantErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_type_error_detail.py deleted file mode 100644 index 9bf09120..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_type_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_type_error_detail import ( # noqa: F401 - GsaDiscreteTypeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_type_error_reason import ( - GsaDiscreteTypeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityDiscreteTypeErrorDetail(GsaDiscreteTypeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaDiscreteTypeErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaDiscreteTypeErrorReason" = GsaDiscreteTypeErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityDiscreteTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaDiscreteTypeErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityDiscreteTypeErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityDiscreteTypeErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityDiscreteTypeErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityDiscreteTypeErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityDiscreteTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_value_error_detail.py deleted file mode 100644 index 1e66f0cb..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_discrete_value_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_value_error_detail import ( # noqa: F401 - GsaDiscreteValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_value_error_reason import ( - GsaDiscreteValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityDiscreteValueErrorDetail(GsaDiscreteValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaDiscreteValueErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaDiscreteValueErrorReason" = GsaDiscreteValueErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityDiscreteValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaDiscreteValueErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityDiscreteValueErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityDiscreteValueErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityDiscreteValueErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityDiscreteValueErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityDiscreteValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_detail.py index ed6ffbab..9dea03c9 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_detail.py @@ -63,31 +63,26 @@ class GsaNamedEntityErrorDetail(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", } subtype_mapping: dict[str, str] = { "reason": "GsaNamedEntityErrorReason", - "entityType": "GsaEntityType", } discriminator_value_class_map = { "entityAlreadyExists".lower(): "#/components/schemas/GsaEntityAlreadyExistsErrorDetail", "nameNotProvided".lower(): "#/components/schemas/GsaNameNotProvidedErrorDetail", "nameAlreadyExists".lower(): "#/components/schemas/GsaNameAlreadyExistsErrorDetail", - "nameAlreadySpecified".lower(): "#/components/schemas/GsaNameAlreadySpecifiedErrorDetail", "entityIdentifierAlreadySpecified".lower(): "#/components/schemas/GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "displayNameEmpty".lower(): "#/components/schemas/GsaDisplayNameEmptyErrorDetail", - "displayNameLanguageNotProvided".lower(): "#/components/schemas/GsaDisplayNameLanguageNotProvidedErrorDetail", - "displayNameLanguageNotSupported".lower(): "#/components/schemas/GsaDisplayNameLanguageNotSupportedErrorDetail", } discriminator: Optional[str] = "reason" @@ -95,25 +90,26 @@ class GsaNamedEntityErrorDetail(ModelBase): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason", + entity_type_name: "str | None | Unset_Type" = Unset, ) -> None: """GsaNamedEntityErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional """ self._message: str self._reason: GsaNamedEntityErrorReason - self._entity_type: GsaEntityType + self._entity_type_name: str | None | Unset_Type = Unset self.message = message self.reason = reason - self.entity_type = entity_type + if entity_type_name is not Unset: + self.entity_type_name = entity_type_name @property def message(self) -> "str": @@ -172,32 +168,28 @@ def reason(self, reason: "GsaNamedEntityErrorReason") -> None: self._reason = reason @property - def entity_type(self) -> "GsaEntityType": - """Gets the entity_type of this GsaNamedEntityErrorDetail. + def entity_type_name(self) -> "str | None | Unset_Type": + """Gets the entity_type_name of this GsaNamedEntityErrorDetail. + e.g. 'Attribute', 'Meta-attribute' Returns ------- - GsaEntityType - The entity_type of this GsaNamedEntityErrorDetail. + str | None | Unset_Type + The entity_type_name of this GsaNamedEntityErrorDetail. """ - return self._entity_type + return self._entity_type_name - @entity_type.setter - def entity_type(self, entity_type: "GsaEntityType") -> None: - """Sets the entity_type of this GsaNamedEntityErrorDetail. + @entity_type_name.setter + def entity_type_name(self, entity_type_name: "str | None | Unset_Type") -> None: + """Sets the entity_type_name of this GsaNamedEntityErrorDetail. + e.g. 'Attribute', 'Meta-attribute' Parameters ---------- - entity_type: GsaEntityType - The entity_type of this GsaNamedEntityErrorDetail. + entity_type_name: str | None | Unset_Type + The entity_type_name of this GsaNamedEntityErrorDetail. """ - # Field is not nullable - if entity_type is None: - raise ValueError("Invalid value for 'entity_type', must not be 'None'") - # Field is required - if entity_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entity_type', must not be 'Unset'") - self._entity_type = entity_type + self._entity_type_name = entity_type_name @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_reason.py index b827d37e..fce40b1d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_reason.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_error_reason.py @@ -46,7 +46,3 @@ class GsaNamedEntityErrorReason(Enum): ENTITYIDENTIFIERALREADYSPECIFIED = "entityIdentifierAlreadySpecified" NAMENOTPROVIDED = "nameNotProvided" NAMEALREADYEXISTS = "nameAlreadyExists" - NAMEALREADYSPECIFIED = "nameAlreadySpecified" - DISPLAYNAMEEMPTY = "displayNameEmpty" - DISPLAYNAMELANGUAGENOTPROVIDED = "displayNameLanguageNotProvided" - DISPLAYNAMELANGUAGENOTSUPPORTED = "displayNameLanguageNotSupported" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_file_error_detail.py deleted file mode 100644 index e9626b20..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_file_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityFileErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFileErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityFileErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFileErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_folder_error_detail.py deleted file mode 100644 index 77488bea..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_folder_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_error_detail import ( # noqa: F401 - GsaFolderErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_error_reason import ( - GsaFolderErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityFolderErrorDetail(GsaFolderErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason" = GsaFolderErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityFolderErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFolderErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityFolderErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFolderErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_error_detail.py deleted file mode 100644 index 3c140c4d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityParameterErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityParameterErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_value_error_detail.py deleted file mode 100644 index aa6aa5ff..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_parameter_value_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityParameterValueErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterValueErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityParameterValueErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterValueErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_category_error_detail.py deleted file mode 100644 index 22db9f0b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_category_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaPermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityPermissionCategoryErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityPermissionCategoryErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityPermissionCategoryErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityPermissionCategoryErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_error_detail.py deleted file mode 100644 index 43a7d04d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_permission_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_error_detail import ( # noqa: F401 - GsaPermissionErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_error_reason import ( - GsaPermissionErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityPermissionErrorDetail(GsaPermissionErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaPermissionErrorReason" = GsaPermissionErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaPermissionErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityPermissionErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityPermissionErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityPermissionErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityPermissionErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_discrete_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_discrete_value_error_detail.py deleted file mode 100644 index af0d9d29..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_discrete_value_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_discrete_value_error_detail import ( # noqa: F401 - GsaQualityDiscreteValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_discrete_value_error_reason import ( - GsaQualityDiscreteValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityQualityDiscreteValueErrorDetail(GsaQualityDiscreteValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaQualityDiscreteValueErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaQualityDiscreteValueErrorReason" = GsaQualityDiscreteValueErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityQualityDiscreteValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaQualityDiscreteValueErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityQualityDiscreteValueErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityQualityDiscreteValueErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityQualityDiscreteValueErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityQualityDiscreteValueErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityQualityDiscreteValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_system_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_system_error_detail.py deleted file mode 100644 index f84c962f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_quality_system_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_detail import ( # noqa: F401 - GsaQualitySystemErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_reason import ( - GsaQualitySystemErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityQualitySystemErrorDetail(GsaQualitySystemErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaQualitySystemErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaQualitySystemErrorReason" = GsaQualitySystemErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityQualitySystemErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaQualitySystemErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityQualitySystemErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityQualitySystemErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityQualitySystemErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityQualitySystemErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityQualitySystemErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_record_link_group_error_detail.py deleted file mode 100644 index a87a0b18..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_record_link_group_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_table_error_detail.py deleted file mode 100644 index 6e62a424..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_table_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityTableErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaTableErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityTableErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityTableErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityTableErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityTableErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_unit_error_detail.py deleted file mode 100644 index 4b4eeaaa..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_named_entity_unit_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityUnitErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityUnitErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityUnitErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityUnitErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_attribute_pairs_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_attribute_pairs_smart_attributes_error_detail.py deleted file mode 100644 index 93a5a4f9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_attribute_pairs_smart_attributes_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoAttributePairsSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.NOATTRIBUTEPAIRS, - ) -> None: - """GsaNoAttributePairsSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoAttributePairsSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_data_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_data_file_error_detail.py deleted file mode 100644 index 4b51198d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_data_file_error_detail.py +++ /dev/null @@ -1,159 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoDataFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "is_configuration": "bool", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "is_configuration": "isConfiguration", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.NODATA, - is_configuration: "bool | Unset_Type" = Unset, - ) -> None: - """GsaNoDataFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - is_configuration: bool, optional - """ - super().__init__(message=message, reason=reason) - self._is_configuration: bool | Unset_Type = Unset - - if is_configuration is not Unset: - self.is_configuration = is_configuration - - @property - def is_configuration(self) -> "bool | Unset_Type": - """Gets the is_configuration of this GsaNoDataFileErrorDetail. - - Returns - ------- - bool | Unset_Type - The is_configuration of this GsaNoDataFileErrorDetail. - """ - return self._is_configuration - - @is_configuration.setter - def is_configuration(self, is_configuration: "bool | Unset_Type") -> None: - """Sets the is_configuration of this GsaNoDataFileErrorDetail. - - Parameters - ---------- - is_configuration: bool | Unset_Type - The is_configuration of this GsaNoDataFileErrorDetail. - """ - # Field is not nullable - if is_configuration is None: - raise ValueError("Invalid value for 'is_configuration', must not be 'None'") - self._is_configuration = is_configuration - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoDataFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_file_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_file_file_error_detail.py deleted file mode 100644 index cf1ef92b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_file_file_error_detail.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoFileFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.NOFILE, - ) -> None: - """GsaNoFileFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoFileFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_parameter_values_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_parameter_values_parameter_error_detail.py deleted file mode 100644 index 8d9f7394..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_parameter_values_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoParameterValuesParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NOPARAMETERVALUES, - ) -> None: - """GsaNoParameterValuesParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoParameterValuesParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_permissions_permission_category_error_detail.py deleted file mode 100644 index 8ffa6e41..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoPermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.NOPERMISSIONS, - ) -> None: - """GsaNoPermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoPermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_quality_discrete_values_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_quality_discrete_values_error_detail.py deleted file mode 100644 index 3f88a1b6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_quality_discrete_values_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_detail import ( # noqa: F401 - GsaQualitySystemErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_reason import ( - GsaQualitySystemErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoQualityDiscreteValuesErrorDetail(GsaQualitySystemErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaQualitySystemErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaQualitySystemErrorReason" = GsaQualitySystemErrorReason.NOQUALITYDISCRETEVALUES, - ) -> None: - """GsaNoQualityDiscreteValuesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaQualitySystemErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoQualityDiscreteValuesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_attribute_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_attribute_smart_attributes_error_detail.py deleted file mode 100644 index f79ac279..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_attribute_smart_attributes_error_detail.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchAttributeSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "database_key": "str", - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "database_key": "databaseKey", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - database_key: "str", - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.NOSUCHATTRIBUTE, - table_guid: "str", - ) -> None: - """GsaNoSuchAttributeSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - database_key: str - message: str - reason: GsaSmartAttributesErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._database_key: str - self._table_guid: str - self._attribute_guid: str - - self.database_key = database_key - self.table_guid = table_guid - self.attribute_guid = attribute_guid - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Returns - ------- - str - The database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Parameters - ---------- - database_key: str - The database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Returns - ------- - str - The table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchAttributeSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_categories_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_categories_replace_permission_category_error_detail.py deleted file mode 100644 index 80841dd5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_categories_replace_permission_category_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail( - GsaReplacePermissionCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - "missing_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "missing_guids": "missingGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.NOSUCHCATEGORIES, - missing_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaReplacePermissionCategoryErrorReason - missing_guids: list[str] | None, optional - """ - super().__init__(message=message, reason=reason) - self._missing_guids: list[str] | None | Unset_Type = Unset - - if missing_guids is not Unset: - self.missing_guids = missing_guids - - @property - def missing_guids(self) -> "list[str] | None | Unset_Type": - """Gets the missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - """ - return self._missing_guids - - @missing_guids.setter - def missing_guids(self, missing_guids: "list[str] | None | Unset_Type") -> None: - """Sets the missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - missing_guids: list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - """ - self._missing_guids = missing_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_category_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_category_access_control_error_detail.py deleted file mode 100644 index dbbffea1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_category_access_control_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchCategoryAccessControlErrorDetail(GsaPermissionCategoriesAccessControlErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.NOSUCHCATEGORY, - ) -> None: - """GsaNoSuchCategoryAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - category_guid: str - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._category_guid: str - - self.category_guid = category_guid - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - - Returns - ------- - str - The category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchCategoryAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_discrete_value_in_discrete_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_discrete_value_in_discrete_type_error_detail.py deleted file mode 100644 index 87fc8788..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_discrete_value_in_discrete_type_error_detail.py +++ /dev/null @@ -1,190 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_value_error_detail import ( # noqa: F401 - GsaDiscreteValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_discrete_value_error_reason import ( - GsaDiscreteValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail(GsaDiscreteValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDiscreteValueErrorReason", - "discrete_type_guid": "str", - "missing_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "discrete_type_guid": "discreteTypeGuid", - "missing_guids": "missingGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDiscreteValueErrorReason" = GsaDiscreteValueErrorReason.NOSUCHDISCRETEVALUESINDISCRETEVALUES, - discrete_type_guid: "str | Unset_Type" = Unset, - missing_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDiscreteValueErrorReason - discrete_type_guid: str, optional - missing_guids: list[str] | None, optional - """ - super().__init__(message=message, reason=reason) - self._discrete_type_guid: str | Unset_Type = Unset - self._missing_guids: list[str] | None | Unset_Type = Unset - - if discrete_type_guid is not Unset: - self.discrete_type_guid = discrete_type_guid - if missing_guids is not Unset: - self.missing_guids = missing_guids - - @property - def discrete_type_guid(self) -> "str | Unset_Type": - """Gets the discrete_type_guid of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - - Returns - ------- - str | Unset_Type - The discrete_type_guid of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - """ - return self._discrete_type_guid - - @discrete_type_guid.setter - def discrete_type_guid(self, discrete_type_guid: "str | Unset_Type") -> None: - """Sets the discrete_type_guid of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - - Parameters - ---------- - discrete_type_guid: str | Unset_Type - The discrete_type_guid of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - """ - # Field is not nullable - if discrete_type_guid is None: - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'None'") - self._discrete_type_guid = discrete_type_guid - - @property - def missing_guids(self) -> "list[str] | None | Unset_Type": - """Gets the missing_guids of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - - Returns - ------- - list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - """ - return self._missing_guids - - @missing_guids.setter - def missing_guids(self, missing_guids: "list[str] | None | Unset_Type") -> None: - """Sets the missing_guids of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - - Parameters - ---------- - missing_guids: list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail. - """ - self._missing_guids = missing_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchDiscreteValueInDiscreteTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entities_access_control_entities_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entities_access_control_entities_error_detail.py deleted file mode 100644 index 83dbed04..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entities_access_control_entities_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entities_error_detail import ( # noqa: F401 - GsaAccessControlEntitiesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_entities_error_reason import ( - GsaPermissionBasedAccessControlEntitiesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchEntitiesAccessControlEntitiesErrorDetail(GsaAccessControlEntitiesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entities": "list[GsaAccessControlEntity]", - "message": "str", - "reason": "GsaPermissionBasedAccessControlEntitiesErrorReason", - } - - attribute_map: dict[str, str] = { - "entities": "entities", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "entities": "GsaAccessControlEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entities: "list[GsaAccessControlEntity]", - message: "str", - reason: "GsaPermissionBasedAccessControlEntitiesErrorReason" = GsaPermissionBasedAccessControlEntitiesErrorReason.NOSUCHENTITIES, - ) -> None: - """GsaNoSuchEntitiesAccessControlEntitiesErrorDetail - a model defined in Swagger - - Parameters - ---------- - entities: list[GsaAccessControlEntity] - message: str - reason: GsaPermissionBasedAccessControlEntitiesErrorReason - """ - super().__init__(message=message, reason=reason) - self._entities: list[GsaAccessControlEntity] - - self.entities = entities - - @property - def entities(self) -> "list[GsaAccessControlEntity]": - """Gets the entities of this GsaNoSuchEntitiesAccessControlEntitiesErrorDetail. - - Returns - ------- - list[GsaAccessControlEntity] - The entities of this GsaNoSuchEntitiesAccessControlEntitiesErrorDetail. - """ - return self._entities - - @entities.setter - def entities(self, entities: "list[GsaAccessControlEntity]") -> None: - """Sets the entities of this GsaNoSuchEntitiesAccessControlEntitiesErrorDetail. - - Parameters - ---------- - entities: list[GsaAccessControlEntity] - The entities of this GsaNoSuchEntitiesAccessControlEntitiesErrorDetail. - """ - # Field is not nullable - if entities is None: - raise ValueError("Invalid value for 'entities', must not be 'None'") - # Field is required - if entities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entities', must not be 'Unset'") - self._entities = entities - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchEntitiesAccessControlEntitiesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_access_control_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_access_control_category_error_detail.py deleted file mode 100644 index a187695d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_access_control_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchEntityAccessControlCategoryErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlCategoryNoSuchEntityType", - "guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "guid": "guid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "entityType": "GsaAccessControlCategoryNoSuchEntityType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlCategoryNoSuchEntityType", - guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.NOSUCHENTITY, - ) -> None: - """GsaNoSuchEntityAccessControlCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlCategoryNoSuchEntityType - guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._guid: str - self._entity_type: GsaAccessControlCategoryNoSuchEntityType - - self.guid = guid - self.entity_type = entity_type - - @property - def guid(self) -> "str": - """Gets the guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Returns - ------- - str - The guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Parameters - ---------- - guid: str - The guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def entity_type(self) -> "GsaAccessControlCategoryNoSuchEntityType": - """Gets the entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Returns - ------- - GsaAccessControlCategoryNoSuchEntityType - The entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - return self._entity_type - - @entity_type.setter - def entity_type(self, entity_type: "GsaAccessControlCategoryNoSuchEntityType") -> None: - """Sets the entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Parameters - ---------- - entity_type: GsaAccessControlCategoryNoSuchEntityType - The entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if entity_type is None: - raise ValueError("Invalid value for 'entity_type', must not be 'None'") - # Field is required - if entity_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entity_type', must not be 'Unset'") - self._entity_type = entity_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchEntityAccessControlCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_tabular_column_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_tabular_column_error_detail.py index d93b08da..788d1c08 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_tabular_column_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_entity_tabular_column_error_detail.py @@ -70,21 +70,19 @@ class GsaNoSuchEntityTabularColumnErrorDetail(GsaAttributeErrorDetail): swagger_types: dict[str, str] = { "message": "str", "reason": "GsaAttributeErrorReason", - "column_guid": "str", - "column_name": "str", "database_key": "str", "entity_type": "GsaTabularColumnNoSuchEntityType", "guid": "str", + "tabular_column_name": "str", } attribute_map: dict[str, str] = { "message": "message", "reason": "reason", - "column_guid": "columnGuid", - "column_name": "columnName", "database_key": "databaseKey", "entity_type": "entityType", "guid": "guid", + "tabular_column_name": "tabularColumnName", } subtype_mapping: dict[str, str] = { @@ -98,11 +96,10 @@ def __init__( *, message: "str", reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.TABULARCOLUMNNOSUCHENTITY, - column_guid: "str | None | Unset_Type" = Unset, - column_name: "str | None | Unset_Type" = Unset, database_key: "str | None | Unset_Type" = Unset, entity_type: "GsaTabularColumnNoSuchEntityType | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, + tabular_column_name: "str | None | Unset_Type" = Unset, ) -> None: """GsaNoSuchEntityTabularColumnErrorDetail - a model defined in Swagger @@ -110,23 +107,19 @@ def __init__( ---------- message: str reason: GsaAttributeErrorReason - column_guid: str | None, optional - column_name: str | None, optional database_key: str | None, optional entity_type: GsaTabularColumnNoSuchEntityType, optional guid: str, optional + tabular_column_name: str | None, optional """ super().__init__(message=message, reason=reason) - self._column_name: str | None | Unset_Type = Unset - self._column_guid: str | None | Unset_Type = Unset + self._tabular_column_name: str | None | Unset_Type = Unset self._guid: str | Unset_Type = Unset self._database_key: str | None | Unset_Type = Unset self._entity_type: GsaTabularColumnNoSuchEntityType | Unset_Type = Unset - if column_name is not Unset: - self.column_name = column_name - if column_guid is not Unset: - self.column_guid = column_guid + if tabular_column_name is not Unset: + self.tabular_column_name = tabular_column_name if guid is not Unset: self.guid = guid if database_key is not Unset: @@ -135,52 +128,26 @@ def __init__( self.entity_type = entity_type @property - def column_name(self) -> "str | None | Unset_Type": - """Gets the column_name of this GsaNoSuchEntityTabularColumnErrorDetail. - May be null if no column name was provided in the request. + def tabular_column_name(self) -> "str | None | Unset_Type": + """Gets the tabular_column_name of this GsaNoSuchEntityTabularColumnErrorDetail. Returns ------- str | None | Unset_Type - The column_name of this GsaNoSuchEntityTabularColumnErrorDetail. + The tabular_column_name of this GsaNoSuchEntityTabularColumnErrorDetail. """ - return self._column_name + return self._tabular_column_name - @column_name.setter - def column_name(self, column_name: "str | None | Unset_Type") -> None: - """Sets the column_name of this GsaNoSuchEntityTabularColumnErrorDetail. - May be null if no column name was provided in the request. + @tabular_column_name.setter + def tabular_column_name(self, tabular_column_name: "str | None | Unset_Type") -> None: + """Sets the tabular_column_name of this GsaNoSuchEntityTabularColumnErrorDetail. Parameters ---------- - column_name: str | None | Unset_Type - The column_name of this GsaNoSuchEntityTabularColumnErrorDetail. + tabular_column_name: str | None | Unset_Type + The tabular_column_name of this GsaNoSuchEntityTabularColumnErrorDetail. """ - self._column_name = column_name - - @property - def column_guid(self) -> "str | None | Unset_Type": - """Gets the column_guid of this GsaNoSuchEntityTabularColumnErrorDetail. - Only populated when updating an existing column. - - Returns - ------- - str | None | Unset_Type - The column_guid of this GsaNoSuchEntityTabularColumnErrorDetail. - """ - return self._column_guid - - @column_guid.setter - def column_guid(self, column_guid: "str | None | Unset_Type") -> None: - """Sets the column_guid of this GsaNoSuchEntityTabularColumnErrorDetail. - Only populated when updating an existing column. - - Parameters - ---------- - column_guid: str | None | Unset_Type - The column_guid of this GsaNoSuchEntityTabularColumnErrorDetail. - """ - self._column_guid = column_guid + self._tabular_column_name = tabular_column_name @property def guid(self) -> "str | Unset_Type": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_file_move_error_detail.py deleted file mode 100644 index 985346ca..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_file_move_error_detail.py +++ /dev/null @@ -1,224 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_move_error_detail import ( # noqa: F401 - GsaFileMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_move_error_reason import ( - GsaFileMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchNewParentFileMoveErrorDetail(GsaFileMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - "database_key": "str", - "folder_guid": "str", - "folder_type": "GsaFolderType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "database_key": "databaseKey", - "folder_guid": "folderGuid", - "folder_type": "folderType", - } - - subtype_mapping: dict[str, str] = { - "folderType": "GsaFolderType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason" = GsaFileMoveErrorReason.NOSUCHNEWPARENT, - database_key: "str | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchNewParentFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - database_key: str | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - """ - super().__init__(message=message, reason=reason) - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._database_key: str | None | Unset_Type = Unset - - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if database_key is not Unset: - self.database_key = database_key - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - self._database_key = database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchNewParentFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_folder_move_error_detail.py deleted file mode 100644 index 8f2490b6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_new_parent_folder_move_error_detail.py +++ /dev/null @@ -1,224 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchNewParentFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - "database_key": "str", - "folder_type": "GsaFolderType", - "new_parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "database_key": "databaseKey", - "folder_type": "folderType", - "new_parent_folder_guid": "newParentFolderGuid", - } - - subtype_mapping: dict[str, str] = { - "folderType": "GsaFolderType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.NOSUCHNEWPARENT, - database_key: "str | None | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - new_parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchNewParentFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - database_key: str | None, optional - folder_type: GsaFolderType, optional - new_parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._new_parent_folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._database_key: str | None | Unset_Type = Unset - - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if database_key is not Unset: - self.database_key = database_key - - @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - return self._new_parent_folder_guid - - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Parameters - ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - self._database_key = database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchNewParentFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permission_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permission_access_control_error_detail.py deleted file mode 100644 index d4f47c73..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permission_access_control_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchPermissionAccessControlErrorDetail(GsaPermissionCategoriesAccessControlErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "message": "str", - "permission_guid": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "message": "message", - "permission_guid": "permissionGuid", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - message: "str", - permission_guid: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.NOSUCHPERMISSION, - ) -> None: - """GsaNoSuchPermissionAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - category_guid: str - message: str - permission_guid: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._permission_guid: str - self._category_guid: str - - self.permission_guid = permission_guid - self.category_guid = category_guid - - @property - def permission_guid(self) -> "str": - """Gets the permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Returns - ------- - str - The permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - return self._permission_guid - - @permission_guid.setter - def permission_guid(self, permission_guid: "str") -> None: - """Sets the permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Parameters - ---------- - permission_guid: str - The permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - # Field is not nullable - if permission_guid is None: - raise ValueError("Invalid value for 'permission_guid', must not be 'None'") - # Field is required - if permission_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_guid', must not be 'Unset'") - self._permission_guid = permission_guid - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Returns - ------- - str - The category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchPermissionAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permissions_permission_category_error_detail.py deleted file mode 100644 index fb0f067a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchPermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - "missing_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "missing_guids": "missingGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.NOSUCHPERMISSIONS, - missing_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchPermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoryErrorReason - missing_guids: list[str] | None, optional - """ - super().__init__(message=message, reason=reason) - self._missing_guids: list[str] | None | Unset_Type = Unset - - if missing_guids is not Unset: - self.missing_guids = missing_guids - - @property - def missing_guids(self) -> "list[str] | None | Unset_Type": - """Gets the missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - - Returns - ------- - list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - """ - return self._missing_guids - - @missing_guids.setter - def missing_guids(self, missing_guids: "list[str] | None | Unset_Type") -> None: - """Sets the missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - missing_guids: list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - """ - self._missing_guids = missing_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchPermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_subset_access_control_entities_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_subset_access_control_entities_error_detail.py deleted file mode 100644 index 4462bb86..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_subset_access_control_entities_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entities_error_detail import ( # noqa: F401 - GsaAccessControlEntitiesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_entities_error_reason import ( - GsaPermissionBasedAccessControlEntitiesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchSubsetAccessControlEntitiesErrorDetail(GsaAccessControlEntitiesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entities": "list[GsaAccessControlEntity]", - "message": "str", - "reason": "GsaPermissionBasedAccessControlEntitiesErrorReason", - } - - attribute_map: dict[str, str] = { - "entities": "entities", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "entities": "GsaAccessControlEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entities: "list[GsaAccessControlEntity]", - message: "str", - reason: "GsaPermissionBasedAccessControlEntitiesErrorReason" = GsaPermissionBasedAccessControlEntitiesErrorReason.NOSUCHSUBSET, - ) -> None: - """GsaNoSuchSubsetAccessControlEntitiesErrorDetail - a model defined in Swagger - - Parameters - ---------- - entities: list[GsaAccessControlEntity] - message: str - reason: GsaPermissionBasedAccessControlEntitiesErrorReason - """ - super().__init__(message=message, reason=reason) - self._entities: list[GsaAccessControlEntity] - - self.entities = entities - - @property - def entities(self) -> "list[GsaAccessControlEntity]": - """Gets the entities of this GsaNoSuchSubsetAccessControlEntitiesErrorDetail. - - Returns - ------- - list[GsaAccessControlEntity] - The entities of this GsaNoSuchSubsetAccessControlEntitiesErrorDetail. - """ - return self._entities - - @entities.setter - def entities(self, entities: "list[GsaAccessControlEntity]") -> None: - """Sets the entities of this GsaNoSuchSubsetAccessControlEntitiesErrorDetail. - - Parameters - ---------- - entities: list[GsaAccessControlEntity] - The entities of this GsaNoSuchSubsetAccessControlEntitiesErrorDetail. - """ - # Field is not nullable - if entities is None: - raise ValueError("Invalid value for 'entities', must not be 'None'") - # Field is required - if entities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entities', must not be 'Unset'") - self._entities = entities - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchSubsetAccessControlEntitiesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_table_mapping_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_table_mapping_error_detail.py deleted file mode 100644 index e3ad15da..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_table_mapping_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchTableMappingErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.NOSUCHTABLEMAPPING, - table_guid: "str", - ) -> None: - """GsaNoSuchTableMappingErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._table_guid: str - - self.table_guid = table_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaNoSuchTableMappingErrorDetail. - - Returns - ------- - str - The table_guid of this GsaNoSuchTableMappingErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaNoSuchTableMappingErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaNoSuchTableMappingErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchTableMappingErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tables_reorder_tables_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tables_reorder_tables_error_detail.py deleted file mode 100644 index 8f9babe9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tables_reorder_tables_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_reorder_tables_error_detail import ( # noqa: F401 - GsaReorderTablesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_reorder_tables_error_reason import ( - GsaReorderTablesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchTablesReorderTablesErrorDetail(GsaReorderTablesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaReorderTablesErrorReason", - "invalid_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "invalid_guids": "invalidGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaReorderTablesErrorReason" = GsaReorderTablesErrorReason.NOSUCHTABLES, - invalid_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchTablesReorderTablesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaReorderTablesErrorReason - invalid_guids: list[str] | None, optional - """ - super().__init__(message=message, reason=reason) - self._invalid_guids: list[str] | None | Unset_Type = Unset - - if invalid_guids is not Unset: - self.invalid_guids = invalid_guids - - @property - def invalid_guids(self) -> "list[str] | None | Unset_Type": - """Gets the invalid_guids of this GsaNoSuchTablesReorderTablesErrorDetail. - - Returns - ------- - list[str] | None | Unset_Type - The invalid_guids of this GsaNoSuchTablesReorderTablesErrorDetail. - """ - return self._invalid_guids - - @invalid_guids.setter - def invalid_guids(self, invalid_guids: "list[str] | None | Unset_Type") -> None: - """Sets the invalid_guids of this GsaNoSuchTablesReorderTablesErrorDetail. - - Parameters - ---------- - invalid_guids: list[str] | None | Unset_Type - The invalid_guids of this GsaNoSuchTablesReorderTablesErrorDetail. - """ - self._invalid_guids = invalid_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchTablesReorderTablesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tabular_column_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tabular_column_attribute_error_detail.py deleted file mode 100644 index 344ab5d6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_tabular_column_attribute_error_detail.py +++ /dev/null @@ -1,254 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchTabularColumnAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "attribute_guid": "str", - "column_guid": "str", - "database_key": "str", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "attribute_guid": "attributeGuid", - "column_guid": "columnGuid", - "database_key": "databaseKey", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.NOSUCHTABULARCOLUMN, - attribute_guid: "str | Unset_Type" = Unset, - column_guid: "str | Unset_Type" = Unset, - database_key: "str | None | Unset_Type" = Unset, - table_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchTabularColumnAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - attribute_guid: str, optional - column_guid: str, optional - database_key: str | None, optional - table_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._database_key: str | None | Unset_Type = Unset - self._table_guid: str | Unset_Type = Unset - self._attribute_guid: str | Unset_Type = Unset - self._column_guid: str | Unset_Type = Unset - - if database_key is not Unset: - self.database_key = database_key - if table_guid is not Unset: - self.table_guid = table_guid - if attribute_guid is not Unset: - self.attribute_guid = attribute_guid - if column_guid is not Unset: - self.column_guid = column_guid - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - self._database_key = database_key - - @property - def table_guid(self) -> "str | Unset_Type": - """Gets the table_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Returns - ------- - str | Unset_Type - The table_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | Unset_Type") -> None: - """Sets the table_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Parameters - ---------- - table_guid: str | Unset_Type - The table_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - self._table_guid = table_guid - - @property - def attribute_guid(self) -> "str | Unset_Type": - """Gets the attribute_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Returns - ------- - str | Unset_Type - The attribute_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str | Unset_Type") -> None: - """Sets the attribute_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Parameters - ---------- - attribute_guid: str | Unset_Type - The attribute_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - self._attribute_guid = attribute_guid - - @property - def column_guid(self) -> "str | Unset_Type": - """Gets the column_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Returns - ------- - str | Unset_Type - The column_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - return self._column_guid - - @column_guid.setter - def column_guid(self, column_guid: "str | Unset_Type") -> None: - """Sets the column_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - - Parameters - ---------- - column_guid: str | Unset_Type - The column_guid of this GsaNoSuchTabularColumnAttributeErrorDetail. - """ - # Field is not nullable - if column_guid is None: - raise ValueError("Invalid value for 'column_guid', must not be 'None'") - self._column_guid = column_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchTabularColumnAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_target_table_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_target_table_record_link_group_error_detail.py deleted file mode 100644 index d095b91e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_target_table_record_link_group_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchTargetTableRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key": "str", - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "database_key": "databaseKey", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key: "str", - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NOSUCHTARGETTABLE, - table_guid: "str", - ) -> None: - """GsaNoSuchTargetTableRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - database_key: str - message: str - reason: GsaRecordLinkGroupErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._database_key: str - self._table_guid: str - - self.database_key = database_key - self.table_guid = table_guid - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Returns - ------- - str - The database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Parameters - ---------- - database_key: str - The database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Returns - ------- - str - The table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchTargetTableRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_constant_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_constant_error_detail.py deleted file mode 100644 index a9c63c3b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_constant_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_constant_error_detail import ( # noqa: F401 - GsaConstantErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_constant_error_reason import ( - GsaConstantErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitConstantErrorDetail(GsaConstantErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaConstantErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaConstantErrorReason" = GsaConstantErrorReason.NOSUCHUNIT, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitConstantErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaConstantErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitConstantErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitConstantErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitConstantErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitConstantErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitConstantErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_parameter_error_detail.py deleted file mode 100644 index e9de9e0c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_parameter_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NOSUCHUNIT, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitParameterErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitParameterErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitParameterErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitParameterErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_system_unit_equivalent_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_system_unit_equivalent_error_detail.py deleted file mode 100644 index 019d8dc7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_system_unit_equivalent_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitSystemUnitEquivalentErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.NOSUCHUNITSYSTEM, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitSystemUnitEquivalentErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitSystemUnitEquivalentErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_unit_equivalent_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_unit_equivalent_error_detail.py deleted file mode 100644 index 741d08b5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_no_such_unit_unit_equivalent_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitUnitEquivalentErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.NOSUCHUNIT, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitUnitEquivalentErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitUnitEquivalentErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_non_custom_standard_name_cannot_be_changed_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_non_custom_standard_name_cannot_be_changed_error_detail.py deleted file mode 100644 index 007ef781..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_non_custom_standard_name_cannot_be_changed_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNonCustomStandardNameCannotBeChangedErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "standard_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "standard_name": "standardName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.NONCUSTOMSTANDARDNAMECANNOTBECHANGED, - standard_name: "str", - ) -> None: - """GsaNonCustomStandardNameCannotBeChangedErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - standard_name: str - """ - super().__init__(message=message, reason=reason) - self._standard_name: str - - self.standard_name = standard_name - - @property - def standard_name(self) -> "str": - """Gets the standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - - Returns - ------- - str - The standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - """ - return self._standard_name - - @standard_name.setter - def standard_name(self, standard_name: "str") -> None: - """Sets the standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - - Parameters - ---------- - standard_name: str - The standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - """ - # Field is not nullable - if standard_name is None: - raise ValueError("Invalid value for 'standard_name', must not be 'None'") - # Field is required - if standard_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'standard_name', must not be 'Unset'") - self._standard_name = standard_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNonCustomStandardNameCannotBeChangedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_the_latest_version_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_the_latest_version_error_detail.py index f45c58fa..5d5a55c4 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_the_latest_version_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_the_latest_version_error_detail.py @@ -36,9 +36,6 @@ from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_detail import ( # noqa: F401 GsaVersionControlErrorDetail, ) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_reason import ( - GsaVersionControlErrorReason, -) from . import ModelBase, Unset, Unset_Type @@ -69,7 +66,7 @@ class GsaNotTheLatestVersionErrorDetail(GsaVersionControlErrorDetail): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaVersionControlErrorReason", + "reason": "str", "newer_version": "GsaSlimRecordVersion", } @@ -89,7 +86,7 @@ def __init__( self, *, message: "str", - reason: "GsaVersionControlErrorReason" = GsaVersionControlErrorReason.NOTTHELATESTVERSION, + reason: "str" = "notTheLatestVersion", newer_version: "GsaSlimRecordVersion | Unset_Type" = Unset, ) -> None: """GsaNotTheLatestVersionErrorDetail - a model defined in Swagger @@ -97,7 +94,7 @@ def __init__( Parameters ---------- message: str - reason: GsaVersionControlErrorReason + reason: str newer_version: GsaSlimRecordVersion, optional """ super().__init__(message=message, reason=reason) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_versioned_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_versioned_error_detail.py index 31811944..8bf2b782 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_versioned_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_not_versioned_error_detail.py @@ -36,9 +36,6 @@ from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_detail import ( # noqa: F401 GsaVersionControlErrorDetail, ) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_version_control_error_reason import ( - GsaVersionControlErrorReason, -) from . import ModelBase, Unset, Unset_Type @@ -69,7 +66,7 @@ class GsaNotVersionedErrorDetail(GsaVersionControlErrorDetail): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaVersionControlErrorReason", + "reason": "str", } attribute_map: dict[str, str] = { @@ -85,14 +82,14 @@ def __init__( self, *, message: "str", - reason: "GsaVersionControlErrorReason" = GsaVersionControlErrorReason.NOTVERSIONED, + reason: "str" = "notVersioned", ) -> None: """GsaNotVersionedErrorDetail - a model defined in Swagger Parameters ---------- message: str - reason: GsaVersionControlErrorReason + reason: str """ super().__init__(message=message, reason=reason) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_number_parsing_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_number_parsing_unit_equation_error_detail.py deleted file mode 100644 index d0891b97..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_number_parsing_unit_equation_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNumberParsingUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "invalid_number": "str", - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "invalid_number": "invalidNumber", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - invalid_number: "str", - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.NUMBERPARSING, - ) -> None: - """GsaNumberParsingUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - invalid_number: str - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - self._invalid_number: str - - self.invalid_number = invalid_number - - @property - def invalid_number(self) -> "str": - """Gets the invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - - Returns - ------- - str - The invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - """ - return self._invalid_number - - @invalid_number.setter - def invalid_number(self, invalid_number: "str") -> None: - """Sets the invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - - Parameters - ---------- - invalid_number: str - The invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - """ - # Field is not nullable - if invalid_number is None: - raise ValueError("Invalid value for 'invalid_number', must not be 'None'") - # Field is required - if invalid_number is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'invalid_number', must not be 'Unset'") - self._invalid_number = invalid_number - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNumberParsingUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter.py index f1275098..2a0f35d6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter.py @@ -73,6 +73,7 @@ class GsaNumericParameter(GsaParameter): "scale_type": "GsaParameterScaleType", "type": "GsaParameterType", "values": "list[GsaNumericParameterValue]", + "help_path": "str", "unit": "GsaSlimUnit", } @@ -86,6 +87,7 @@ class GsaNumericParameter(GsaParameter): "scale_type": "scaleType", "type": "type", "values": "values", + "help_path": "helpPath", "unit": "unit", } @@ -110,6 +112,7 @@ def __init__( scale_type: "GsaParameterScaleType", type: "GsaParameterType" = GsaParameterType.NUMERIC, values: "list[GsaNumericParameterValue]", + help_path: "str | None | Unset_Type" = Unset, unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: """GsaNumericParameter - a model defined in Swagger @@ -125,6 +128,7 @@ def __init__( scale_type: GsaParameterScaleType type: GsaParameterType values: list[GsaNumericParameterValue] + help_path: str | None, optional unit: GsaSlimUnit, optional """ super().__init__( @@ -133,6 +137,7 @@ def __init__( guid=guid, name=name, type=type, + help_path=help_path, ) self._is_restricted: bool self._unit: GsaSlimUnit | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter_value.py index 9065a21b..0012b63e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_parameter_value.py @@ -72,7 +72,6 @@ class GsaNumericParameterValue(GsaParameterValue): "type": "GsaParameterValueType", "value": "float", "name": "str", - "parameter_guid": "str", } attribute_map: dict[str, str] = { @@ -80,7 +79,6 @@ class GsaNumericParameterValue(GsaParameterValue): "type": "type", "value": "value", "name": "name", - "parameter_guid": "parameterGuid", } subtype_mapping: dict[str, str] = {} @@ -94,7 +92,6 @@ def __init__( type: "GsaParameterValueType" = GsaParameterValueType.NUMERIC, value: "float", name: "str | None | Unset_Type" = Unset, - parameter_guid: "str | Unset_Type" = Unset, ) -> None: """GsaNumericParameterValue - a model defined in Swagger @@ -104,9 +101,8 @@ def __init__( type: GsaParameterValueType value: float name: str | None, optional - parameter_guid: str, optional """ - super().__init__(guid=guid, type=type, parameter_guid=parameter_guid) + super().__init__(guid=guid, type=type) self._value: float self._name: str | None | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_restricted_interpolation_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_restricted_interpolation_parameter_error_detail.py deleted file mode 100644 index 2f2651cb..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_numeric_restricted_interpolation_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNumericRestrictedInterpolationParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NUMERICRESTRICTEDINTERPOLATION, - ) -> None: - """GsaNumericRestrictedInterpolationParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNumericRestrictedInterpolationParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_item_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_item_type.py deleted file mode 100644 index a362c754..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_item_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPaginatedItemType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - XYCHARTTEMPLATE = "xyChartTemplate" - ACTIVITYLOG = "activityLog" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_response_of.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_response_of.py deleted file mode 100644 index 16a9c65c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_paginated_response_of.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPaginatedResponseOf(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entries": "list[GsaTItem]", - "item_type": "GsaPaginatedItemType", - "links": "GsaPaginationLinks", - } - - attribute_map: dict[str, str] = { - "entries": "entries", - "item_type": "itemType", - "links": "links", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaPaginatedItemType", - "entries": "GsaTItem", - "links": "GsaPaginationLinks", - } - - discriminator_value_class_map = { - "xyChartTemplate".lower(): "#/components/schemas/GsaXYChartTemplatesInfo", - "activityLog".lower(): "#/components/schemas/GsaActivityLogEntriesInfo", - } - - discriminator: Optional[str] = "itemType" - - def __init__( - self, - *, - entries: "list[GsaTItem]", - item_type: "GsaPaginatedItemType", - links: "GsaPaginationLinks", - ) -> None: - """GsaPaginatedResponseOf - a model defined in Swagger - - Parameters - ---------- - entries: list[GsaTItem] - item_type: GsaPaginatedItemType - links: GsaPaginationLinks - """ - self._item_type: GsaPaginatedItemType - self._entries: list[GsaTItem] - self._links: GsaPaginationLinks - - self.item_type = item_type - self.entries = entries - self.links = links - - @property - def item_type(self) -> "GsaPaginatedItemType": - """Gets the item_type of this GsaPaginatedResponseOf. - - Returns - ------- - GsaPaginatedItemType - The item_type of this GsaPaginatedResponseOf. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaPaginatedItemType") -> None: - """Sets the item_type of this GsaPaginatedResponseOf. - - Parameters - ---------- - item_type: GsaPaginatedItemType - The item_type of this GsaPaginatedResponseOf. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def entries(self) -> "list[GsaTItem]": - """Gets the entries of this GsaPaginatedResponseOf. - - Returns - ------- - list[GsaTItem] - The entries of this GsaPaginatedResponseOf. - """ - return self._entries - - @entries.setter - def entries(self, entries: "list[GsaTItem]") -> None: - """Sets the entries of this GsaPaginatedResponseOf. - - Parameters - ---------- - entries: list[GsaTItem] - The entries of this GsaPaginatedResponseOf. - """ - # Field is not nullable - if entries is None: - raise ValueError("Invalid value for 'entries', must not be 'None'") - # Field is required - if entries is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entries', must not be 'Unset'") - self._entries = entries - - @property - def links(self) -> "GsaPaginationLinks": - """Gets the links of this GsaPaginatedResponseOf. - - Returns - ------- - GsaPaginationLinks - The links of this GsaPaginatedResponseOf. - """ - return self._links - - @links.setter - def links(self, links: "GsaPaginationLinks") -> None: - """Sets the links of this GsaPaginatedResponseOf. - - Parameters - ---------- - links: GsaPaginationLinks - The links of this GsaPaginatedResponseOf. - """ - # Field is not nullable - if links is None: - raise ValueError("Invalid value for 'links', must not be 'None'") - # Field is required - if links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'links', must not be 'Unset'") - self._links = links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPaginatedResponseOf): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_pagination_links.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_pagination_links.py deleted file mode 100644 index a2a506a4..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_pagination_links.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPaginationLinks(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "next": "str", - } - - attribute_map: dict[str, str] = { - "next": "next", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - next: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPaginationLinks - a model defined in Swagger - - Parameters - ---------- - next: str | None, optional - """ - self._next: str | None | Unset_Type = Unset - - if next is not Unset: - self.next = next - - @property - def next(self) -> "str | None | Unset_Type": - """Gets the next of this GsaPaginationLinks. - - Returns - ------- - str | None | Unset_Type - The next of this GsaPaginationLinks. - """ - return self._next - - @next.setter - def next(self, next: "str | None | Unset_Type") -> None: - """Sets the next of this GsaPaginationLinks. - - Parameters - ---------- - next: str | None | Unset_Type - The next of this GsaPaginationLinks. - """ - self._next = next - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPaginationLinks): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter.py index b168d71f..9b683268 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter.py @@ -68,6 +68,7 @@ class GsaParameter(ModelBase): "guid": "str", "name": "str", "type": "GsaParameterType", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -76,6 +77,7 @@ class GsaParameter(ModelBase): "guid": "guid", "name": "name", "type": "type", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -97,6 +99,7 @@ def __init__( guid: "str", name: "str", type: "GsaParameterType", + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaParameter - a model defined in Swagger @@ -107,14 +110,18 @@ def __init__( guid: str name: str type: GsaParameterType + help_path: str | None, optional """ self._type: GsaParameterType + self._help_path: str | None | Unset_Type = Unset self._default_parameter_value_guid: str self._display_names: dict[str, str] self._name: str self._guid: str self.type = type + if help_path is not Unset: + self.help_path = help_path self.default_parameter_value_guid = default_parameter_value_guid self.display_names = display_names self.name = name @@ -148,6 +155,28 @@ def type(self, type: "GsaParameterType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def help_path(self) -> "str | None | Unset_Type": + """Gets the help_path of this GsaParameter. + + Returns + ------- + str | None | Unset_Type + The help_path of this GsaParameter. + """ + return self._help_path + + @help_path.setter + def help_path(self, help_path: "str | None | Unset_Type") -> None: + """Sets the help_path of this GsaParameter. + + Parameters + ---------- + help_path: str | None | Unset_Type + The help_path of this GsaParameter. + """ + self._help_path = help_path + @property def default_parameter_value_guid(self) -> "str": """Gets the default_parameter_value_guid of this GsaParameter. @@ -181,7 +210,6 @@ def default_parameter_value_guid(self, default_parameter_value_guid: "str") -> N @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -193,7 +221,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_creation_exception.py deleted file mode 100644 index 16b518bc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_creation_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaParameterCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaParameterErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaParameterCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaParameterCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaParameterCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaParameterCreationException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaParameterErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterCreationException. - - Returns - ------- - list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterCreationException. - - Parameters - ---------- - errors: list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_deletion_exception.py index d021eed1..9a0aa2b5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_deletion_exception.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaParameterDeletionException(GsaDeletionException): +class GsaParameterDeletionException(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,31 +61,28 @@ class GsaParameterDeletionException(GsaDeletionException): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", "code": "code", "errors": "errors", "message": "message", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "code": "SystemNetHttpStatusCode", + "errors": "GsaDataModificationErrorDetail", + } discriminator: Optional[str] = None def __init__( self, *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.PARAMETER, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -100,19 +90,89 @@ def __init__( Parameters ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) + self._message: str | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset + + if message is not Unset: + self.message = message + if code is not Unset: + self.code = code + if errors is not Unset: + self.errors = errors + + @property + def message(self) -> "str | None | Unset_Type": + """Gets the message of this GsaParameterDeletionException. + + Returns + ------- + str | None | Unset_Type + The message of this GsaParameterDeletionException. + """ + return self._message + + @message.setter + def message(self, message: "str | None | Unset_Type") -> None: + """Sets the message of this GsaParameterDeletionException. + + Parameters + ---------- + message: str | None | Unset_Type + The message of this GsaParameterDeletionException. + """ + self._message = message + + @property + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": + """Gets the code of this GsaParameterDeletionException. + + Returns + ------- + SystemNetHttpStatusCode | Unset_Type + The code of this GsaParameterDeletionException. + """ + return self._code + + @code.setter + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: + """Sets the code of this GsaParameterDeletionException. + + Parameters + ---------- + code: SystemNetHttpStatusCode | Unset_Type + The code of this GsaParameterDeletionException. + """ + # Field is not nullable + if code is None: + raise ValueError("Invalid value for 'code', must not be 'None'") + self._code = code + + @property + def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": + """Gets the errors of this GsaParameterDeletionException. + + Returns + ------- + list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaParameterDeletionException. + """ + return self._errors + + @errors.setter + def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: + """Sets the errors of this GsaParameterDeletionException. + + Parameters + ---------- + errors: list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaParameterDeletionException. + """ + self._errors = errors @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_detail.py deleted file mode 100644 index 0b0dccf2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_detail.py +++ /dev/null @@ -1,203 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaParameterErrorReason", - } - - discriminator_value_class_map = { - "defaultParameterValueGuid".lower(): "#/components/schemas/GsaDefaultParameterValueGuidParameterErrorDetail", - "defaultParameterValueIndex".lower(): "#/components/schemas/GsaDefaultParameterValueIndexParameterErrorDetail", - "defaultParameterValueIndexWithoutValues".lower(): "#/components/schemas/GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", - "defaultParameterValueIndexAndGuid".lower(): "#/components/schemas/GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityParameterErrorDetail", - "noParameterValues".lower(): "#/components/schemas/GsaNoParameterValuesParameterErrorDetail", - "noSuchUnit".lower(): "#/components/schemas/GsaNoSuchUnitParameterErrorDetail", - "numericRestrictedInterpolation".lower(): "#/components/schemas/GsaNumericRestrictedInterpolationParameterErrorDetail", - "parameterType".lower(): "#/components/schemas/GsaParameterTypeParameterErrorDetail", - "parameterValue".lower(): "#/components/schemas/GsaParameterValueParameterErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason", - ) -> None: - """GsaParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - self._message: str - self._reason: GsaParameterErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaParameterErrorDetail. - - Returns - ------- - str - The message of this GsaParameterErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaParameterErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaParameterErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaParameterErrorReason": - """Gets the reason of this GsaParameterErrorDetail. - - Returns - ------- - GsaParameterErrorReason - The reason of this GsaParameterErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaParameterErrorReason") -> None: - """Sets the reason of this GsaParameterErrorDetail. - - Parameters - ---------- - reason: GsaParameterErrorReason - The reason of this GsaParameterErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_reason.py deleted file mode 100644 index 8133958b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_error_reason.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaParameterErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - DEFAULTPARAMETERVALUEGUID = "defaultParameterValueGuid" - DEFAULTPARAMETERVALUEINDEX = "defaultParameterValueIndex" - DEFAULTPARAMETERVALUEINDEXANDGUID = "defaultParameterValueIndexAndGuid" - DEFAULTPARAMETERVALUEINDEXWITHOUTVALUES = "defaultParameterValueIndexWithoutValues" - NAMEDENTITY = "namedEntity" - NOPARAMETERVALUES = "noParameterValues" - NOSUCHUNIT = "noSuchUnit" - NUMERICRESTRICTEDINTERPOLATION = "numericRestrictedInterpolation" - PARAMETERTYPE = "parameterType" - PARAMETERVALUE = "parameterValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_type_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_type_parameter_error_detail.py deleted file mode 100644 index e1f4aff3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_type_parameter_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterTypeParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "new_parameter_type": "GsaParameterType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "new_parameter_type": "newParameterType", - } - - subtype_mapping: dict[str, str] = { - "newParameterType": "GsaParameterType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.PARAMETERTYPE, - new_parameter_type: "GsaParameterType | Unset_Type" = Unset, - ) -> None: - """GsaParameterTypeParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - new_parameter_type: GsaParameterType, optional - """ - super().__init__(message=message, reason=reason) - self._new_parameter_type: GsaParameterType | Unset_Type = Unset - - if new_parameter_type is not Unset: - self.new_parameter_type = new_parameter_type - - @property - def new_parameter_type(self) -> "GsaParameterType | Unset_Type": - """Gets the new_parameter_type of this GsaParameterTypeParameterErrorDetail. - - Returns - ------- - GsaParameterType | Unset_Type - The new_parameter_type of this GsaParameterTypeParameterErrorDetail. - """ - return self._new_parameter_type - - @new_parameter_type.setter - def new_parameter_type(self, new_parameter_type: "GsaParameterType | Unset_Type") -> None: - """Sets the new_parameter_type of this GsaParameterTypeParameterErrorDetail. - - Parameters - ---------- - new_parameter_type: GsaParameterType | Unset_Type - The new_parameter_type of this GsaParameterTypeParameterErrorDetail. - """ - # Field is not nullable - if new_parameter_type is None: - raise ValueError("Invalid value for 'new_parameter_type', must not be 'None'") - self._new_parameter_type = new_parameter_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterTypeParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_update_exception.py deleted file mode 100644 index 5ed18767..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_update_exception.py +++ /dev/null @@ -1,238 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterErrorDetail]", - "message": "str", - "parameter_guid": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "parameter_guid": "parameterGuid", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - parameter_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaParameterUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterErrorDetail] | None, optional - message: str | None, optional - parameter_guid: str, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._parameter_guid: str | Unset_Type = Unset - self._errors: list[GsaParameterErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaParameterUpdateException. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaParameterUpdateException. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaParameterUpdateException. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaParameterUpdateException. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - - @property - def errors(self) -> "list[GsaParameterErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterUpdateException. - - Returns - ------- - list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterUpdateException. - - Parameters - ---------- - errors: list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value.py index 9794051e..f26d365c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value.py @@ -65,13 +65,11 @@ class GsaParameterValue(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "type": "GsaParameterValueType", - "parameter_guid": "str", } attribute_map: dict[str, str] = { "guid": "guid", "type": "type", - "parameter_guid": "parameterGuid", } subtype_mapping: dict[str, str] = { @@ -90,7 +88,6 @@ def __init__( *, guid: "str", type: "GsaParameterValueType", - parameter_guid: "str | Unset_Type" = Unset, ) -> None: """GsaParameterValue - a model defined in Swagger @@ -98,42 +95,13 @@ def __init__( ---------- guid: str type: GsaParameterValueType - parameter_guid: str, optional """ - self._parameter_guid: str | Unset_Type = Unset self._type: GsaParameterValueType self._guid: str - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid self.type = type self.guid = guid - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaParameterValue. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaParameterValue. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaParameterValue. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaParameterValue. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - @property def type(self) -> "GsaParameterValueType": """Gets the type of this GsaParameterValue. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_creation_exception.py deleted file mode 100644 index 31ea7452..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_creation_exception.py +++ /dev/null @@ -1,267 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterValueErrorDetail]", - "message": "str", - "name": "str", - "parameter_guid": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - "parameter_guid": "parameterGuid", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - parameter_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterValueErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - parameter_guid: str, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._parameter_guid: str | Unset_Type = Unset - self._errors: list[GsaParameterValueErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterValueCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterValueCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterValueCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterValueCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterValueCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterValueCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterValueCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterValueCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaParameterValueCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaParameterValueCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaParameterValueCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaParameterValueCreationException. - """ - self._name = name - - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaParameterValueCreationException. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaParameterValueCreationException. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaParameterValueCreationException. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaParameterValueCreationException. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - - @property - def errors(self) -> "list[GsaParameterValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterValueCreationException. - - Returns - ------- - list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterValueCreationException. - - Parameters - ---------- - errors: list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_deletion_exception.py index a933d345..2db46d17 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_deletion_exception.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaParameterValueDeletionException(GsaDeletionException): +class GsaParameterValueDeletionException(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,31 +61,28 @@ class GsaParameterValueDeletionException(GsaDeletionException): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", "code": "code", "errors": "errors", "message": "message", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "code": "SystemNetHttpStatusCode", + "errors": "GsaDataModificationErrorDetail", + } discriminator: Optional[str] = None def __init__( self, *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.PARAMETERVALUE, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -100,19 +90,89 @@ def __init__( Parameters ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) + self._message: str | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset + + if message is not Unset: + self.message = message + if code is not Unset: + self.code = code + if errors is not Unset: + self.errors = errors + + @property + def message(self) -> "str | None | Unset_Type": + """Gets the message of this GsaParameterValueDeletionException. + + Returns + ------- + str | None | Unset_Type + The message of this GsaParameterValueDeletionException. + """ + return self._message + + @message.setter + def message(self, message: "str | None | Unset_Type") -> None: + """Sets the message of this GsaParameterValueDeletionException. + + Parameters + ---------- + message: str | None | Unset_Type + The message of this GsaParameterValueDeletionException. + """ + self._message = message + + @property + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": + """Gets the code of this GsaParameterValueDeletionException. + + Returns + ------- + SystemNetHttpStatusCode | Unset_Type + The code of this GsaParameterValueDeletionException. + """ + return self._code + + @code.setter + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: + """Sets the code of this GsaParameterValueDeletionException. + + Parameters + ---------- + code: SystemNetHttpStatusCode | Unset_Type + The code of this GsaParameterValueDeletionException. + """ + # Field is not nullable + if code is None: + raise ValueError("Invalid value for 'code', must not be 'None'") + self._code = code + + @property + def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": + """Gets the errors of this GsaParameterValueDeletionException. + + Returns + ------- + list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaParameterValueDeletionException. + """ + return self._errors + + @errors.setter + def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: + """Sets the errors of this GsaParameterValueDeletionException. + + Parameters + ---------- + errors: list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaParameterValueDeletionException. + """ + self._errors = errors @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_detail.py deleted file mode 100644 index 14992b44..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaParameterValueErrorReason", - } - - discriminator_value_class_map = { - "inUse".lower(): "#/components/schemas/GsaInUseParameterValueErrorDetail", - "logScaleNegative".lower(): "#/components/schemas/GsaLogScaleNegativeParameterValueErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityParameterValueErrorDetail", - "nameWhitespace".lower(): "#/components/schemas/GsaNameWhitespaceParameterValueErrorDetail", - "parameterValueType".lower(): "#/components/schemas/GsaParameterValueTypeParameterValueErrorDetail", - "valueNotProvided".lower(): "#/components/schemas/GsaValueNotProvidedParameterValueErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason", - ) -> None: - """GsaParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - """ - self._message: str - self._reason: GsaParameterValueErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaParameterValueErrorDetail. - - Returns - ------- - str - The message of this GsaParameterValueErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaParameterValueErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaParameterValueErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaParameterValueErrorReason": - """Gets the reason of this GsaParameterValueErrorDetail. - - Returns - ------- - GsaParameterValueErrorReason - The reason of this GsaParameterValueErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaParameterValueErrorReason") -> None: - """Sets the reason of this GsaParameterValueErrorDetail. - - Parameters - ---------- - reason: GsaParameterValueErrorReason - The reason of this GsaParameterValueErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_reason.py deleted file mode 100644 index 657db23b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaParameterValueErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - INUSE = "inUse" - LOGSCALENEGATIVE = "logScaleNegative" - NAMEDENTITY = "namedEntity" - NAMEWHITESPACE = "nameWhitespace" - PARAMETERVALUETYPE = "parameterValueType" - VALUENOTPROVIDED = "valueNotProvided" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_parameter_error_detail.py deleted file mode 100644 index 255f25ce..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_parameter_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "errors": "list[GsaParameterValueErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaParameterValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.PARAMETERVALUE, - errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - errors: list[GsaParameterValueErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaParameterValueErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaParameterValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterValueParameterErrorDetail. - - Returns - ------- - list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueParameterErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterValueParameterErrorDetail. - - Parameters - ---------- - errors: list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueParameterErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_type_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_type_parameter_value_error_detail.py deleted file mode 100644 index cca28a2d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_type_parameter_value_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueTypeParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "parameter_type": "GsaParameterType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "parameter_type": "parameterType", - } - - subtype_mapping: dict[str, str] = { - "parameterType": "GsaParameterType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.PARAMETERVALUETYPE, - parameter_type: "GsaParameterType | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueTypeParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - parameter_type: GsaParameterType, optional - """ - super().__init__(message=message, reason=reason) - self._parameter_type: GsaParameterType | Unset_Type = Unset - - if parameter_type is not Unset: - self.parameter_type = parameter_type - - @property - def parameter_type(self) -> "GsaParameterType | Unset_Type": - """Gets the parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - - Returns - ------- - GsaParameterType | Unset_Type - The parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - """ - return self._parameter_type - - @parameter_type.setter - def parameter_type(self, parameter_type: "GsaParameterType | Unset_Type") -> None: - """Sets the parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - - Parameters - ---------- - parameter_type: GsaParameterType | Unset_Type - The parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - """ - # Field is not nullable - if parameter_type is None: - raise ValueError("Invalid value for 'parameter_type', must not be 'None'") - self._parameter_type = parameter_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueTypeParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_update_exception.py deleted file mode 100644 index 193d7a5a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_update_exception.py +++ /dev/null @@ -1,270 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterValueErrorDetail]", - "message": "str", - "parameter_guid": "str", - "parameter_value_guid": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "parameter_guid": "parameterGuid", - "parameter_value_guid": "parameterValueGuid", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - parameter_guid: "str | Unset_Type" = Unset, - parameter_value_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterValueErrorDetail] | None, optional - message: str | None, optional - parameter_guid: str, optional - parameter_value_guid: str, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._parameter_value_guid: str | Unset_Type = Unset - self._parameter_guid: str | Unset_Type = Unset - self._errors: list[GsaParameterValueErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if parameter_value_guid is not Unset: - self.parameter_value_guid = parameter_value_guid - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterValueUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterValueUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterValueUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterValueUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterValueUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterValueUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterValueUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterValueUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def parameter_value_guid(self) -> "str | Unset_Type": - """Gets the parameter_value_guid of this GsaParameterValueUpdateException. - - Returns - ------- - str | Unset_Type - The parameter_value_guid of this GsaParameterValueUpdateException. - """ - return self._parameter_value_guid - - @parameter_value_guid.setter - def parameter_value_guid(self, parameter_value_guid: "str | Unset_Type") -> None: - """Sets the parameter_value_guid of this GsaParameterValueUpdateException. - - Parameters - ---------- - parameter_value_guid: str | Unset_Type - The parameter_value_guid of this GsaParameterValueUpdateException. - """ - # Field is not nullable - if parameter_value_guid is None: - raise ValueError("Invalid value for 'parameter_value_guid', must not be 'None'") - self._parameter_value_guid = parameter_value_guid - - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaParameterValueUpdateException. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaParameterValueUpdateException. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaParameterValueUpdateException. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaParameterValueUpdateException. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - - @property - def errors(self) -> "list[GsaParameterValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterValueUpdateException. - - Returns - ------- - list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterValueUpdateException. - - Parameters - ---------- - errors: list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_used_by_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_used_by_type.py deleted file mode 100644 index 55ead834..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_parameter_value_used_by_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaParameterValueUsedByType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FUNCTIONALDATADEFAULT = "functionalDataDefault" - MULTIVALUEDPOINTDATA = "multiValuedPointData" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission.py index a7232cca..2ae3ce99 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission.py @@ -63,8 +63,8 @@ class GsaPermission(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "description": "str", "role": "str", + "description": "str", "set_message": "str", "unset_message": "str", } @@ -72,8 +72,8 @@ class GsaPermission(ModelBase): attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "description": "description", "role": "role", + "description": "description", "set_message": "setMessage", "unset_message": "unsetMessage", } @@ -87,8 +87,8 @@ def __init__( *, guid: "str", name: "str", + role: "str", description: "str | None | Unset_Type" = Unset, - role: "str | None | Unset_Type" = Unset, set_message: "str | None | Unset_Type" = Unset, unset_message: "str | None | Unset_Type" = Unset, ) -> None: @@ -98,20 +98,19 @@ def __init__( ---------- guid: str name: str + role: str description: str | None, optional - role: str | None, optional set_message: str | None, optional unset_message: str | None, optional """ - self._role: str | None | Unset_Type = Unset + self._role: str self._description: str | None | Unset_Type = Unset self._set_message: str | None | Unset_Type = Unset self._unset_message: str | None | Unset_Type = Unset self._name: str self._guid: str - if role is not Unset: - self.role = role + self.role = role if description is not Unset: self.description = description if set_message is not Unset: @@ -122,25 +121,31 @@ def __init__( self.guid = guid @property - def role(self) -> "str | None | Unset_Type": + def role(self) -> "str": """Gets the role of this GsaPermission. Returns ------- - str | None | Unset_Type + str The role of this GsaPermission. """ return self._role @role.setter - def role(self, role: "str | None | Unset_Type") -> None: + def role(self, role: "str") -> None: """Sets the role of this GsaPermission. Parameters ---------- - role: str | None | Unset_Type + role: str The role of this GsaPermission. """ + # Field is not nullable + if role is None: + raise ValueError("Invalid value for 'role', must not be 'None'") + # Field is required + if role is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'role', must not be 'Unset'") self._role = role @property diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control.py deleted file mode 100644 index 00a83054..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "can_read": "bool", - "can_write": "bool", - "permission": "GsaSlimEntity", - } - - attribute_map: dict[str, str] = { - "can_read": "canRead", - "can_write": "canWrite", - "permission": "permission", - } - - subtype_mapping: dict[str, str] = { - "permission": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - can_read: "bool", - can_write: "bool", - permission: "GsaSlimEntity", - ) -> None: - """GsaPermissionAccessControl - a model defined in Swagger - - Parameters - ---------- - can_read: bool - can_write: bool - permission: GsaSlimEntity - """ - self._permission: GsaSlimEntity - self._can_read: bool - self._can_write: bool - - self.permission = permission - self.can_read = can_read - self.can_write = can_write - - @property - def permission(self) -> "GsaSlimEntity": - """Gets the permission of this GsaPermissionAccessControl. - - Returns - ------- - GsaSlimEntity - The permission of this GsaPermissionAccessControl. - """ - return self._permission - - @permission.setter - def permission(self, permission: "GsaSlimEntity") -> None: - """Sets the permission of this GsaPermissionAccessControl. - - Parameters - ---------- - permission: GsaSlimEntity - The permission of this GsaPermissionAccessControl. - """ - # Field is not nullable - if permission is None: - raise ValueError("Invalid value for 'permission', must not be 'None'") - # Field is required - if permission is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission', must not be 'Unset'") - self._permission = permission - - @property - def can_read(self) -> "bool": - """Gets the can_read of this GsaPermissionAccessControl. - - Returns - ------- - bool - The can_read of this GsaPermissionAccessControl. - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read: "bool") -> None: - """Sets the can_read of this GsaPermissionAccessControl. - - Parameters - ---------- - can_read: bool - The can_read of this GsaPermissionAccessControl. - """ - # Field is not nullable - if can_read is None: - raise ValueError("Invalid value for 'can_read', must not be 'None'") - # Field is required - if can_read is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_read', must not be 'Unset'") - self._can_read = can_read - - @property - def can_write(self) -> "bool": - """Gets the can_write of this GsaPermissionAccessControl. - - Returns - ------- - bool - The can_write of this GsaPermissionAccessControl. - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write: "bool") -> None: - """Sets the can_write of this GsaPermissionAccessControl. - - Parameters - ---------- - can_write: bool - The can_write of this GsaPermissionAccessControl. - """ - # Field is not nullable - if can_write is None: - raise ValueError("Invalid value for 'can_write', must not be 'None'") - # Field is required - if can_write is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_write', must not be 'Unset'") - self._can_write = can_write - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control_aggregate.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control_aggregate.py deleted file mode 100644 index e22772d7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_access_control_aggregate.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionAccessControlAggregate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "can_read_count": "int", - "can_write_count": "int", - "permission": "GsaSlimEntity", - } - - attribute_map: dict[str, str] = { - "can_read_count": "canReadCount", - "can_write_count": "canWriteCount", - "permission": "permission", - } - - subtype_mapping: dict[str, str] = { - "permission": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - can_read_count: "int", - can_write_count: "int", - permission: "GsaSlimEntity", - ) -> None: - """GsaPermissionAccessControlAggregate - a model defined in Swagger - - Parameters - ---------- - can_read_count: int - can_write_count: int - permission: GsaSlimEntity - """ - self._permission: GsaSlimEntity - self._can_read_count: int - self._can_write_count: int - - self.permission = permission - self.can_read_count = can_read_count - self.can_write_count = can_write_count - - @property - def permission(self) -> "GsaSlimEntity": - """Gets the permission of this GsaPermissionAccessControlAggregate. - - Returns - ------- - GsaSlimEntity - The permission of this GsaPermissionAccessControlAggregate. - """ - return self._permission - - @permission.setter - def permission(self, permission: "GsaSlimEntity") -> None: - """Sets the permission of this GsaPermissionAccessControlAggregate. - - Parameters - ---------- - permission: GsaSlimEntity - The permission of this GsaPermissionAccessControlAggregate. - """ - # Field is not nullable - if permission is None: - raise ValueError("Invalid value for 'permission', must not be 'None'") - # Field is required - if permission is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission', must not be 'Unset'") - self._permission = permission - - @property - def can_read_count(self) -> "int": - """Gets the can_read_count of this GsaPermissionAccessControlAggregate. - - Returns - ------- - int - The can_read_count of this GsaPermissionAccessControlAggregate. - """ - return self._can_read_count - - @can_read_count.setter - def can_read_count(self, can_read_count: "int") -> None: - """Sets the can_read_count of this GsaPermissionAccessControlAggregate. - - Parameters - ---------- - can_read_count: int - The can_read_count of this GsaPermissionAccessControlAggregate. - """ - # Field is not nullable - if can_read_count is None: - raise ValueError("Invalid value for 'can_read_count', must not be 'None'") - # Field is required - if can_read_count is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_read_count', must not be 'Unset'") - self._can_read_count = can_read_count - - @property - def can_write_count(self) -> "int": - """Gets the can_write_count of this GsaPermissionAccessControlAggregate. - - Returns - ------- - int - The can_write_count of this GsaPermissionAccessControlAggregate. - """ - return self._can_write_count - - @can_write_count.setter - def can_write_count(self, can_write_count: "int") -> None: - """Sets the can_write_count of this GsaPermissionAccessControlAggregate. - - Parameters - ---------- - can_write_count: int - The can_write_count of this GsaPermissionAccessControlAggregate. - """ - # Field is not nullable - if can_write_count is None: - raise ValueError("Invalid value for 'can_write_count', must not be 'None'") - # Field is required - if can_write_count is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_write_count', must not be 'Unset'") - self._can_write_count = can_write_count - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionAccessControlAggregate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_detail.py deleted file mode 100644 index 501faf49..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_detail.py +++ /dev/null @@ -1,194 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionBasedAccessControlAggregationErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionBasedAccessControlAggregationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionBasedAccessControlAggregationErrorReason", - } - - discriminator_value_class_map = { - "accessControlEntities".lower(): "#/components/schemas/GsaAccessControlEntitiesAggregationErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionBasedAccessControlAggregationErrorReason", - ) -> None: - """GsaPermissionBasedAccessControlAggregationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionBasedAccessControlAggregationErrorReason - """ - self._message: str - self._reason: GsaPermissionBasedAccessControlAggregationErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionBasedAccessControlAggregationErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionBasedAccessControlAggregationErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionBasedAccessControlAggregationErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionBasedAccessControlAggregationErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionBasedAccessControlAggregationErrorReason": - """Gets the reason of this GsaPermissionBasedAccessControlAggregationErrorDetail. - - Returns - ------- - GsaPermissionBasedAccessControlAggregationErrorReason - The reason of this GsaPermissionBasedAccessControlAggregationErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionBasedAccessControlAggregationErrorReason") -> None: - """Sets the reason of this GsaPermissionBasedAccessControlAggregationErrorDetail. - - Parameters - ---------- - reason: GsaPermissionBasedAccessControlAggregationErrorReason - The reason of this GsaPermissionBasedAccessControlAggregationErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionBasedAccessControlAggregationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_reason.py deleted file mode 100644 index ae8aa03a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionBasedAccessControlAggregationErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ACCESSCONTROLENTITIES = "accessControlEntities" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_exception.py deleted file mode 100644 index ee961ca0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_aggregation_exception.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionBasedAccessControlAggregationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaPermissionBasedAccessControlAggregationErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionBasedAccessControlAggregationErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionBasedAccessControlAggregationErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionBasedAccessControlAggregationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaPermissionBasedAccessControlAggregationErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: ( - list[GsaPermissionBasedAccessControlAggregationErrorDetail] | None | Unset_Type - ) = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionBasedAccessControlAggregationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionBasedAccessControlAggregationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionBasedAccessControlAggregationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionBasedAccessControlAggregationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionBasedAccessControlAggregationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionBasedAccessControlAggregationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionBasedAccessControlAggregationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionBasedAccessControlAggregationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors( - self, - ) -> "list[GsaPermissionBasedAccessControlAggregationErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionBasedAccessControlAggregationException. - - Returns - ------- - list[GsaPermissionBasedAccessControlAggregationErrorDetail] | None | Unset_Type - The errors of this GsaPermissionBasedAccessControlAggregationException. - """ - return self._errors - - @errors.setter - def errors( - self, - errors: "list[GsaPermissionBasedAccessControlAggregationErrorDetail] | None | Unset_Type", - ) -> None: - """Sets the errors of this GsaPermissionBasedAccessControlAggregationException. - - Parameters - ---------- - errors: list[GsaPermissionBasedAccessControlAggregationErrorDetail] | None | Unset_Type - The errors of this GsaPermissionBasedAccessControlAggregationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionBasedAccessControlAggregationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_entities_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_entities_error_reason.py deleted file mode 100644 index 8128f42d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_entities_error_reason.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionBasedAccessControlEntitiesErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOSUCHENTITIES = "noSuchEntities" - NOSUCHSUBSET = "noSuchSubset" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_info.py deleted file mode 100644 index 99c5fa1b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_info.py +++ /dev/null @@ -1,124 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_info import ( # noqa: F401 - GsaAccessControlInfo, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionBasedAccessControlInfo(GsaAccessControlInfo): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode" = GsaAccessControlMode.PERMISSIONBASED, - ) -> None: - """GsaPermissionBasedAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - super().__init__(mode=mode) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionBasedAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operation_exception.py deleted file mode 100644 index 1d973840..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operation_exception.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionBasedAccessControlUpdateOperationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionBasedAccessControlUpdateOperationsErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionBasedAccessControlUpdateOperationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: ( - list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail] | None | Unset_Type - ) = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionBasedAccessControlUpdateOperationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionBasedAccessControlUpdateOperationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionBasedAccessControlUpdateOperationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionBasedAccessControlUpdateOperationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionBasedAccessControlUpdateOperationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionBasedAccessControlUpdateOperationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionBasedAccessControlUpdateOperationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionBasedAccessControlUpdateOperationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors( - self, - ) -> "list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionBasedAccessControlUpdateOperationException. - - Returns - ------- - list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail] | None | Unset_Type - The errors of this GsaPermissionBasedAccessControlUpdateOperationException. - """ - return self._errors - - @errors.setter - def errors( - self, - errors: "list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail] | None | Unset_Type", - ) -> None: - """Sets the errors of this GsaPermissionBasedAccessControlUpdateOperationException. - - Parameters - ---------- - errors: list[GsaPermissionBasedAccessControlUpdateOperationsErrorDetail] | None | Unset_Type - The errors of this GsaPermissionBasedAccessControlUpdateOperationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionBasedAccessControlUpdateOperationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_detail.py deleted file mode 100644 index c6a8b88c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionBasedAccessControlUpdateOperationsErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionBasedAccessControlUpdateOperationsErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionBasedAccessControlUpdateOperationsErrorReason", - } - - discriminator_value_class_map = { - "accessControlEntities".lower(): "#/components/schemas/GsaAccessControlEntitiesUpdateOperationsErrorDetail", - "permissionCategories".lower(): "#/components/schemas/GsaPermissionCategoriesUpdateOperationsErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionBasedAccessControlUpdateOperationsErrorReason", - ) -> None: - """GsaPermissionBasedAccessControlUpdateOperationsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionBasedAccessControlUpdateOperationsErrorReason - """ - self._message: str - self._reason: GsaPermissionBasedAccessControlUpdateOperationsErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionBasedAccessControlUpdateOperationsErrorReason": - """Gets the reason of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - - Returns - ------- - GsaPermissionBasedAccessControlUpdateOperationsErrorReason - The reason of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionBasedAccessControlUpdateOperationsErrorReason") -> None: - """Sets the reason of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - - Parameters - ---------- - reason: GsaPermissionBasedAccessControlUpdateOperationsErrorReason - The reason of this GsaPermissionBasedAccessControlUpdateOperationsErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionBasedAccessControlUpdateOperationsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_reason.py deleted file mode 100644 index 5ec39342..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_based_access_control_update_operations_error_reason.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionBasedAccessControlUpdateOperationsErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ACCESSCONTROLENTITIES = "accessControlEntities" - PERMISSIONCATEGORIES = "permissionCategories" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_detail.py deleted file mode 100644 index b1045d58..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoriesAccessControlErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - discriminator_value_class_map = { - "noSuchCategory".lower(): "#/components/schemas/GsaNoSuchCategoryAccessControlErrorDetail", - "noSuchPermission".lower(): "#/components/schemas/GsaNoSuchPermissionAccessControlErrorDetail", - "duplicateCategoryGuids".lower(): "#/components/schemas/GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "duplicatePermissionGuids".lower(): "#/components/schemas/GsaDuplicatePermissionGuidsAccessControlErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason", - ) -> None: - """GsaPermissionCategoriesAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - self._message: str - self._reason: GsaPermissionCategoriesAccessControlErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionCategoriesAccessControlErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionCategoriesAccessControlErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionCategoriesAccessControlErrorReason": - """Gets the reason of this GsaPermissionCategoriesAccessControlErrorDetail. - - Returns - ------- - GsaPermissionCategoriesAccessControlErrorReason - The reason of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionCategoriesAccessControlErrorReason") -> None: - """Sets the reason of this GsaPermissionCategoriesAccessControlErrorDetail. - - Parameters - ---------- - reason: GsaPermissionCategoriesAccessControlErrorReason - The reason of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoriesAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_reason.py deleted file mode 100644 index cf160b0a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_error_reason.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionCategoriesAccessControlErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOSUCHPERMISSION = "noSuchPermission" - NOSUCHCATEGORY = "noSuchCategory" - DUPLICATECATEGORYGUIDS = "duplicateCategoryGuids" - DUPLICATEPERMISSIONGUIDS = "duplicatePermissionGuids" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_update_exception.py deleted file mode 100644 index 4c1b5c44..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_access_control_update_exception.py +++ /dev/null @@ -1,210 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoriesAccessControlUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaPermissionCategoriesAccessControlErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionCategoriesAccessControlErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoriesAccessControlUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaPermissionCategoriesAccessControlErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type = ( - Unset - ) - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoriesAccessControlUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCategoriesAccessControlUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoriesAccessControlUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCategoriesAccessControlUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoriesAccessControlUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoriesAccessControlUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoriesAccessControlUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoriesAccessControlUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoriesAccessControlUpdateException. - - Returns - ------- - list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoriesAccessControlUpdateException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaPermissionCategoriesAccessControlUpdateException. - - Parameters - ---------- - errors: list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoriesAccessControlUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoriesAccessControlUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_info.py index 7e943de8..b1e618dc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_info.py @@ -61,7 +61,7 @@ class GsaPermissionCategoriesInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "categories": "list[GsaPermissionCategory]", + "categories": "list[GsaSlimPermissionCategory]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaPermissionCategoriesInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "categories": "GsaPermissionCategory", + "categories": "GsaSlimPermissionCategory", } discriminator: Optional[str] = None @@ -77,36 +77,36 @@ class GsaPermissionCategoriesInfo(ModelBase): def __init__( self, *, - categories: "list[GsaPermissionCategory]", + categories: "list[GsaSlimPermissionCategory]", ) -> None: """GsaPermissionCategoriesInfo - a model defined in Swagger Parameters ---------- - categories: list[GsaPermissionCategory] + categories: list[GsaSlimPermissionCategory] """ - self._categories: list[GsaPermissionCategory] + self._categories: list[GsaSlimPermissionCategory] self.categories = categories @property - def categories(self) -> "list[GsaPermissionCategory]": + def categories(self) -> "list[GsaSlimPermissionCategory]": """Gets the categories of this GsaPermissionCategoriesInfo. Returns ------- - list[GsaPermissionCategory] + list[GsaSlimPermissionCategory] The categories of this GsaPermissionCategoriesInfo. """ return self._categories @categories.setter - def categories(self, categories: "list[GsaPermissionCategory]") -> None: + def categories(self, categories: "list[GsaSlimPermissionCategory]") -> None: """Sets the categories of this GsaPermissionCategoriesInfo. Parameters ---------- - categories: list[GsaPermissionCategory] + categories: list[GsaSlimPermissionCategory] The categories of this GsaPermissionCategoriesInfo. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_update_operations_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_update_operations_error_detail.py deleted file mode 100644 index 35ff5479..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_categories_update_operations_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_update_operations_error_detail import ( # noqa: F401 - GsaPermissionBasedAccessControlUpdateOperationsErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_based_access_control_update_operations_error_reason import ( - GsaPermissionBasedAccessControlUpdateOperationsErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoriesUpdateOperationsErrorDetail( - GsaPermissionBasedAccessControlUpdateOperationsErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaPermissionCategoriesAccessControlErrorDetail]", - "message": "str", - "reason": "GsaPermissionBasedAccessControlUpdateOperationsErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaPermissionCategoriesAccessControlErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaPermissionCategoriesAccessControlErrorDetail]", - message: "str", - reason: "GsaPermissionBasedAccessControlUpdateOperationsErrorReason" = GsaPermissionBasedAccessControlUpdateOperationsErrorReason.PERMISSIONCATEGORIES, - ) -> None: - """GsaPermissionCategoriesUpdateOperationsErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaPermissionCategoriesAccessControlErrorDetail] - message: str - reason: GsaPermissionBasedAccessControlUpdateOperationsErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaPermissionCategoriesAccessControlErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaPermissionCategoriesAccessControlErrorDetail]": - """Gets the errors of this GsaPermissionCategoriesUpdateOperationsErrorDetail. - - Returns - ------- - list[GsaPermissionCategoriesAccessControlErrorDetail] - The errors of this GsaPermissionCategoriesUpdateOperationsErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionCategoriesAccessControlErrorDetail]") -> None: - """Sets the errors of this GsaPermissionCategoriesUpdateOperationsErrorDetail. - - Parameters - ---------- - errors: list[GsaPermissionCategoriesAccessControlErrorDetail] - The errors of this GsaPermissionCategoriesUpdateOperationsErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoriesUpdateOperationsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category.py index e1a3b9cf..564c8036 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category.py @@ -63,7 +63,7 @@ class GsaPermissionCategory(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "permissions": "list[GsaPermission]", + "permissions": "list[GsaSlimNamedEntity]", } attribute_map: dict[str, str] = { @@ -73,7 +73,7 @@ class GsaPermissionCategory(ModelBase): } subtype_mapping: dict[str, str] = { - "permissions": "GsaPermission", + "permissions": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -83,7 +83,7 @@ def __init__( *, guid: "str", name: "str", - permissions: "list[GsaPermission]", + permissions: "list[GsaSlimNamedEntity]", ) -> None: """GsaPermissionCategory - a model defined in Swagger @@ -91,9 +91,9 @@ def __init__( ---------- guid: str name: str - permissions: list[GsaPermission] + permissions: list[GsaSlimNamedEntity] """ - self._permissions: list[GsaPermission] + self._permissions: list[GsaSlimNamedEntity] self._name: str self._guid: str @@ -102,23 +102,23 @@ def __init__( self.guid = guid @property - def permissions(self) -> "list[GsaPermission]": + def permissions(self) -> "list[GsaSlimNamedEntity]": """Gets the permissions of this GsaPermissionCategory. Returns ------- - list[GsaPermission] + list[GsaSlimNamedEntity] The permissions of this GsaPermissionCategory. """ return self._permissions @permissions.setter - def permissions(self, permissions: "list[GsaPermission]") -> None: + def permissions(self, permissions: "list[GsaSlimNamedEntity]") -> None: """Sets the permissions of this GsaPermissionCategory. Parameters ---------- - permissions: list[GsaPermission] + permissions: list[GsaSlimNamedEntity] The permissions of this GsaPermissionCategory. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control.py deleted file mode 100644 index 42150011..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category": "GsaSlimEntity", - "permission_access_controls": "list[GsaPermissionAccessControl]", - } - - attribute_map: dict[str, str] = { - "category": "category", - "permission_access_controls": "permissionAccessControls", - } - - subtype_mapping: dict[str, str] = { - "category": "GsaSlimEntity", - "permissionAccessControls": "GsaPermissionAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category: "GsaSlimEntity", - permission_access_controls: "list[GsaPermissionAccessControl]", - ) -> None: - """GsaPermissionCategoryAccessControl - a model defined in Swagger - - Parameters - ---------- - category: GsaSlimEntity - permission_access_controls: list[GsaPermissionAccessControl] - """ - self._category: GsaSlimEntity - self._permission_access_controls: list[GsaPermissionAccessControl] - - self.category = category - self.permission_access_controls = permission_access_controls - - @property - def category(self) -> "GsaSlimEntity": - """Gets the category of this GsaPermissionCategoryAccessControl. - - Returns - ------- - GsaSlimEntity - The category of this GsaPermissionCategoryAccessControl. - """ - return self._category - - @category.setter - def category(self, category: "GsaSlimEntity") -> None: - """Sets the category of this GsaPermissionCategoryAccessControl. - - Parameters - ---------- - category: GsaSlimEntity - The category of this GsaPermissionCategoryAccessControl. - """ - # Field is not nullable - if category is None: - raise ValueError("Invalid value for 'category', must not be 'None'") - # Field is required - if category is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category', must not be 'Unset'") - self._category = category - - @property - def permission_access_controls(self) -> "list[GsaPermissionAccessControl]": - """Gets the permission_access_controls of this GsaPermissionCategoryAccessControl. - - Returns - ------- - list[GsaPermissionAccessControl] - The permission_access_controls of this GsaPermissionCategoryAccessControl. - """ - return self._permission_access_controls - - @permission_access_controls.setter - def permission_access_controls( - self, permission_access_controls: "list[GsaPermissionAccessControl]" - ) -> None: - """Sets the permission_access_controls of this GsaPermissionCategoryAccessControl. - - Parameters - ---------- - permission_access_controls: list[GsaPermissionAccessControl] - The permission_access_controls of this GsaPermissionCategoryAccessControl. - """ - # Field is not nullable - if permission_access_controls is None: - raise ValueError("Invalid value for 'permission_access_controls', must not be 'None'") - # Field is required - if permission_access_controls is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_access_controls', must not be 'Unset'") - self._permission_access_controls = permission_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate.py deleted file mode 100644 index edb7e1ec..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryAccessControlAggregate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category": "GsaSlimEntity", - "permission_aggregates": "list[GsaPermissionAccessControlAggregate]", - } - - attribute_map: dict[str, str] = { - "category": "category", - "permission_aggregates": "permissionAggregates", - } - - subtype_mapping: dict[str, str] = { - "category": "GsaSlimEntity", - "permissionAggregates": "GsaPermissionAccessControlAggregate", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category: "GsaSlimEntity", - permission_aggregates: "list[GsaPermissionAccessControlAggregate]", - ) -> None: - """GsaPermissionCategoryAccessControlAggregate - a model defined in Swagger - - Parameters - ---------- - category: GsaSlimEntity - permission_aggregates: list[GsaPermissionAccessControlAggregate] - """ - self._category: GsaSlimEntity - self._permission_aggregates: list[GsaPermissionAccessControlAggregate] - - self.category = category - self.permission_aggregates = permission_aggregates - - @property - def category(self) -> "GsaSlimEntity": - """Gets the category of this GsaPermissionCategoryAccessControlAggregate. - - Returns - ------- - GsaSlimEntity - The category of this GsaPermissionCategoryAccessControlAggregate. - """ - return self._category - - @category.setter - def category(self, category: "GsaSlimEntity") -> None: - """Sets the category of this GsaPermissionCategoryAccessControlAggregate. - - Parameters - ---------- - category: GsaSlimEntity - The category of this GsaPermissionCategoryAccessControlAggregate. - """ - # Field is not nullable - if category is None: - raise ValueError("Invalid value for 'category', must not be 'None'") - # Field is required - if category is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category', must not be 'Unset'") - self._category = category - - @property - def permission_aggregates(self) -> "list[GsaPermissionAccessControlAggregate]": - """Gets the permission_aggregates of this GsaPermissionCategoryAccessControlAggregate. - - Returns - ------- - list[GsaPermissionAccessControlAggregate] - The permission_aggregates of this GsaPermissionCategoryAccessControlAggregate. - """ - return self._permission_aggregates - - @permission_aggregates.setter - def permission_aggregates( - self, permission_aggregates: "list[GsaPermissionAccessControlAggregate]" - ) -> None: - """Sets the permission_aggregates of this GsaPermissionCategoryAccessControlAggregate. - - Parameters - ---------- - permission_aggregates: list[GsaPermissionAccessControlAggregate] - The permission_aggregates of this GsaPermissionCategoryAccessControlAggregate. - """ - # Field is not nullable - if permission_aggregates is None: - raise ValueError("Invalid value for 'permission_aggregates', must not be 'None'") - # Field is required - if permission_aggregates is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_aggregates', must not be 'Unset'") - self._permission_aggregates = permission_aggregates - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryAccessControlAggregate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate_info.py deleted file mode 100644 index b045fa6a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_aggregate_info.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryAccessControlAggregateInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_aggregates": "list[GsaPermissionCategoryAccessControlAggregate]", - "entity_count": "int", - } - - attribute_map: dict[str, str] = { - "category_aggregates": "categoryAggregates", - "entity_count": "entityCount", - } - - subtype_mapping: dict[str, str] = { - "categoryAggregates": "GsaPermissionCategoryAccessControlAggregate", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_aggregates: "list[GsaPermissionCategoryAccessControlAggregate] | None | Unset_Type" = Unset, - entity_count: "int | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryAccessControlAggregateInfo - a model defined in Swagger - - Parameters - ---------- - category_aggregates: list[GsaPermissionCategoryAccessControlAggregate] | None, optional - entity_count: int, optional - """ - self._entity_count: int | Unset_Type = Unset - self._category_aggregates: ( - list[GsaPermissionCategoryAccessControlAggregate] | None | Unset_Type - ) = Unset - - if entity_count is not Unset: - self.entity_count = entity_count - if category_aggregates is not Unset: - self.category_aggregates = category_aggregates - - @property - def entity_count(self) -> "int | Unset_Type": - """Gets the entity_count of this GsaPermissionCategoryAccessControlAggregateInfo. - - Returns - ------- - int | Unset_Type - The entity_count of this GsaPermissionCategoryAccessControlAggregateInfo. - """ - return self._entity_count - - @entity_count.setter - def entity_count(self, entity_count: "int | Unset_Type") -> None: - """Sets the entity_count of this GsaPermissionCategoryAccessControlAggregateInfo. - - Parameters - ---------- - entity_count: int | Unset_Type - The entity_count of this GsaPermissionCategoryAccessControlAggregateInfo. - """ - # Field is not nullable - if entity_count is None: - raise ValueError("Invalid value for 'entity_count', must not be 'None'") - self._entity_count = entity_count - - @property - def category_aggregates( - self, - ) -> "list[GsaPermissionCategoryAccessControlAggregate] | None | Unset_Type": - """Gets the category_aggregates of this GsaPermissionCategoryAccessControlAggregateInfo. - - Returns - ------- - list[GsaPermissionCategoryAccessControlAggregate] | None | Unset_Type - The category_aggregates of this GsaPermissionCategoryAccessControlAggregateInfo. - """ - return self._category_aggregates - - @category_aggregates.setter - def category_aggregates( - self, - category_aggregates: "list[GsaPermissionCategoryAccessControlAggregate] | None | Unset_Type", - ) -> None: - """Sets the category_aggregates of this GsaPermissionCategoryAccessControlAggregateInfo. - - Parameters - ---------- - category_aggregates: list[GsaPermissionCategoryAccessControlAggregate] | None | Unset_Type - The category_aggregates of this GsaPermissionCategoryAccessControlAggregateInfo. - """ - self._category_aggregates = category_aggregates - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryAccessControlAggregateInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_info.py deleted file mode 100644 index 888600cb..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_access_control_info.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryAccessControlInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_access_controls": "list[GsaPermissionCategoryAccessControl]", - } - - attribute_map: dict[str, str] = { - "category_access_controls": "categoryAccessControls", - } - - subtype_mapping: dict[str, str] = { - "categoryAccessControls": "GsaPermissionCategoryAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_access_controls: "list[GsaPermissionCategoryAccessControl] | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - category_access_controls: list[GsaPermissionCategoryAccessControl] | None, optional - """ - self._category_access_controls: ( - list[GsaPermissionCategoryAccessControl] | None | Unset_Type - ) = Unset - - if category_access_controls is not Unset: - self.category_access_controls = category_access_controls - - @property - def category_access_controls( - self, - ) -> "list[GsaPermissionCategoryAccessControl] | None | Unset_Type": - """Gets the category_access_controls of this GsaPermissionCategoryAccessControlInfo. - - Returns - ------- - list[GsaPermissionCategoryAccessControl] | None | Unset_Type - The category_access_controls of this GsaPermissionCategoryAccessControlInfo. - """ - return self._category_access_controls - - @category_access_controls.setter - def category_access_controls( - self, - category_access_controls: "list[GsaPermissionCategoryAccessControl] | None | Unset_Type", - ) -> None: - """Sets the category_access_controls of this GsaPermissionCategoryAccessControlInfo. - - Parameters - ---------- - category_access_controls: list[GsaPermissionCategoryAccessControl] | None | Unset_Type - The category_access_controls of this GsaPermissionCategoryAccessControlInfo. - """ - self._category_access_controls = category_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_creation_exception.py deleted file mode 100644 index 4e5ba46c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaPermissionCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoryCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCategoryCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCategoryCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoryCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaPermissionCategoryCreationException. - - Returns - ------- - str - The name of this GsaPermissionCategoryCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - name: str - The name of this GsaPermissionCategoryCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoryCreationException. - - Returns - ------- - list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_detail.py deleted file mode 100644 index 54975bc6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionCategoryErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityPermissionCategoryErrorDetail", - "noPermissions".lower(): "#/components/schemas/GsaNoPermissionsPermissionCategoryErrorDetail", - "tooManyPermissions".lower(): "#/components/schemas/GsaTooManyPermissionsPermissionCategoryErrorDetail", - "duplicatePermissions".lower(): "#/components/schemas/GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "permission".lower(): "#/components/schemas/GsaPermissionPermissionCategoryErrorDetail", - "noSuchPermissions".lower(): "#/components/schemas/GsaNoSuchPermissionsPermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoryErrorReason", - ) -> None: - """GsaPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoryErrorReason - """ - self._message: str - self._reason: GsaPermissionCategoryErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionCategoryErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionCategoryErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionCategoryErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionCategoryErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionCategoryErrorReason": - """Gets the reason of this GsaPermissionCategoryErrorDetail. - - Returns - ------- - GsaPermissionCategoryErrorReason - The reason of this GsaPermissionCategoryErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionCategoryErrorReason") -> None: - """Sets the reason of this GsaPermissionCategoryErrorDetail. - - Parameters - ---------- - reason: GsaPermissionCategoryErrorReason - The reason of this GsaPermissionCategoryErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_reason.py deleted file mode 100644 index 96cf6afe..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionCategoryErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - NOPERMISSIONS = "noPermissions" - TOOMANYPERMISSIONS = "tooManyPermissions" - DUPLICATEPERMISSIONS = "duplicatePermissions" - PERMISSION = "permission" - NOSUCHPERMISSIONS = "noSuchPermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_replace_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_replace_exception.py deleted file mode 100644 index 0c12f16e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_category_replace_exception.py +++ /dev/null @@ -1,208 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryReplaceException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaReplacePermissionCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaReplacePermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryReplaceException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaReplacePermissionCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoryReplaceException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCategoryReplaceException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoryReplaceException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCategoryReplaceException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoryReplaceException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryReplaceException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoryReplaceException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryReplaceException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoryReplaceException. - - Returns - ------- - list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryReplaceException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaPermissionCategoryReplaceException. - - Parameters - ---------- - errors: list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryReplaceException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryReplaceException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_creation_exception.py deleted file mode 100644 index 4e0b6611..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaPermissionErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaPermissionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaPermissionCreationException. - - Returns - ------- - str - The name of this GsaPermissionCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaPermissionCreationException. - - Parameters - ---------- - name: str - The name of this GsaPermissionCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaPermissionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCreationException. - - Returns - ------- - list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionCreationException. - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_detail.py deleted file mode 100644 index 5e8c3e5b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_detail.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionDeletionErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionDeletionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionDeletionErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionDeletionErrorReason", - ) -> None: - """GsaPermissionDeletionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionDeletionErrorReason - """ - self._message: str - self._reason: GsaPermissionDeletionErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionDeletionErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionDeletionErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionDeletionErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionDeletionErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionDeletionErrorReason": - """Gets the reason of this GsaPermissionDeletionErrorDetail. - - Returns - ------- - GsaPermissionDeletionErrorReason - The reason of this GsaPermissionDeletionErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionDeletionErrorReason") -> None: - """Sets the reason of this GsaPermissionDeletionErrorDetail. - - Parameters - ---------- - reason: GsaPermissionDeletionErrorReason - The reason of this GsaPermissionDeletionErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionDeletionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_reason.py deleted file mode 100644 index 3f603626..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionDeletionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CATEGORYMUSTHAVEPERMISSIONS = "categoryMustHavePermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_exception.py deleted file mode 100644 index c62df4fa..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_deletion_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionDeletionErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionDeletionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionDeletionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionDeletionException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaPermissionDeletionErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaPermissionDeletionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaPermissionDeletionException. - - Returns - ------- - str - The guid of this GsaPermissionDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaPermissionDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaPermissionDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionDeletionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionDeletionException. - - Returns - ------- - list[GsaPermissionDeletionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionDeletionException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionDeletionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionDeletionException. - - Parameters - ---------- - errors: list[GsaPermissionDeletionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_detail.py deleted file mode 100644 index e7470c9a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityPermissionErrorDetail", - "roleNotProvided".lower(): "#/components/schemas/GsaRoleNotProvidedPermissionErrorDetail", - "maxPermissionsReached".lower(): "#/components/schemas/GsaMaxPermissionsReachedPermissionErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionErrorReason", - ) -> None: - """GsaPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionErrorReason - """ - self._message: str - self._reason: GsaPermissionErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionErrorReason": - """Gets the reason of this GsaPermissionErrorDetail. - - Returns - ------- - GsaPermissionErrorReason - The reason of this GsaPermissionErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionErrorReason") -> None: - """Sets the reason of this GsaPermissionErrorDetail. - - Parameters - ---------- - reason: GsaPermissionErrorReason - The reason of this GsaPermissionErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_reason.py deleted file mode 100644 index 0b0900ca..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - ROLENOTPROVIDED = "roleNotProvided" - MAXPERMISSIONSREACHED = "maxPermissionsReached" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_permission_category_error_detail.py deleted file mode 100644 index f9163cf2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_permission_category_error_detail.py +++ /dev/null @@ -1,223 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaPermissionErrorDetail]", - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - "guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaPermissionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaPermissionErrorDetail]", - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.PERMISSION, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] - message: str - reason: GsaPermissionCategoryErrorReason - guid: str | None, optional - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - self._errors: list[GsaPermissionErrorDetail] - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - self.errors = errors - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaPermissionPermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaPermissionPermissionCategoryErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaPermissionPermissionCategoryErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaPermissionPermissionCategoryErrorDetail. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaPermissionPermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaPermissionPermissionCategoryErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaPermissionPermissionCategoryErrorDetail. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaPermissionPermissionCategoryErrorDetail. - """ - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionErrorDetail]": - """Gets the errors of this GsaPermissionPermissionCategoryErrorDetail. - - Returns - ------- - list[GsaPermissionErrorDetail] - The errors of this GsaPermissionPermissionCategoryErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionErrorDetail]") -> None: - """Sets the errors of this GsaPermissionPermissionCategoryErrorDetail. - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] - The errors of this GsaPermissionPermissionCategoryErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_update_exception.py deleted file mode 100644 index f93b4f19..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permission_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionUpdateException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaPermissionErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaPermissionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaPermissionUpdateException. - - Returns - ------- - str - The guid of this GsaPermissionUpdateException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaPermissionUpdateException. - - Parameters - ---------- - guid: str - The guid of this GsaPermissionUpdateException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionUpdateException. - - Returns - ------- - list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionUpdateException. - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_in_use_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_in_use_info.py deleted file mode 100644 index 3bbbdd4a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_in_use_info.py +++ /dev/null @@ -1,219 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionsInUseInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "max_permissions_available": "int", - "permissions_available_for_use": "int", - "permissions_used": "int", - } - - attribute_map: dict[str, str] = { - "max_permissions_available": "maxPermissionsAvailable", - "permissions_available_for_use": "permissionsAvailableForUse", - "permissions_used": "permissionsUsed", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - max_permissions_available: "int", - permissions_available_for_use: "int", - permissions_used: "int", - ) -> None: - """GsaPermissionsInUseInfo - a model defined in Swagger - - Parameters - ---------- - max_permissions_available: int - permissions_available_for_use: int - permissions_used: int - """ - self._permissions_used: int - self._max_permissions_available: int - self._permissions_available_for_use: int - - self.permissions_used = permissions_used - self.max_permissions_available = max_permissions_available - self.permissions_available_for_use = permissions_available_for_use - - @property - def permissions_used(self) -> "int": - """Gets the permissions_used of this GsaPermissionsInUseInfo. - - Returns - ------- - int - The permissions_used of this GsaPermissionsInUseInfo. - """ - return self._permissions_used - - @permissions_used.setter - def permissions_used(self, permissions_used: "int") -> None: - """Sets the permissions_used of this GsaPermissionsInUseInfo. - - Parameters - ---------- - permissions_used: int - The permissions_used of this GsaPermissionsInUseInfo. - """ - # Field is not nullable - if permissions_used is None: - raise ValueError("Invalid value for 'permissions_used', must not be 'None'") - # Field is required - if permissions_used is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permissions_used', must not be 'Unset'") - self._permissions_used = permissions_used - - @property - def max_permissions_available(self) -> "int": - """Gets the max_permissions_available of this GsaPermissionsInUseInfo. - - Returns - ------- - int - The max_permissions_available of this GsaPermissionsInUseInfo. - """ - return self._max_permissions_available - - @max_permissions_available.setter - def max_permissions_available(self, max_permissions_available: "int") -> None: - """Sets the max_permissions_available of this GsaPermissionsInUseInfo. - - Parameters - ---------- - max_permissions_available: int - The max_permissions_available of this GsaPermissionsInUseInfo. - """ - # Field is not nullable - if max_permissions_available is None: - raise ValueError("Invalid value for 'max_permissions_available', must not be 'None'") - # Field is required - if max_permissions_available is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'max_permissions_available', must not be 'Unset'") - self._max_permissions_available = max_permissions_available - - @property - def permissions_available_for_use(self) -> "int": - """Gets the permissions_available_for_use of this GsaPermissionsInUseInfo. - - Returns - ------- - int - The permissions_available_for_use of this GsaPermissionsInUseInfo. - """ - return self._permissions_available_for_use - - @permissions_available_for_use.setter - def permissions_available_for_use(self, permissions_available_for_use: "int") -> None: - """Sets the permissions_available_for_use of this GsaPermissionsInUseInfo. - - Parameters - ---------- - permissions_available_for_use: int - The permissions_available_for_use of this GsaPermissionsInUseInfo. - """ - # Field is not nullable - if permissions_available_for_use is None: - raise ValueError( - "Invalid value for 'permissions_available_for_use', must not be 'None'" - ) - # Field is required - if permissions_available_for_use is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'permissions_available_for_use', must not be 'Unset'" - ) - self._permissions_available_for_use = permissions_available_for_use - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionsInUseInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_info.py index 5bdbcd41..1f41bd86 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_permissions_info.py @@ -61,7 +61,7 @@ class GsaPermissionsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "permissions": "list[GsaPermission]", + "permissions": "list[GsaSlimPermission]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaPermissionsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "permissions": "GsaPermission", + "permissions": "GsaSlimPermission", } discriminator: Optional[str] = None @@ -77,36 +77,36 @@ class GsaPermissionsInfo(ModelBase): def __init__( self, *, - permissions: "list[GsaPermission]", + permissions: "list[GsaSlimPermission]", ) -> None: """GsaPermissionsInfo - a model defined in Swagger Parameters ---------- - permissions: list[GsaPermission] + permissions: list[GsaSlimPermission] """ - self._permissions: list[GsaPermission] + self._permissions: list[GsaSlimPermission] self.permissions = permissions @property - def permissions(self) -> "list[GsaPermission]": + def permissions(self) -> "list[GsaSlimPermission]": """Gets the permissions of this GsaPermissionsInfo. Returns ------- - list[GsaPermission] + list[GsaSlimPermission] The permissions of this GsaPermissionsInfo. """ return self._permissions @permissions.setter - def permissions(self, permissions: "list[GsaPermission]") -> None: + def permissions(self, permissions: "list[GsaSlimPermission]") -> None: """Sets the permissions of this GsaPermissionsInfo. Parameters ---------- - permissions: list[GsaPermission] + permissions: list[GsaSlimPermission] The permissions of this GsaPermissionsInfo. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_picture_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_picture_attribute.py index e69cbe76..2dea2f57 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_picture_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_picture_attribute.py @@ -69,7 +69,6 @@ class GsaPictureAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaPictureAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.PICTURE, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_attribute.py index 584ce421..f11a6304 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_attribute.py @@ -71,7 +71,6 @@ class GsaPointAttribute(GsaAttribute): "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -89,7 +88,6 @@ class GsaPointAttribute(GsaAttribute): "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -116,7 +114,6 @@ def __init__( info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", is_multi_valued: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.POINT, @@ -136,7 +133,6 @@ def __init__( info: GsaAttributeInfo is_hidden_from_search_criteria: bool is_multi_valued: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -151,7 +147,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_chart_data.py deleted file mode 100644 index 5f1f1fe9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_point_chart_data.py +++ /dev/null @@ -1,226 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPointChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "estimated": "bool", - "parameter_values": "str", - "record_version_guid": "str", - "value": "float", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "estimated": "estimated", - "parameter_values": "parameterValues", - "record_version_guid": "recordVersionGuid", - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.POINT, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - estimated: "bool | Unset_Type" = Unset, - parameter_values: "str | None | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - value: "float | Unset_Type" = Unset, - ) -> None: - """GsaPointChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - estimated: bool, optional - parameter_values: str | None, optional - record_version_guid: str, optional - value: float, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._value: float | Unset_Type = Unset - self._estimated: bool | Unset_Type = Unset - self._parameter_values: str | None | Unset_Type = Unset - - if value is not Unset: - self.value = value - if estimated is not Unset: - self.estimated = estimated - if parameter_values is not Unset: - self.parameter_values = parameter_values - - @property - def value(self) -> "float | Unset_Type": - """Gets the value of this GsaPointChartData. - - Returns - ------- - float | Unset_Type - The value of this GsaPointChartData. - """ - return self._value - - @value.setter - def value(self, value: "float | Unset_Type") -> None: - """Sets the value of this GsaPointChartData. - - Parameters - ---------- - value: float | Unset_Type - The value of this GsaPointChartData. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - self._value = value - - @property - def estimated(self) -> "bool | Unset_Type": - """Gets the estimated of this GsaPointChartData. - - Returns - ------- - bool | Unset_Type - The estimated of this GsaPointChartData. - """ - return self._estimated - - @estimated.setter - def estimated(self, estimated: "bool | Unset_Type") -> None: - """Sets the estimated of this GsaPointChartData. - - Parameters - ---------- - estimated: bool | Unset_Type - The estimated of this GsaPointChartData. - """ - # Field is not nullable - if estimated is None: - raise ValueError("Invalid value for 'estimated', must not be 'None'") - self._estimated = estimated - - @property - def parameter_values(self) -> "str | None | Unset_Type": - """Gets the parameter_values of this GsaPointChartData. - - Returns - ------- - str | None | Unset_Type - The parameter_values of this GsaPointChartData. - """ - return self._parameter_values - - @parameter_values.setter - def parameter_values(self, parameter_values: "str | None | Unset_Type") -> None: - """Sets the parameter_values of this GsaPointChartData. - - Parameters - ---------- - parameter_values: str | None | Unset_Type - The parameter_values of this GsaPointChartData. - """ - self._parameter_values = parameter_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPointChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_property.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_property.py index 07e04fa5..fe01561c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_property.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_property.py @@ -75,7 +75,6 @@ class GsaProperty(ModelBase): } discriminator_value_class_map = { - "breadcrumbs".lower(): "#/components/schemas/GsaBreadcrumbsProperty", "createdByUser".lower(): "#/components/schemas/GsaCreatedByUserProperty", "createdDate".lower(): "#/components/schemas/GsaCreatedDateProperty", "databaseKey".lower(): "#/components/schemas/GsaDatabaseKeyProperty", diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_discrete_value.py deleted file mode 100644 index 2e07fce7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_discrete_value.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPutDiscreteValue(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaPutType", - } - - discriminator_value_class_map = { - "create".lower(): "#/components/schemas/GsaCreatePutDiscreteValue", - "update".lower(): "#/components/schemas/GsaUpdatePutDiscreteValue", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaPutType", - ) -> None: - """GsaPutDiscreteValue - a model defined in Swagger - - Parameters - ---------- - type: GsaPutType - """ - self._type: GsaPutType - - self.type = type - - @property - def type(self) -> "GsaPutType": - """Gets the type of this GsaPutDiscreteValue. - - Returns - ------- - GsaPutType - The type of this GsaPutDiscreteValue. - """ - return self._type - - @type.setter - def type(self, type: "GsaPutType") -> None: - """Sets the type of this GsaPutDiscreteValue. - - Parameters - ---------- - type: GsaPutType - The type of this GsaPutDiscreteValue. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPutDiscreteValue): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_layout_item.py deleted file mode 100644 index f094d40b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_layout_item.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPutLayoutItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaPutType", - } - - discriminator_value_class_map = { - "create".lower(): "#/components/schemas/GsaCreatePutLayoutItem", - "update".lower(): "#/components/schemas/GsaUpdatePutLayoutItem", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaPutType", - ) -> None: - """GsaPutLayoutItem - a model defined in Swagger - - Parameters - ---------- - type: GsaPutType - """ - self._type: GsaPutType - - self.type = type - - @property - def type(self) -> "GsaPutType": - """Gets the type of this GsaPutLayoutItem. - - Returns - ------- - GsaPutType - The type of this GsaPutLayoutItem. - """ - return self._type - - @type.setter - def type(self, type: "GsaPutType") -> None: - """Sets the type of this GsaPutLayoutItem. - - Parameters - ---------- - type: GsaPutType - The type of this GsaPutLayoutItem. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission.py deleted file mode 100644 index 0546d5f1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPutPermission(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaPutType", - } - - discriminator_value_class_map = { - "create".lower(): "#/components/schemas/GsaCreatePutPermission", - "update".lower(): "#/components/schemas/GsaUpdatePutPermission", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaPutType", - ) -> None: - """GsaPutPermission - a model defined in Swagger - - Parameters - ---------- - type: GsaPutType - """ - self._type: GsaPutType - - self.type = type - - @property - def type(self) -> "GsaPutType": - """Gets the type of this GsaPutPermission. - - Returns - ------- - GsaPutType - The type of this GsaPutPermission. - """ - return self._type - - @type.setter - def type(self, type: "GsaPutType") -> None: - """Sets the type of this GsaPutPermission. - - Parameters - ---------- - type: GsaPutType - The type of this GsaPutPermission. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPutPermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission_category.py deleted file mode 100644 index bf35e927..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_permission_category.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPutPermissionCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaPutType", - } - - discriminator_value_class_map = { - "create".lower(): "#/components/schemas/GsaCreatePutPermissionCategory", - "update".lower(): "#/components/schemas/GsaUpdatePutPermissionCategory", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaPutType", - ) -> None: - """GsaPutPermissionCategory - a model defined in Swagger - - Parameters - ---------- - type: GsaPutType - """ - self._type: GsaPutType - - self.type = type - - @property - def type(self) -> "GsaPutType": - """Gets the type of this GsaPutPermissionCategory. - - Returns - ------- - GsaPutType - The type of this GsaPutPermissionCategory. - """ - return self._type - - @type.setter - def type(self, type: "GsaPutType") -> None: - """Sets the type of this GsaPutPermissionCategory. - - Parameters - ---------- - type: GsaPutType - The type of this GsaPutPermissionCategory. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPutPermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_type.py deleted file mode 100644 index 0ec53480..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_put_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPutType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CREATE = "create" - UPDATE = "update" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value.py deleted file mode 100644 index fb0361a4..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value.py +++ /dev/null @@ -1,215 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualityDiscreteValue(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "order": "int", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "order": "order", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - order: "int", - ) -> None: - """GsaQualityDiscreteValue - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - order: int - """ - self._order: int - self._name: str - self._guid: str - - self.order = order - self.name = name - self.guid = guid - - @property - def order(self) -> "int": - """Gets the order of this GsaQualityDiscreteValue. - - Returns - ------- - int - The order of this GsaQualityDiscreteValue. - """ - return self._order - - @order.setter - def order(self, order: "int") -> None: - """Sets the order of this GsaQualityDiscreteValue. - - Parameters - ---------- - order: int - The order of this GsaQualityDiscreteValue. - """ - # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - # Field is required - if order is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'order', must not be 'Unset'") - self._order = order - - @property - def name(self) -> "str": - """Gets the name of this GsaQualityDiscreteValue. - - Returns - ------- - str - The name of this GsaQualityDiscreteValue. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaQualityDiscreteValue. - - Parameters - ---------- - name: str - The name of this GsaQualityDiscreteValue. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaQualityDiscreteValue. - - Returns - ------- - str - The guid of this GsaQualityDiscreteValue. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaQualityDiscreteValue. - - Parameters - ---------- - guid: str - The guid of this GsaQualityDiscreteValue. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualityDiscreteValue): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_detail.py deleted file mode 100644 index 1ead62af..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_detail.py +++ /dev/null @@ -1,194 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualityDiscreteValueErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaQualityDiscreteValueErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaQualityDiscreteValueErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityQualityDiscreteValueErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaQualityDiscreteValueErrorReason", - ) -> None: - """GsaQualityDiscreteValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaQualityDiscreteValueErrorReason - """ - self._message: str - self._reason: GsaQualityDiscreteValueErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaQualityDiscreteValueErrorDetail. - - Returns - ------- - str - The message of this GsaQualityDiscreteValueErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaQualityDiscreteValueErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaQualityDiscreteValueErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaQualityDiscreteValueErrorReason": - """Gets the reason of this GsaQualityDiscreteValueErrorDetail. - - Returns - ------- - GsaQualityDiscreteValueErrorReason - The reason of this GsaQualityDiscreteValueErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaQualityDiscreteValueErrorReason") -> None: - """Sets the reason of this GsaQualityDiscreteValueErrorDetail. - - Parameters - ---------- - reason: GsaQualityDiscreteValueErrorReason - The reason of this GsaQualityDiscreteValueErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualityDiscreteValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_reason.py deleted file mode 100644 index 6647026b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_value_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaQualityDiscreteValueErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_values_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_values_error_detail.py deleted file mode 100644 index a81089e6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_discrete_values_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_detail import ( # noqa: F401 - GsaQualitySystemErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_reason import ( - GsaQualitySystemErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualityDiscreteValuesErrorDetail(GsaQualitySystemErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaQualityDiscreteValueErrorDetail]", - "message": "str", - "reason": "GsaQualitySystemErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaQualityDiscreteValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaQualityDiscreteValueErrorDetail]", - message: "str", - reason: "GsaQualitySystemErrorReason" = GsaQualitySystemErrorReason.QUALITYDISCRETEVALUES, - ) -> None: - """GsaQualityDiscreteValuesErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaQualityDiscreteValueErrorDetail] - message: str - reason: GsaQualitySystemErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaQualityDiscreteValueErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaQualityDiscreteValueErrorDetail]": - """Gets the errors of this GsaQualityDiscreteValuesErrorDetail. - - Returns - ------- - list[GsaQualityDiscreteValueErrorDetail] - The errors of this GsaQualityDiscreteValuesErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaQualityDiscreteValueErrorDetail]") -> None: - """Sets the errors of this GsaQualityDiscreteValuesErrorDetail. - - Parameters - ---------- - errors: list[GsaQualityDiscreteValueErrorDetail] - The errors of this GsaQualityDiscreteValuesErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualityDiscreteValuesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system.py deleted file mode 100644 index 1d643582..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system.py +++ /dev/null @@ -1,229 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "type": "GsaQualitySystemType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaQualitySystemType", - } - - discriminator_value_class_map = { - "discrete".lower(): "#/components/schemas/GsaDiscreteQualitySystem", - "continuous".lower(): "#/components/schemas/GsaContinuousQualitySystem", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - guid: "str", - name: "str", - type: "GsaQualitySystemType", - ) -> None: - """GsaQualitySystem - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - type: GsaQualitySystemType - """ - self._type: GsaQualitySystemType - self._name: str - self._guid: str - - self.type = type - self.name = name - self.guid = guid - - @property - def type(self) -> "GsaQualitySystemType": - """Gets the type of this GsaQualitySystem. - - Returns - ------- - GsaQualitySystemType - The type of this GsaQualitySystem. - """ - return self._type - - @type.setter - def type(self, type: "GsaQualitySystemType") -> None: - """Sets the type of this GsaQualitySystem. - - Parameters - ---------- - type: GsaQualitySystemType - The type of this GsaQualitySystem. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def name(self) -> "str": - """Gets the name of this GsaQualitySystem. - - Returns - ------- - str - The name of this GsaQualitySystem. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaQualitySystem. - - Parameters - ---------- - name: str - The name of this GsaQualitySystem. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaQualitySystem. - - Returns - ------- - str - The guid of this GsaQualitySystem. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaQualitySystem. - - Parameters - ---------- - guid: str - The guid of this GsaQualitySystem. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_creation_exception.py deleted file mode 100644 index 14469d42..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystemCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaQualitySystemErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaQualitySystemErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaQualitySystemErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQualitySystemCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaQualitySystemErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaQualitySystemErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaQualitySystemCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaQualitySystemCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaQualitySystemCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaQualitySystemCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaQualitySystemCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaQualitySystemCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaQualitySystemCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaQualitySystemCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaQualitySystemCreationException. - - Returns - ------- - str - The name of this GsaQualitySystemCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaQualitySystemCreationException. - - Parameters - ---------- - name: str - The name of this GsaQualitySystemCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaQualitySystemErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaQualitySystemCreationException. - - Returns - ------- - list[GsaQualitySystemErrorDetail] | None | Unset_Type - The errors of this GsaQualitySystemCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaQualitySystemErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaQualitySystemCreationException. - - Parameters - ---------- - errors: list[GsaQualitySystemErrorDetail] | None | Unset_Type - The errors of this GsaQualitySystemCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystemCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_deletion_exception.py deleted file mode 100644 index 8d18d0f6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_deletion_exception.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystemDeletionException(GsaDeletionException): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", - "errors": "list[GsaDataModificationErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.QUALITYSYSTEM, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQualitySystemDeletionException - a model defined in Swagger - - Parameters - ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional - errors: list[GsaDataModificationErrorDetail] | None, optional - message: str | None, optional - """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystemDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_detail.py deleted file mode 100644 index 929f12f6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_detail.py +++ /dev/null @@ -1,198 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystemErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaQualitySystemErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaQualitySystemErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityQualitySystemErrorDetail", - "qualityDiscreteValues".lower(): "#/components/schemas/GsaQualityDiscreteValuesErrorDetail", - "thresholdValueNameInvalid".lower(): "#/components/schemas/GsaThresholdValueNameInvalidErrorDetail", - "thresholdValueNameEmpty".lower(): "#/components/schemas/GsaThresholdValueNameEmptyErrorDetail", - "noQualityDiscreteValues".lower(): "#/components/schemas/GsaNoQualityDiscreteValuesErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaQualitySystemErrorReason", - ) -> None: - """GsaQualitySystemErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaQualitySystemErrorReason - """ - self._message: str - self._reason: GsaQualitySystemErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaQualitySystemErrorDetail. - - Returns - ------- - str - The message of this GsaQualitySystemErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaQualitySystemErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaQualitySystemErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaQualitySystemErrorReason": - """Gets the reason of this GsaQualitySystemErrorDetail. - - Returns - ------- - GsaQualitySystemErrorReason - The reason of this GsaQualitySystemErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaQualitySystemErrorReason") -> None: - """Sets the reason of this GsaQualitySystemErrorDetail. - - Parameters - ---------- - reason: GsaQualitySystemErrorReason - The reason of this GsaQualitySystemErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystemErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_reason.py deleted file mode 100644 index 2c087a5b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_error_reason.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaQualitySystemErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - QUALITYDISCRETEVALUES = "qualityDiscreteValues" - THRESHOLDVALUENAMEINVALID = "thresholdValueNameInvalid" - THRESHOLDVALUENAMEEMPTY = "thresholdValueNameEmpty" - NOQUALITYDISCRETEVALUES = "noQualityDiscreteValues" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_guid_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_guid_error_detail.py deleted file mode 100644 index 37c3f182..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_guid_error_detail.py +++ /dev/null @@ -1,190 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystemGuidErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - "database_key": "str", - "quality_system_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "database_key": "databaseKey", - "quality_system_guid": "qualitySystemGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.QUALITYSYSTEMGUID, - database_key: "str | None | Unset_Type" = Unset, - quality_system_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaQualitySystemGuidErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - database_key: str | None, optional - quality_system_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._database_key: str | None | Unset_Type = Unset - self._quality_system_guid: str | Unset_Type = Unset - - if database_key is not Unset: - self.database_key = database_key - if quality_system_guid is not Unset: - self.quality_system_guid = quality_system_guid - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaQualitySystemGuidErrorDetail. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaQualitySystemGuidErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaQualitySystemGuidErrorDetail. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaQualitySystemGuidErrorDetail. - """ - self._database_key = database_key - - @property - def quality_system_guid(self) -> "str | Unset_Type": - """Gets the quality_system_guid of this GsaQualitySystemGuidErrorDetail. - - Returns - ------- - str | Unset_Type - The quality_system_guid of this GsaQualitySystemGuidErrorDetail. - """ - return self._quality_system_guid - - @quality_system_guid.setter - def quality_system_guid(self, quality_system_guid: "str | Unset_Type") -> None: - """Sets the quality_system_guid of this GsaQualitySystemGuidErrorDetail. - - Parameters - ---------- - quality_system_guid: str | Unset_Type - The quality_system_guid of this GsaQualitySystemGuidErrorDetail. - """ - # Field is not nullable - if quality_system_guid is None: - raise ValueError("Invalid value for 'quality_system_guid', must not be 'None'") - self._quality_system_guid = quality_system_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystemGuidErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_type.py deleted file mode 100644 index eb5e1d4c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_system_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaQualitySystemType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - DISCRETE = "discrete" - CONTINUOUS = "continuous" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_systems_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_systems_info.py deleted file mode 100644 index 043d25ba..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_quality_systems_info.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystemsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "quality_systems": "list[GsaQualitySystem]", - } - - attribute_map: dict[str, str] = { - "quality_systems": "qualitySystems", - } - - subtype_mapping: dict[str, str] = { - "qualitySystems": "GsaQualitySystem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - quality_systems: "list[GsaQualitySystem] | None | Unset_Type" = Unset, - ) -> None: - """GsaQualitySystemsInfo - a model defined in Swagger - - Parameters - ---------- - quality_systems: list[GsaQualitySystem] | None, optional - """ - self._quality_systems: list[GsaQualitySystem] | None | Unset_Type = Unset - - if quality_systems is not Unset: - self.quality_systems = quality_systems - - @property - def quality_systems(self) -> "list[GsaQualitySystem] | None | Unset_Type": - """Gets the quality_systems of this GsaQualitySystemsInfo. - - Returns - ------- - list[GsaQualitySystem] | None | Unset_Type - The quality_systems of this GsaQualitySystemsInfo. - """ - return self._quality_systems - - @quality_systems.setter - def quality_systems( - self, quality_systems: "list[GsaQualitySystem] | None | Unset_Type" - ) -> None: - """Sets the quality_systems of this GsaQualitySystemsInfo. - - Parameters - ---------- - quality_systems: list[GsaQualitySystem] | None | Unset_Type - The quality_systems of this GsaQualitySystemsInfo. - """ - self._quality_systems = quality_systems - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystemsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute.py index 42aa25a3..672d721a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute.py @@ -70,15 +70,12 @@ class GsaQueryAttribute(ModelBase): "display_names": "dict(str, str)", "expressions": "list[GsaQuerySlimNamedEntity]", "guid": "str", - "help_path": "str", "info": "GsaQueryAttributeInfo", "is_functional_range": "bool", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "str", - "table": "GsaQuerySlimEntity", - "tabular_columns": "list[GsaQueryTabularColumn]", + "tabular_columns": "list[GsaQuerySlimNamedEntity]", "target": "GsaQueryTabularAttributeTarget", "type": "GsaAttributeType", "unit": "GsaQueryUnit", @@ -94,14 +91,11 @@ class GsaQueryAttribute(ModelBase): "display_names": "displayNames", "expressions": "expressions", "guid": "guid", - "help_path": "helpPath", "info": "info", "is_functional_range": "isFunctionalRange", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", - "table": "table", "tabular_columns": "tabularColumns", "target": "target", "type": "type", @@ -113,13 +107,12 @@ class GsaQueryAttribute(ModelBase): "defaultThresholdType": "GsaAttributeThresholdType", "axisName": "GsaQueryAxisName", "info": "GsaQueryAttributeInfo", - "table": "GsaQuerySlimEntity", "unit": "GsaQueryUnit", "discreteType": "GsaQuerySlimDiscreteType", "dataRule": "GsaQueryDataRule", "target": "GsaQueryTabularAttributeTarget", "aboutAttribute": "GsaQuerySlimTypedAttribute", - "tabularColumns": "GsaQueryTabularColumn", + "tabularColumns": "GsaQuerySlimNamedEntity", "attributeParameters": "GsaQuerySlimNamedEntity", "expressions": "GsaQuerySlimNamedEntity", } @@ -138,15 +131,12 @@ def __init__( display_names: "dict[str, str] | None | Unset_Type" = Unset, expressions: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, - help_path: "str | None | Unset_Type" = Unset, info: "GsaQueryAttributeInfo | Unset_Type" = Unset, is_functional_range: "bool | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - table: "GsaQuerySlimEntity | Unset_Type" = Unset, - tabular_columns: "list[GsaQueryTabularColumn] | None | Unset_Type" = Unset, + tabular_columns: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" = Unset, target: "GsaQueryTabularAttributeTarget | Unset_Type" = Unset, type: "GsaAttributeType | Unset_Type" = Unset, unit: "GsaQueryUnit | Unset_Type" = Unset, @@ -164,43 +154,35 @@ def __init__( display_names: dict[str, str] | None, optional expressions: list[GsaQuerySlimNamedEntity] | None, optional guid: str | None, optional - help_path: str | None, optional info: GsaQueryAttributeInfo, optional is_functional_range: bool | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool | None, optional - is_protected: bool | None, optional name: str | None, optional - table: GsaQuerySlimEntity, optional - tabular_columns: list[GsaQueryTabularColumn] | None, optional + tabular_columns: list[GsaQuerySlimNamedEntity] | None, optional target: GsaQueryTabularAttributeTarget, optional type: GsaAttributeType, optional unit: GsaQueryUnit, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._type: GsaAttributeType | Unset_Type = Unset self._default_threshold_type: GsaAttributeThresholdType | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset self._is_multi_valued: bool | None | Unset_Type = Unset self._is_functional_range: bool | None | Unset_Type = Unset - self._help_path: str | None | Unset_Type = Unset self._axis_name: GsaQueryAxisName | Unset_Type = Unset self._info: GsaQueryAttributeInfo | Unset_Type = Unset - self._table: GsaQuerySlimEntity | Unset_Type = Unset self._unit: GsaQueryUnit | Unset_Type = Unset self._discrete_type: GsaQuerySlimDiscreteType | Unset_Type = Unset self._data_rule: GsaQueryDataRule | Unset_Type = Unset self._target: GsaQueryTabularAttributeTarget | Unset_Type = Unset self._about_attribute: GsaQuerySlimTypedAttribute | Unset_Type = Unset - self._tabular_columns: list[GsaQueryTabularColumn] | None | Unset_Type = Unset + self._tabular_columns: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._attribute_parameters: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._expressions: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._display_names: dict[str, str] | None | Unset_Type = Unset self._name: str | None | Unset_Type = Unset self._guid: str | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if type is not Unset: self.type = type if default_threshold_type is not Unset: @@ -211,14 +193,10 @@ def __init__( self.is_multi_valued = is_multi_valued if is_functional_range is not Unset: self.is_functional_range = is_functional_range - if help_path is not Unset: - self.help_path = help_path if axis_name is not Unset: self.axis_name = axis_name if info is not Unset: self.info = info - if table is not Unset: - self.table = table if unit is not Unset: self.unit = unit if discrete_type is not Unset: @@ -242,28 +220,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryAttribute. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryAttribute. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryAttribute. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryAttribute. - """ - self._is_protected = is_protected - @property def type(self) -> "GsaAttributeType | Unset_Type": """Gets the type of this GsaQueryAttribute. @@ -384,28 +340,6 @@ def is_functional_range(self, is_functional_range: "bool | None | Unset_Type") - """ self._is_functional_range = is_functional_range - @property - def help_path(self) -> "str | None | Unset_Type": - """Gets the help_path of this GsaQueryAttribute. - - Returns - ------- - str | None | Unset_Type - The help_path of this GsaQueryAttribute. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "str | None | Unset_Type") -> None: - """Sets the help_path of this GsaQueryAttribute. - - Parameters - ---------- - help_path: str | None | Unset_Type - The help_path of this GsaQueryAttribute. - """ - self._help_path = help_path - @property def axis_name(self) -> "GsaQueryAxisName | Unset_Type": """Gets the axis_name of this GsaQueryAttribute. @@ -456,31 +390,6 @@ def info(self, info: "GsaQueryAttributeInfo | Unset_Type") -> None: raise ValueError("Invalid value for 'info', must not be 'None'") self._info = info - @property - def table(self) -> "GsaQuerySlimEntity | Unset_Type": - """Gets the table of this GsaQueryAttribute. - - Returns - ------- - GsaQuerySlimEntity | Unset_Type - The table of this GsaQueryAttribute. - """ - return self._table - - @table.setter - def table(self, table: "GsaQuerySlimEntity | Unset_Type") -> None: - """Sets the table of this GsaQueryAttribute. - - Parameters - ---------- - table: GsaQuerySlimEntity | Unset_Type - The table of this GsaQueryAttribute. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - self._table = table - @property def unit(self) -> "GsaQueryUnit | Unset_Type": """Gets the unit of this GsaQueryAttribute. @@ -607,25 +516,25 @@ def about_attribute(self, about_attribute: "GsaQuerySlimTypedAttribute | Unset_T self._about_attribute = about_attribute @property - def tabular_columns(self) -> "list[GsaQueryTabularColumn] | None | Unset_Type": + def tabular_columns(self) -> "list[GsaQuerySlimNamedEntity] | None | Unset_Type": """Gets the tabular_columns of this GsaQueryAttribute. Returns ------- - list[GsaQueryTabularColumn] | None | Unset_Type + list[GsaQuerySlimNamedEntity] | None | Unset_Type The tabular_columns of this GsaQueryAttribute. """ return self._tabular_columns @tabular_columns.setter def tabular_columns( - self, tabular_columns: "list[GsaQueryTabularColumn] | None | Unset_Type" + self, tabular_columns: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" ) -> None: """Sets the tabular_columns of this GsaQueryAttribute. Parameters ---------- - tabular_columns: list[GsaQueryTabularColumn] | None | Unset_Type + tabular_columns: list[GsaQuerySlimNamedEntity] | None | Unset_Type The tabular_columns of this GsaQueryAttribute. """ self._tabular_columns = tabular_columns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_filter.py index 6b0341f4..42ab0851 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_filter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_filter.py @@ -61,14 +61,12 @@ class GsaQueryAttributeFilter(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "discrete_type": "GsaQuerySlimNamedEntityFilter", "guid": "list[str]", "name": "list[str]", "type": "list[GsaAttributeType]", } attribute_map: dict[str, str] = { - "discrete_type": "discreteType", "guid": "guid", "name": "name", "type": "type", @@ -76,7 +74,6 @@ class GsaQueryAttributeFilter(ModelBase): subtype_mapping: dict[str, str] = { "type": "GsaAttributeType", - "discreteType": "GsaQuerySlimNamedEntityFilter", } discriminator: Optional[str] = None @@ -84,7 +81,6 @@ class GsaQueryAttributeFilter(ModelBase): def __init__( self, *, - discrete_type: "GsaQuerySlimNamedEntityFilter | Unset_Type" = Unset, guid: "list[str] | None | Unset_Type" = Unset, name: "list[str] | None | Unset_Type" = Unset, type: "list[GsaAttributeType] | None | Unset_Type" = Unset, @@ -93,7 +89,6 @@ def __init__( Parameters ---------- - discrete_type: GsaQuerySlimNamedEntityFilter, optional guid: list[str] | None, optional name: list[str] | None, optional type: list[GsaAttributeType] | None, optional @@ -101,7 +96,6 @@ def __init__( self._type: list[GsaAttributeType] | None | Unset_Type = Unset self._name: list[str] | None | Unset_Type = Unset self._guid: list[str] | None | Unset_Type = Unset - self._discrete_type: GsaQuerySlimNamedEntityFilter | Unset_Type = Unset if type is not Unset: self.type = type @@ -109,8 +103,6 @@ def __init__( self.name = name if guid is not Unset: self.guid = guid - if discrete_type is not Unset: - self.discrete_type = discrete_type @property def type(self) -> "list[GsaAttributeType] | None | Unset_Type": @@ -184,31 +176,6 @@ def guid(self, guid: "list[str] | None | Unset_Type") -> None: """ self._guid = guid - @property - def discrete_type(self) -> "GsaQuerySlimNamedEntityFilter | Unset_Type": - """Gets the discrete_type of this GsaQueryAttributeFilter. - - Returns - ------- - GsaQuerySlimNamedEntityFilter | Unset_Type - The discrete_type of this GsaQueryAttributeFilter. - """ - return self._discrete_type - - @discrete_type.setter - def discrete_type(self, discrete_type: "GsaQuerySlimNamedEntityFilter | Unset_Type") -> None: - """Sets the discrete_type of this GsaQueryAttributeFilter. - - Parameters - ---------- - discrete_type: GsaQuerySlimNamedEntityFilter | Unset_Type - The discrete_type of this GsaQueryAttributeFilter. - """ - # Field is not nullable - if discrete_type is None: - raise ValueError("Invalid value for 'discrete_type', must not be 'None'") - self._discrete_type = discrete_type - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_properties.py index ba5d842e..274865b2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_properties.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_attribute_properties.py @@ -70,15 +70,12 @@ class GsaQueryAttributeProperties(ModelBase): "display_names": "bool", "expressions": "GsaQuerySlimNamedEntityProperties", "guid": "bool", - "help_path": "bool", "info": "GsaQueryAttributeInfoProperties", "is_functional_range": "bool", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "bool", - "table": "GsaQuerySlimEntityProperties", - "tabular_columns": "GsaQueryTabularColumnProperties", + "tabular_columns": "GsaQuerySlimNamedEntityProperties", "target": "GsaQueryTabularAttributeTargetProperties", "type": "bool", "unit": "GsaQueryUnitProperties", @@ -94,14 +91,11 @@ class GsaQueryAttributeProperties(ModelBase): "display_names": "displayNames", "expressions": "expressions", "guid": "guid", - "help_path": "helpPath", "info": "info", "is_functional_range": "isFunctionalRange", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", - "table": "table", "tabular_columns": "tabularColumns", "target": "target", "type": "type", @@ -111,13 +105,12 @@ class GsaQueryAttributeProperties(ModelBase): subtype_mapping: dict[str, str] = { "axisName": "GsaQueryAxisNameProperties", "info": "GsaQueryAttributeInfoProperties", - "table": "GsaQuerySlimEntityProperties", "unit": "GsaQueryUnitProperties", "discreteType": "GsaQuerySlimDiscreteTypeProperties", "dataRule": "GsaQueryDataRuleProperties", "aboutAttribute": "GsaQuerySlimTypedAttributeProperties", "target": "GsaQueryTabularAttributeTargetProperties", - "tabularColumns": "GsaQueryTabularColumnProperties", + "tabularColumns": "GsaQuerySlimNamedEntityProperties", "attributeParameters": "GsaQuerySlimNamedEntityProperties", "expressions": "GsaQuerySlimNamedEntityProperties", } @@ -136,15 +129,12 @@ def __init__( display_names: "bool | None | Unset_Type" = Unset, expressions: "GsaQuerySlimNamedEntityProperties | Unset_Type" = Unset, guid: "bool | None | Unset_Type" = Unset, - help_path: "bool | None | Unset_Type" = Unset, info: "GsaQueryAttributeInfoProperties | Unset_Type" = Unset, is_functional_range: "bool | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "bool | None | Unset_Type" = Unset, - table: "GsaQuerySlimEntityProperties | Unset_Type" = Unset, - tabular_columns: "GsaQueryTabularColumnProperties | Unset_Type" = Unset, + tabular_columns: "GsaQuerySlimNamedEntityProperties | Unset_Type" = Unset, target: "GsaQueryTabularAttributeTargetProperties | Unset_Type" = Unset, type: "bool | None | Unset_Type" = Unset, unit: "GsaQueryUnitProperties | Unset_Type" = Unset, @@ -162,43 +152,35 @@ def __init__( display_names: bool | None, optional expressions: GsaQuerySlimNamedEntityProperties, optional guid: bool | None, optional - help_path: bool | None, optional info: GsaQueryAttributeInfoProperties, optional is_functional_range: bool | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool | None, optional - is_protected: bool | None, optional name: bool | None, optional - table: GsaQuerySlimEntityProperties, optional - tabular_columns: GsaQueryTabularColumnProperties, optional + tabular_columns: GsaQuerySlimNamedEntityProperties, optional target: GsaQueryTabularAttributeTargetProperties, optional type: bool | None, optional unit: GsaQueryUnitProperties, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._type: bool | None | Unset_Type = Unset self._default_threshold_type: bool | None | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset self._is_multi_valued: bool | None | Unset_Type = Unset self._is_functional_range: bool | None | Unset_Type = Unset - self._help_path: bool | None | Unset_Type = Unset self._axis_name: GsaQueryAxisNameProperties | Unset_Type = Unset self._info: GsaQueryAttributeInfoProperties | Unset_Type = Unset - self._table: GsaQuerySlimEntityProperties | Unset_Type = Unset self._unit: GsaQueryUnitProperties | Unset_Type = Unset self._discrete_type: GsaQuerySlimDiscreteTypeProperties | Unset_Type = Unset self._data_rule: GsaQueryDataRuleProperties | Unset_Type = Unset self._about_attribute: GsaQuerySlimTypedAttributeProperties | Unset_Type = Unset self._target: GsaQueryTabularAttributeTargetProperties | Unset_Type = Unset - self._tabular_columns: GsaQueryTabularColumnProperties | Unset_Type = Unset + self._tabular_columns: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._attribute_parameters: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._expressions: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._display_names: bool | None | Unset_Type = Unset self._name: bool | None | Unset_Type = Unset self._guid: bool | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if type is not Unset: self.type = type if default_threshold_type is not Unset: @@ -209,14 +191,10 @@ def __init__( self.is_multi_valued = is_multi_valued if is_functional_range is not Unset: self.is_functional_range = is_functional_range - if help_path is not Unset: - self.help_path = help_path if axis_name is not Unset: self.axis_name = axis_name if info is not Unset: self.info = info - if table is not Unset: - self.table = table if unit is not Unset: self.unit = unit if discrete_type is not Unset: @@ -240,28 +218,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryAttributeProperties. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryAttributeProperties. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryAttributeProperties. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryAttributeProperties. - """ - self._is_protected = is_protected - @property def type(self) -> "bool | None | Unset_Type": """Gets the type of this GsaQueryAttributeProperties. @@ -376,28 +332,6 @@ def is_functional_range(self, is_functional_range: "bool | None | Unset_Type") - """ self._is_functional_range = is_functional_range - @property - def help_path(self) -> "bool | None | Unset_Type": - """Gets the help_path of this GsaQueryAttributeProperties. - - Returns - ------- - bool | None | Unset_Type - The help_path of this GsaQueryAttributeProperties. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "bool | None | Unset_Type") -> None: - """Sets the help_path of this GsaQueryAttributeProperties. - - Parameters - ---------- - help_path: bool | None | Unset_Type - The help_path of this GsaQueryAttributeProperties. - """ - self._help_path = help_path - @property def axis_name(self) -> "GsaQueryAxisNameProperties | Unset_Type": """Gets the axis_name of this GsaQueryAttributeProperties. @@ -448,31 +382,6 @@ def info(self, info: "GsaQueryAttributeInfoProperties | Unset_Type") -> None: raise ValueError("Invalid value for 'info', must not be 'None'") self._info = info - @property - def table(self) -> "GsaQuerySlimEntityProperties | Unset_Type": - """Gets the table of this GsaQueryAttributeProperties. - - Returns - ------- - GsaQuerySlimEntityProperties | Unset_Type - The table of this GsaQueryAttributeProperties. - """ - return self._table - - @table.setter - def table(self, table: "GsaQuerySlimEntityProperties | Unset_Type") -> None: - """Sets the table of this GsaQueryAttributeProperties. - - Parameters - ---------- - table: GsaQuerySlimEntityProperties | Unset_Type - The table of this GsaQueryAttributeProperties. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - self._table = table - @property def unit(self) -> "GsaQueryUnitProperties | Unset_Type": """Gets the unit of this GsaQueryAttributeProperties. @@ -603,25 +512,25 @@ def target(self, target: "GsaQueryTabularAttributeTargetProperties | Unset_Type" self._target = target @property - def tabular_columns(self) -> "GsaQueryTabularColumnProperties | Unset_Type": + def tabular_columns(self) -> "GsaQuerySlimNamedEntityProperties | Unset_Type": """Gets the tabular_columns of this GsaQueryAttributeProperties. Returns ------- - GsaQueryTabularColumnProperties | Unset_Type + GsaQuerySlimNamedEntityProperties | Unset_Type The tabular_columns of this GsaQueryAttributeProperties. """ return self._tabular_columns @tabular_columns.setter def tabular_columns( - self, tabular_columns: "GsaQueryTabularColumnProperties | Unset_Type" + self, tabular_columns: "GsaQuerySlimNamedEntityProperties | Unset_Type" ) -> None: """Sets the tabular_columns of this GsaQueryAttributeProperties. Parameters ---------- - tabular_columns: GsaQueryTabularColumnProperties | Unset_Type + tabular_columns: GsaQuerySlimNamedEntityProperties | Unset_Type The tabular_columns of this GsaQueryAttributeProperties. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type.py index a20d30e8..8e69e566 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type.py @@ -64,7 +64,6 @@ class GsaQueryDiscreteType(ModelBase): "discrete_values": "list[GsaQuerySlimNamedEntity]", "guid": "str", "is_ordered": "bool", - "is_protected": "bool", "name": "str", } @@ -72,7 +71,6 @@ class GsaQueryDiscreteType(ModelBase): "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -88,7 +86,6 @@ def __init__( discrete_values: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, is_ordered: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, ) -> None: """GsaQueryDiscreteType - a model defined in Swagger @@ -98,17 +95,13 @@ def __init__( discrete_values: list[GsaQuerySlimNamedEntity] | None, optional guid: str | None, optional is_ordered: bool | None, optional - is_protected: bool | None, optional name: str | None, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._discrete_values: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._is_ordered: bool | None | Unset_Type = Unset self._name: str | None | Unset_Type = Unset self._guid: str | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if discrete_values is not Unset: self.discrete_values = discrete_values if is_ordered is not Unset: @@ -118,28 +111,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryDiscreteType. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteType. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryDiscreteType. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteType. - """ - self._is_protected = is_protected - @property def discrete_values(self) -> "list[GsaQuerySlimNamedEntity] | None | Unset_Type": """Gets the discrete_values of this GsaQueryDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type_properties.py index d0477de3..dd0b3a9c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type_properties.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_discrete_type_properties.py @@ -64,7 +64,6 @@ class GsaQueryDiscreteTypeProperties(ModelBase): "discrete_values": "GsaQuerySlimNamedEntityProperties", "guid": "bool", "is_ordered": "bool", - "is_protected": "bool", "name": "bool", } @@ -72,7 +71,6 @@ class GsaQueryDiscreteTypeProperties(ModelBase): "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -88,7 +86,6 @@ def __init__( discrete_values: "GsaQuerySlimNamedEntityProperties | Unset_Type" = Unset, guid: "bool | None | Unset_Type" = Unset, is_ordered: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "bool | None | Unset_Type" = Unset, ) -> None: """GsaQueryDiscreteTypeProperties - a model defined in Swagger @@ -98,17 +95,13 @@ def __init__( discrete_values: GsaQuerySlimNamedEntityProperties, optional guid: bool | None, optional is_ordered: bool | None, optional - is_protected: bool | None, optional name: bool | None, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._discrete_values: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._is_ordered: bool | None | Unset_Type = Unset self._name: bool | None | Unset_Type = Unset self._guid: bool | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if discrete_values is not Unset: self.discrete_values = discrete_values if is_ordered is not Unset: @@ -118,28 +111,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryDiscreteTypeProperties. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteTypeProperties. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryDiscreteTypeProperties. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteTypeProperties. - """ - self._is_protected = is_protected - @property def discrete_values(self) -> "GsaQuerySlimNamedEntityProperties | Unset_Type": """Gets the discrete_values of this GsaQueryDiscreteTypeProperties. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout.py deleted file mode 100644 index 89316c46..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayout(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "sections": "list[GsaQueryLayoutSection]", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "sections": "sections", - } - - subtype_mapping: dict[str, str] = { - "sections": "GsaQueryLayoutSection", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str] | None | Unset_Type" = Unset, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - sections: "list[GsaQueryLayoutSection] | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayout - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] | None, optional - guid: str | None, optional - name: str | None, optional - sections: list[GsaQueryLayoutSection] | None, optional - """ - self._sections: list[GsaQueryLayoutSection] | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if sections is not Unset: - self.sections = sections - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def sections(self) -> "list[GsaQueryLayoutSection] | None | Unset_Type": - """Gets the sections of this GsaQueryLayout. - - Returns - ------- - list[GsaQueryLayoutSection] | None | Unset_Type - The sections of this GsaQueryLayout. - """ - return self._sections - - @sections.setter - def sections(self, sections: "list[GsaQueryLayoutSection] | None | Unset_Type") -> None: - """Sets the sections of this GsaQueryLayout. - - Parameters - ---------- - sections: list[GsaQueryLayoutSection] | None | Unset_Type - The sections of this GsaQueryLayout. - """ - self._sections = sections - - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaQueryLayout. - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayout. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayout. - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayout. - """ - self._display_names = display_names - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayout. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryLayout. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayout. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayout. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryLayout. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryLayout. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayout. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryLayout. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayout): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_filter.py deleted file mode 100644 index aa5c4f0f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_filter.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "sections": "GsaQueryLayoutSectionFilter", - } - - attribute_map: dict[str, str] = { - "sections": "sections", - } - - subtype_mapping: dict[str, str] = { - "sections": "GsaQueryLayoutSectionFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - sections: "GsaQueryLayoutSectionFilter | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutFilter - a model defined in Swagger - - Parameters - ---------- - sections: GsaQueryLayoutSectionFilter, optional - """ - self._sections: GsaQueryLayoutSectionFilter | Unset_Type = Unset - - if sections is not Unset: - self.sections = sections - - @property - def sections(self) -> "GsaQueryLayoutSectionFilter | Unset_Type": - """Gets the sections of this GsaQueryLayoutFilter. - - Returns - ------- - GsaQueryLayoutSectionFilter | Unset_Type - The sections of this GsaQueryLayoutFilter. - """ - return self._sections - - @sections.setter - def sections(self, sections: "GsaQueryLayoutSectionFilter | Unset_Type") -> None: - """Sets the sections of this GsaQueryLayoutFilter. - - Parameters - ---------- - sections: GsaQueryLayoutSectionFilter | Unset_Type - The sections of this GsaQueryLayoutFilter. - """ - # Field is not nullable - if sections is None: - raise ValueError("Invalid value for 'sections', must not be 'None'") - self._sections = sections - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item.py deleted file mode 100644 index 8d3687e4..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item.py +++ /dev/null @@ -1,234 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "item_type": "GsaLayoutItemType", - "name": "str", - "underlying_entity_guid": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "item_type": "itemType", - "name": "name", - "underlying_entity_guid": "underlyingEntityGuid", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaLayoutItemType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | None | Unset_Type" = Unset, - item_type: "GsaLayoutItemType | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - underlying_entity_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutItem - a model defined in Swagger - - Parameters - ---------- - guid: str | None, optional - item_type: GsaLayoutItemType, optional - name: str | None, optional - underlying_entity_guid: str | None, optional - """ - self._underlying_entity_guid: str | None | Unset_Type = Unset - self._item_type: GsaLayoutItemType | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if underlying_entity_guid is not Unset: - self.underlying_entity_guid = underlying_entity_guid - if item_type is not Unset: - self.item_type = item_type - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def underlying_entity_guid(self) -> "str | None | Unset_Type": - """Gets the underlying_entity_guid of this GsaQueryLayoutItem. - - Returns - ------- - str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItem. - """ - return self._underlying_entity_guid - - @underlying_entity_guid.setter - def underlying_entity_guid(self, underlying_entity_guid: "str | None | Unset_Type") -> None: - """Sets the underlying_entity_guid of this GsaQueryLayoutItem. - - Parameters - ---------- - underlying_entity_guid: str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItem. - """ - self._underlying_entity_guid = underlying_entity_guid - - @property - def item_type(self) -> "GsaLayoutItemType | Unset_Type": - """Gets the item_type of this GsaQueryLayoutItem. - - Returns - ------- - GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItem. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaLayoutItemType | Unset_Type") -> None: - """Sets the item_type of this GsaQueryLayoutItem. - - Parameters - ---------- - item_type: GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItem. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - self._item_type = item_type - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayoutItem. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryLayoutItem. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutItem. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayoutItem. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutItem. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryLayoutItem. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutItem. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryLayoutItem. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_filter.py deleted file mode 100644 index e2f9e630..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_filter.py +++ /dev/null @@ -1,325 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutItemFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "forwards": "bool", - "item_type": "GsaLayoutItemType", - "link_type": "GsaLayoutItemLinkType", - "target_database": "str", - "target_database_version": "str", - "target_table": "str", - "underlying_entity_guid": "str", - } - - attribute_map: dict[str, str] = { - "forwards": "forwards", - "item_type": "itemType", - "link_type": "linkType", - "target_database": "targetDatabase", - "target_database_version": "targetDatabaseVersion", - "target_table": "targetTable", - "underlying_entity_guid": "underlyingEntityGuid", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaLayoutItemType", - "linkType": "GsaLayoutItemLinkType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - forwards: "bool | None | Unset_Type" = Unset, - item_type: "GsaLayoutItemType | Unset_Type" = Unset, - link_type: "GsaLayoutItemLinkType | Unset_Type" = Unset, - target_database: "str | None | Unset_Type" = Unset, - target_database_version: "str | None | Unset_Type" = Unset, - target_table: "str | None | Unset_Type" = Unset, - underlying_entity_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutItemFilter - a model defined in Swagger - - Parameters - ---------- - forwards: bool | None, optional - item_type: GsaLayoutItemType, optional - link_type: GsaLayoutItemLinkType, optional - target_database: str | None, optional - target_database_version: str | None, optional - target_table: str | None, optional - underlying_entity_guid: str | None, optional - """ - self._item_type: GsaLayoutItemType | Unset_Type = Unset - self._underlying_entity_guid: str | None | Unset_Type = Unset - self._link_type: GsaLayoutItemLinkType | Unset_Type = Unset - self._target_database: str | None | Unset_Type = Unset - self._target_database_version: str | None | Unset_Type = Unset - self._target_table: str | None | Unset_Type = Unset - self._forwards: bool | None | Unset_Type = Unset - - if item_type is not Unset: - self.item_type = item_type - if underlying_entity_guid is not Unset: - self.underlying_entity_guid = underlying_entity_guid - if link_type is not Unset: - self.link_type = link_type - if target_database is not Unset: - self.target_database = target_database - if target_database_version is not Unset: - self.target_database_version = target_database_version - if target_table is not Unset: - self.target_table = target_table - if forwards is not Unset: - self.forwards = forwards - - @property - def item_type(self) -> "GsaLayoutItemType | Unset_Type": - """Gets the item_type of this GsaQueryLayoutItemFilter. - - Returns - ------- - GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItemFilter. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaLayoutItemType | Unset_Type") -> None: - """Sets the item_type of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - item_type: GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItemFilter. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - self._item_type = item_type - - @property - def underlying_entity_guid(self) -> "str | None | Unset_Type": - """Gets the underlying_entity_guid of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemFilter. - """ - return self._underlying_entity_guid - - @underlying_entity_guid.setter - def underlying_entity_guid(self, underlying_entity_guid: "str | None | Unset_Type") -> None: - """Sets the underlying_entity_guid of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - underlying_entity_guid: str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemFilter. - """ - self._underlying_entity_guid = underlying_entity_guid - - @property - def link_type(self) -> "GsaLayoutItemLinkType | Unset_Type": - """Gets the link_type of this GsaQueryLayoutItemFilter. - - Returns - ------- - GsaLayoutItemLinkType | Unset_Type - The link_type of this GsaQueryLayoutItemFilter. - """ - return self._link_type - - @link_type.setter - def link_type(self, link_type: "GsaLayoutItemLinkType | Unset_Type") -> None: - """Sets the link_type of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - link_type: GsaLayoutItemLinkType | Unset_Type - The link_type of this GsaQueryLayoutItemFilter. - """ - # Field is not nullable - if link_type is None: - raise ValueError("Invalid value for 'link_type', must not be 'None'") - self._link_type = link_type - - @property - def target_database(self) -> "str | None | Unset_Type": - """Gets the target_database of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The target_database of this GsaQueryLayoutItemFilter. - """ - return self._target_database - - @target_database.setter - def target_database(self, target_database: "str | None | Unset_Type") -> None: - """Sets the target_database of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - target_database: str | None | Unset_Type - The target_database of this GsaQueryLayoutItemFilter. - """ - self._target_database = target_database - - @property - def target_database_version(self) -> "str | None | Unset_Type": - """Gets the target_database_version of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The target_database_version of this GsaQueryLayoutItemFilter. - """ - return self._target_database_version - - @target_database_version.setter - def target_database_version(self, target_database_version: "str | None | Unset_Type") -> None: - """Sets the target_database_version of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - target_database_version: str | None | Unset_Type - The target_database_version of this GsaQueryLayoutItemFilter. - """ - self._target_database_version = target_database_version - - @property - def target_table(self) -> "str | None | Unset_Type": - """Gets the target_table of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The target_table of this GsaQueryLayoutItemFilter. - """ - return self._target_table - - @target_table.setter - def target_table(self, target_table: "str | None | Unset_Type") -> None: - """Sets the target_table of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - target_table: str | None | Unset_Type - The target_table of this GsaQueryLayoutItemFilter. - """ - self._target_table = target_table - - @property - def forwards(self) -> "bool | None | Unset_Type": - """Gets the forwards of this GsaQueryLayoutItemFilter. - - Returns - ------- - bool | None | Unset_Type - The forwards of this GsaQueryLayoutItemFilter. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool | None | Unset_Type") -> None: - """Sets the forwards of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - forwards: bool | None | Unset_Type - The forwards of this GsaQueryLayoutItemFilter. - """ - self._forwards = forwards - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutItemFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_properties.py deleted file mode 100644 index 8cec78da..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_item_properties.py +++ /dev/null @@ -1,229 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutItemProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "bool", - "item_type": "bool", - "name": "bool", - "underlying_entity_guid": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "item_type": "itemType", - "name": "name", - "underlying_entity_guid": "underlyingEntityGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "bool | None | Unset_Type" = Unset, - item_type: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - underlying_entity_guid: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutItemProperties - a model defined in Swagger - - Parameters - ---------- - guid: bool | None, optional - item_type: bool | None, optional - name: bool | None, optional - underlying_entity_guid: bool | None, optional - """ - self._underlying_entity_guid: bool | None | Unset_Type = Unset - self._item_type: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if underlying_entity_guid is not Unset: - self.underlying_entity_guid = underlying_entity_guid - if item_type is not Unset: - self.item_type = item_type - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def underlying_entity_guid(self) -> "bool | None | Unset_Type": - """Gets the underlying_entity_guid of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemProperties. - """ - return self._underlying_entity_guid - - @underlying_entity_guid.setter - def underlying_entity_guid(self, underlying_entity_guid: "bool | None | Unset_Type") -> None: - """Sets the underlying_entity_guid of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - underlying_entity_guid: bool | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemProperties. - """ - self._underlying_entity_guid = underlying_entity_guid - - @property - def item_type(self) -> "bool | None | Unset_Type": - """Gets the item_type of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The item_type of this GsaQueryLayoutItemProperties. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "bool | None | Unset_Type") -> None: - """Sets the item_type of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - item_type: bool | None | Unset_Type - The item_type of this GsaQueryLayoutItemProperties. - """ - self._item_type = item_type - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryLayoutItemProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryLayoutItemProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryLayoutItemProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryLayoutItemProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutItemProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_properties.py deleted file mode 100644 index 4cb43b29..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_properties.py +++ /dev/null @@ -1,234 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "bool", - "guid": "bool", - "name": "bool", - "sections": "GsaQueryLayoutSectionProperties", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "sections": "sections", - } - - subtype_mapping: dict[str, str] = { - "sections": "GsaQueryLayoutSectionProperties", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "bool | None | Unset_Type" = Unset, - guid: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - sections: "GsaQueryLayoutSectionProperties | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutProperties - a model defined in Swagger - - Parameters - ---------- - display_names: bool | None, optional - guid: bool | None, optional - name: bool | None, optional - sections: GsaQueryLayoutSectionProperties, optional - """ - self._sections: GsaQueryLayoutSectionProperties | Unset_Type = Unset - self._display_names: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if sections is not Unset: - self.sections = sections - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def sections(self) -> "GsaQueryLayoutSectionProperties | Unset_Type": - """Gets the sections of this GsaQueryLayoutProperties. - - Returns - ------- - GsaQueryLayoutSectionProperties | Unset_Type - The sections of this GsaQueryLayoutProperties. - """ - return self._sections - - @sections.setter - def sections(self, sections: "GsaQueryLayoutSectionProperties | Unset_Type") -> None: - """Sets the sections of this GsaQueryLayoutProperties. - - Parameters - ---------- - sections: GsaQueryLayoutSectionProperties | Unset_Type - The sections of this GsaQueryLayoutProperties. - """ - # Field is not nullable - if sections is None: - raise ValueError("Invalid value for 'sections', must not be 'None'") - self._sections = sections - - @property - def display_names(self) -> "bool | None | Unset_Type": - """Gets the display_names of this GsaQueryLayoutProperties. - - Returns - ------- - bool | None | Unset_Type - The display_names of this GsaQueryLayoutProperties. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "bool | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayoutProperties. - - Parameters - ---------- - display_names: bool | None | Unset_Type - The display_names of this GsaQueryLayoutProperties. - """ - self._display_names = display_names - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryLayoutProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryLayoutProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryLayoutProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryLayoutProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryLayoutProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section.py deleted file mode 100644 index 5db6dbdc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSection(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "section_items": "list[GsaQueryLayoutItem]", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "section_items": "sectionItems", - } - - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaQueryLayoutItem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str] | None | Unset_Type" = Unset, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - section_items: "list[GsaQueryLayoutItem] | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutSection - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] | None, optional - guid: str | None, optional - name: str | None, optional - section_items: list[GsaQueryLayoutItem] | None, optional - """ - self._section_items: list[GsaQueryLayoutItem] | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if section_items is not Unset: - self.section_items = section_items - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def section_items(self) -> "list[GsaQueryLayoutItem] | None | Unset_Type": - """Gets the section_items of this GsaQueryLayoutSection. - - Returns - ------- - list[GsaQueryLayoutItem] | None | Unset_Type - The section_items of this GsaQueryLayoutSection. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "list[GsaQueryLayoutItem] | None | Unset_Type") -> None: - """Sets the section_items of this GsaQueryLayoutSection. - - Parameters - ---------- - section_items: list[GsaQueryLayoutItem] | None | Unset_Type - The section_items of this GsaQueryLayoutSection. - """ - self._section_items = section_items - - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaQueryLayoutSection. - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayoutSection. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayoutSection. - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayoutSection. - """ - self._display_names = display_names - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayoutSection. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryLayoutSection. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutSection. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayoutSection. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutSection. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryLayoutSection. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutSection. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryLayoutSection. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSection): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section_properties.py deleted file mode 100644 index d7bc3d47..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_section_properties.py +++ /dev/null @@ -1,234 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSectionProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "bool", - "guid": "bool", - "name": "bool", - "section_items": "GsaQueryLayoutItemProperties", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "section_items": "sectionItems", - } - - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaQueryLayoutItemProperties", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "bool | None | Unset_Type" = Unset, - guid: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - section_items: "GsaQueryLayoutItemProperties | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutSectionProperties - a model defined in Swagger - - Parameters - ---------- - display_names: bool | None, optional - guid: bool | None, optional - name: bool | None, optional - section_items: GsaQueryLayoutItemProperties, optional - """ - self._section_items: GsaQueryLayoutItemProperties | Unset_Type = Unset - self._display_names: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if section_items is not Unset: - self.section_items = section_items - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def section_items(self) -> "GsaQueryLayoutItemProperties | Unset_Type": - """Gets the section_items of this GsaQueryLayoutSectionProperties. - - Returns - ------- - GsaQueryLayoutItemProperties | Unset_Type - The section_items of this GsaQueryLayoutSectionProperties. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "GsaQueryLayoutItemProperties | Unset_Type") -> None: - """Sets the section_items of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - section_items: GsaQueryLayoutItemProperties | Unset_Type - The section_items of this GsaQueryLayoutSectionProperties. - """ - # Field is not nullable - if section_items is None: - raise ValueError("Invalid value for 'section_items', must not be 'None'") - self._section_items = section_items - - @property - def display_names(self) -> "bool | None | Unset_Type": - """Gets the display_names of this GsaQueryLayoutSectionProperties. - - Returns - ------- - bool | None | Unset_Type - The display_names of this GsaQueryLayoutSectionProperties. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "bool | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - display_names: bool | None | Unset_Type - The display_names of this GsaQueryLayoutSectionProperties. - """ - self._display_names = display_names - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryLayoutSectionProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryLayoutSectionProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryLayoutSectionProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutSectionProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryLayoutSectionProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryLayoutSectionProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_info.py deleted file mode 100644 index 32bb313b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSectionsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "layout_sections": "list[GsaQueryLayoutSection]", - } - - attribute_map: dict[str, str] = { - "layout_sections": "layoutSections", - } - - subtype_mapping: dict[str, str] = { - "layoutSections": "GsaQueryLayoutSection", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - layout_sections: "list[GsaQueryLayoutSection]", - ) -> None: - """GsaQueryLayoutSectionsInfo - a model defined in Swagger - - Parameters - ---------- - layout_sections: list[GsaQueryLayoutSection] - """ - self._layout_sections: list[GsaQueryLayoutSection] - - self.layout_sections = layout_sections - - @property - def layout_sections(self) -> "list[GsaQueryLayoutSection]": - """Gets the layout_sections of this GsaQueryLayoutSectionsInfo. - - Returns - ------- - list[GsaQueryLayoutSection] - The layout_sections of this GsaQueryLayoutSectionsInfo. - """ - return self._layout_sections - - @layout_sections.setter - def layout_sections(self, layout_sections: "list[GsaQueryLayoutSection]") -> None: - """Sets the layout_sections of this GsaQueryLayoutSectionsInfo. - - Parameters - ---------- - layout_sections: list[GsaQueryLayoutSection] - The layout_sections of this GsaQueryLayoutSectionsInfo. - """ - # Field is not nullable - if layout_sections is None: - raise ValueError("Invalid value for 'layout_sections', must not be 'None'") - # Field is required - if layout_sections is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'layout_sections', must not be 'Unset'") - self._layout_sections = layout_sections - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_request.py deleted file mode 100644 index c2282c2f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layout_sections_request.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSectionsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "properties": "GsaQueryLayoutSectionProperties", - "filter": "GsaQueryLayoutSectionFilter", - } - - attribute_map: dict[str, str] = { - "properties": "properties", - "filter": "filter", - } - - subtype_mapping: dict[str, str] = { - "properties": "GsaQueryLayoutSectionProperties", - "filter": "GsaQueryLayoutSectionFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - properties: "GsaQueryLayoutSectionProperties", - filter: "GsaQueryLayoutSectionFilter | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutSectionsRequest - a model defined in Swagger - - Parameters - ---------- - properties: GsaQueryLayoutSectionProperties - filter: GsaQueryLayoutSectionFilter, optional - """ - self._properties: GsaQueryLayoutSectionProperties - self._filter: GsaQueryLayoutSectionFilter | Unset_Type = Unset - - self.properties = properties - if filter is not Unset: - self.filter = filter - - @property - def properties(self) -> "GsaQueryLayoutSectionProperties": - """Gets the properties of this GsaQueryLayoutSectionsRequest. - - Returns - ------- - GsaQueryLayoutSectionProperties - The properties of this GsaQueryLayoutSectionsRequest. - """ - return self._properties - - @properties.setter - def properties(self, properties: "GsaQueryLayoutSectionProperties") -> None: - """Sets the properties of this GsaQueryLayoutSectionsRequest. - - Parameters - ---------- - properties: GsaQueryLayoutSectionProperties - The properties of this GsaQueryLayoutSectionsRequest. - """ - # Field is not nullable - if properties is None: - raise ValueError("Invalid value for 'properties', must not be 'None'") - # Field is required - if properties is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'properties', must not be 'Unset'") - self._properties = properties - - @property - def filter(self) -> "GsaQueryLayoutSectionFilter | Unset_Type": - """Gets the filter of this GsaQueryLayoutSectionsRequest. - - Returns - ------- - GsaQueryLayoutSectionFilter | Unset_Type - The filter of this GsaQueryLayoutSectionsRequest. - """ - return self._filter - - @filter.setter - def filter(self, filter: "GsaQueryLayoutSectionFilter | Unset_Type") -> None: - """Sets the filter of this GsaQueryLayoutSectionsRequest. - - Parameters - ---------- - filter: GsaQueryLayoutSectionFilter | Unset_Type - The filter of this GsaQueryLayoutSectionsRequest. - """ - # Field is not nullable - if filter is None: - raise ValueError("Invalid value for 'filter', must not be 'None'") - self._filter = filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_info.py deleted file mode 100644 index c41d45f3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "layouts": "list[GsaQueryLayout]", - } - - attribute_map: dict[str, str] = { - "layouts": "layouts", - } - - subtype_mapping: dict[str, str] = { - "layouts": "GsaQueryLayout", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - layouts: "list[GsaQueryLayout]", - ) -> None: - """GsaQueryLayoutsInfo - a model defined in Swagger - - Parameters - ---------- - layouts: list[GsaQueryLayout] - """ - self._layouts: list[GsaQueryLayout] - - self.layouts = layouts - - @property - def layouts(self) -> "list[GsaQueryLayout]": - """Gets the layouts of this GsaQueryLayoutsInfo. - - Returns - ------- - list[GsaQueryLayout] - The layouts of this GsaQueryLayoutsInfo. - """ - return self._layouts - - @layouts.setter - def layouts(self, layouts: "list[GsaQueryLayout]") -> None: - """Sets the layouts of this GsaQueryLayoutsInfo. - - Parameters - ---------- - layouts: list[GsaQueryLayout] - The layouts of this GsaQueryLayoutsInfo. - """ - # Field is not nullable - if layouts is None: - raise ValueError("Invalid value for 'layouts', must not be 'None'") - # Field is required - if layouts is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'layouts', must not be 'Unset'") - self._layouts = layouts - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_request.py deleted file mode 100644 index d37b1f2a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_layouts_request.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "properties": "GsaQueryLayoutProperties", - "filter": "GsaQueryLayoutFilter", - } - - attribute_map: dict[str, str] = { - "properties": "properties", - "filter": "filter", - } - - subtype_mapping: dict[str, str] = { - "properties": "GsaQueryLayoutProperties", - "filter": "GsaQueryLayoutFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - properties: "GsaQueryLayoutProperties", - filter: "GsaQueryLayoutFilter | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutsRequest - a model defined in Swagger - - Parameters - ---------- - properties: GsaQueryLayoutProperties - filter: GsaQueryLayoutFilter, optional - """ - self._properties: GsaQueryLayoutProperties - self._filter: GsaQueryLayoutFilter | Unset_Type = Unset - - self.properties = properties - if filter is not Unset: - self.filter = filter - - @property - def properties(self) -> "GsaQueryLayoutProperties": - """Gets the properties of this GsaQueryLayoutsRequest. - - Returns - ------- - GsaQueryLayoutProperties - The properties of this GsaQueryLayoutsRequest. - """ - return self._properties - - @properties.setter - def properties(self, properties: "GsaQueryLayoutProperties") -> None: - """Sets the properties of this GsaQueryLayoutsRequest. - - Parameters - ---------- - properties: GsaQueryLayoutProperties - The properties of this GsaQueryLayoutsRequest. - """ - # Field is not nullable - if properties is None: - raise ValueError("Invalid value for 'properties', must not be 'None'") - # Field is required - if properties is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'properties', must not be 'Unset'") - self._properties = properties - - @property - def filter(self) -> "GsaQueryLayoutFilter | Unset_Type": - """Gets the filter of this GsaQueryLayoutsRequest. - - Returns - ------- - GsaQueryLayoutFilter | Unset_Type - The filter of this GsaQueryLayoutsRequest. - """ - return self._filter - - @filter.setter - def filter(self, filter: "GsaQueryLayoutFilter | Unset_Type") -> None: - """Sets the filter of this GsaQueryLayoutsRequest. - - Parameters - ---------- - filter: GsaQueryLayoutFilter | Unset_Type - The filter of this GsaQueryLayoutsRequest. - """ - # Field is not nullable - if filter is None: - raise ValueError("Invalid value for 'filter', must not be 'None'") - self._filter = filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity.py deleted file mode 100644 index f003245c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQuerySlimEntity(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQuerySlimEntity - a model defined in Swagger - - Parameters - ---------- - guid: str | None, optional - """ - self._guid: str | None | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQuerySlimEntity. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQuerySlimEntity. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQuerySlimEntity. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQuerySlimEntity. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQuerySlimEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity_properties.py deleted file mode 100644 index 30083cf5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_entity_properties.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQuerySlimEntityProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaQuerySlimEntityProperties - a model defined in Swagger - - Parameters - ---------- - guid: bool | None, optional - """ - self._guid: bool | None | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQuerySlimEntityProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQuerySlimEntityProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQuerySlimEntityProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQuerySlimEntityProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQuerySlimEntityProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_named_entity_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_named_entity_filter.py deleted file mode 100644 index 0cd6dd8b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_slim_named_entity_filter.py +++ /dev/null @@ -1,175 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQuerySlimNamedEntityFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "list[str]", - "name": "list[str]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "list[str] | None | Unset_Type" = Unset, - name: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaQuerySlimNamedEntityFilter - a model defined in Swagger - - Parameters - ---------- - guid: list[str] | None, optional - name: list[str] | None, optional - """ - self._name: list[str] | None | Unset_Type = Unset - self._guid: list[str] | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def name(self) -> "list[str] | None | Unset_Type": - """Gets the name of this GsaQuerySlimNamedEntityFilter. - If set, entity name must match any of these names. - - Returns - ------- - list[str] | None | Unset_Type - The name of this GsaQuerySlimNamedEntityFilter. - """ - return self._name - - @name.setter - def name(self, name: "list[str] | None | Unset_Type") -> None: - """Sets the name of this GsaQuerySlimNamedEntityFilter. - If set, entity name must match any of these names. - - Parameters - ---------- - name: list[str] | None | Unset_Type - The name of this GsaQuerySlimNamedEntityFilter. - """ - self._name = name - - @property - def guid(self) -> "list[str] | None | Unset_Type": - """Gets the guid of this GsaQuerySlimNamedEntityFilter. - If set, entity GUID must match any of these GUIDs. - - Returns - ------- - list[str] | None | Unset_Type - The guid of this GsaQuerySlimNamedEntityFilter. - """ - return self._guid - - @guid.setter - def guid(self, guid: "list[str] | None | Unset_Type") -> None: - """Sets the guid of this GsaQuerySlimNamedEntityFilter. - If set, entity GUID must match any of these GUIDs. - - Parameters - ---------- - guid: list[str] | None | Unset_Type - The guid of this GsaQuerySlimNamedEntityFilter. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQuerySlimNamedEntityFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column.py deleted file mode 100644 index d89e470d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column.py +++ /dev/null @@ -1,233 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryTabularColumn(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "linked_attribute_guid": "str", - "linked_column_guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "linked_attribute_guid": "linkedAttributeGuid", - "linked_column_guid": "linkedColumnGuid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | None | Unset_Type" = Unset, - linked_attribute_guid: "str | None | Unset_Type" = Unset, - linked_column_guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryTabularColumn - a model defined in Swagger - - Parameters - ---------- - guid: str | None, optional - linked_attribute_guid: str | None, optional - linked_column_guid: str | None, optional - name: str | None, optional - """ - self._linked_attribute_guid: str | None | Unset_Type = Unset - self._linked_column_guid: str | None | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if linked_attribute_guid is not Unset: - self.linked_attribute_guid = linked_attribute_guid - if linked_column_guid is not Unset: - self.linked_column_guid = linked_column_guid - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def linked_attribute_guid(self) -> "str | None | Unset_Type": - """Gets the linked_attribute_guid of this GsaQueryTabularColumn. - This can only be populated for linked attribute type columns - - Returns - ------- - str | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumn. - """ - return self._linked_attribute_guid - - @linked_attribute_guid.setter - def linked_attribute_guid(self, linked_attribute_guid: "str | None | Unset_Type") -> None: - """Sets the linked_attribute_guid of this GsaQueryTabularColumn. - This can only be populated for linked attribute type columns - - Parameters - ---------- - linked_attribute_guid: str | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumn. - """ - self._linked_attribute_guid = linked_attribute_guid - - @property - def linked_column_guid(self) -> "str | None | Unset_Type": - """Gets the linked_column_guid of this GsaQueryTabularColumn. - This can only be populated for linked column type columns - - Returns - ------- - str | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumn. - """ - return self._linked_column_guid - - @linked_column_guid.setter - def linked_column_guid(self, linked_column_guid: "str | None | Unset_Type") -> None: - """Sets the linked_column_guid of this GsaQueryTabularColumn. - This can only be populated for linked column type columns - - Parameters - ---------- - linked_column_guid: str | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumn. - """ - self._linked_column_guid = linked_column_guid - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryTabularColumn. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryTabularColumn. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryTabularColumn. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryTabularColumn. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryTabularColumn. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryTabularColumn. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryTabularColumn. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryTabularColumn. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryTabularColumn): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column_properties.py deleted file mode 100644 index 06db396d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_query_tabular_column_properties.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryTabularColumnProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "bool", - "linked_attribute_guid": "bool", - "linked_column_guid": "bool", - "name": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "linked_attribute_guid": "linkedAttributeGuid", - "linked_column_guid": "linkedColumnGuid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "bool | None | Unset_Type" = Unset, - linked_attribute_guid: "bool | None | Unset_Type" = Unset, - linked_column_guid: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryTabularColumnProperties - a model defined in Swagger - - Parameters - ---------- - guid: bool | None, optional - linked_attribute_guid: bool | None, optional - linked_column_guid: bool | None, optional - name: bool | None, optional - """ - self._linked_attribute_guid: bool | None | Unset_Type = Unset - self._linked_column_guid: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if linked_attribute_guid is not Unset: - self.linked_attribute_guid = linked_attribute_guid - if linked_column_guid is not Unset: - self.linked_column_guid = linked_column_guid - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def linked_attribute_guid(self) -> "bool | None | Unset_Type": - """Gets the linked_attribute_guid of this GsaQueryTabularColumnProperties. - - Returns - ------- - bool | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumnProperties. - """ - return self._linked_attribute_guid - - @linked_attribute_guid.setter - def linked_attribute_guid(self, linked_attribute_guid: "bool | None | Unset_Type") -> None: - """Sets the linked_attribute_guid of this GsaQueryTabularColumnProperties. - - Parameters - ---------- - linked_attribute_guid: bool | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumnProperties. - """ - self._linked_attribute_guid = linked_attribute_guid - - @property - def linked_column_guid(self) -> "bool | None | Unset_Type": - """Gets the linked_column_guid of this GsaQueryTabularColumnProperties. - This can only be populated for linked column type columns - - Returns - ------- - bool | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumnProperties. - """ - return self._linked_column_guid - - @linked_column_guid.setter - def linked_column_guid(self, linked_column_guid: "bool | None | Unset_Type") -> None: - """Sets the linked_column_guid of this GsaQueryTabularColumnProperties. - This can only be populated for linked column type columns - - Parameters - ---------- - linked_column_guid: bool | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumnProperties. - """ - self._linked_column_guid = linked_column_guid - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryTabularColumnProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryTabularColumnProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryTabularColumnProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryTabularColumnProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryTabularColumnProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryTabularColumnProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryTabularColumnProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryTabularColumnProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryTabularColumnProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_attribute.py index 17b0ea9e..6c0b3306 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_attribute.py @@ -69,7 +69,6 @@ class GsaRangeAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -85,7 +84,6 @@ class GsaRangeAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -109,7 +107,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.RANGE, @@ -127,7 +124,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -142,7 +138,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_chart_data.py deleted file mode 100644 index bf798d6d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_chart_data.py +++ /dev/null @@ -1,229 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRangeChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "estimated": "bool", - "high_value": "float", - "low_value": "float", - "record_version_guid": "str", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "estimated": "estimated", - "high_value": "highValue", - "low_value": "lowValue", - "record_version_guid": "recordVersionGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.RANGE, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - estimated: "bool | Unset_Type" = Unset, - high_value: "float | Unset_Type" = Unset, - low_value: "float | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaRangeChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - estimated: bool, optional - high_value: float, optional - low_value: float, optional - record_version_guid: str, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._low_value: float | Unset_Type = Unset - self._high_value: float | Unset_Type = Unset - self._estimated: bool | Unset_Type = Unset - - if low_value is not Unset: - self.low_value = low_value - if high_value is not Unset: - self.high_value = high_value - if estimated is not Unset: - self.estimated = estimated - - @property - def low_value(self) -> "float | Unset_Type": - """Gets the low_value of this GsaRangeChartData. - - Returns - ------- - float | Unset_Type - The low_value of this GsaRangeChartData. - """ - return self._low_value - - @low_value.setter - def low_value(self, low_value: "float | Unset_Type") -> None: - """Sets the low_value of this GsaRangeChartData. - - Parameters - ---------- - low_value: float | Unset_Type - The low_value of this GsaRangeChartData. - """ - # Field is not nullable - if low_value is None: - raise ValueError("Invalid value for 'low_value', must not be 'None'") - self._low_value = low_value - - @property - def high_value(self) -> "float | Unset_Type": - """Gets the high_value of this GsaRangeChartData. - - Returns - ------- - float | Unset_Type - The high_value of this GsaRangeChartData. - """ - return self._high_value - - @high_value.setter - def high_value(self, high_value: "float | Unset_Type") -> None: - """Sets the high_value of this GsaRangeChartData. - - Parameters - ---------- - high_value: float | Unset_Type - The high_value of this GsaRangeChartData. - """ - # Field is not nullable - if high_value is None: - raise ValueError("Invalid value for 'high_value', must not be 'None'") - self._high_value = high_value - - @property - def estimated(self) -> "bool | Unset_Type": - """Gets the estimated of this GsaRangeChartData. - - Returns - ------- - bool | Unset_Type - The estimated of this GsaRangeChartData. - """ - return self._estimated - - @estimated.setter - def estimated(self, estimated: "bool | Unset_Type") -> None: - """Sets the estimated of this GsaRangeChartData. - - Parameters - ---------- - estimated: bool | Unset_Type - The estimated of this GsaRangeChartData. - """ - # Field is not nullable - if estimated is None: - raise ValueError("Invalid value for 'estimated', must not be 'None'") - self._estimated = estimated - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRangeChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_datum.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_datum.py index d8def5ed..ed7e7d42 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_datum.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_datum.py @@ -68,10 +68,12 @@ class GsaRangeDatum(GsaApplicableDatum): swagger_types: dict[str, str] = { "datum_type": "GsaDatumType", "estimated": "bool", + "high_value": "float", + "high_value_is_inclusive": "bool", + "low_value": "float", + "low_value_is_inclusive": "bool", "not_applicable": "str", - "high_endpoint": "GsaRangeEndpoint", "high_value_significant_figures_info": "GsaSignificantFiguresInfo", - "low_endpoint": "GsaRangeEndpoint", "low_value_significant_figures_info": "GsaSignificantFiguresInfo", "unit": "GsaSlimUnit", } @@ -79,17 +81,17 @@ class GsaRangeDatum(GsaApplicableDatum): attribute_map: dict[str, str] = { "datum_type": "datumType", "estimated": "estimated", + "high_value": "highValue", + "high_value_is_inclusive": "highValueIsInclusive", + "low_value": "lowValue", + "low_value_is_inclusive": "lowValueIsInclusive", "not_applicable": "notApplicable", - "high_endpoint": "highEndpoint", "high_value_significant_figures_info": "highValueSignificantFiguresInfo", - "low_endpoint": "lowEndpoint", "low_value_significant_figures_info": "lowValueSignificantFiguresInfo", "unit": "unit", } subtype_mapping: dict[str, str] = { - "highEndpoint": "GsaRangeEndpoint", - "lowEndpoint": "GsaRangeEndpoint", "lowValueSignificantFiguresInfo": "GsaSignificantFiguresInfo", "highValueSignificantFiguresInfo": "GsaSignificantFiguresInfo", "unit": "GsaSlimUnit", @@ -102,10 +104,12 @@ def __init__( *, datum_type: "GsaDatumType" = GsaDatumType.RANGE, estimated: "bool", + high_value: "float", + high_value_is_inclusive: "bool", + low_value: "float", + low_value_is_inclusive: "bool", not_applicable: "str | None" = "applicable", - high_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, high_value_significant_figures_info: "GsaSignificantFiguresInfo | Unset_Type" = Unset, - low_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, low_value_significant_figures_info: "GsaSignificantFiguresInfo | Unset_Type" = Unset, unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: @@ -115,25 +119,29 @@ def __init__( ---------- datum_type: GsaDatumType estimated: bool + high_value: float + high_value_is_inclusive: bool + low_value: float + low_value_is_inclusive: bool not_applicable: str | None - high_endpoint: GsaRangeEndpoint, optional high_value_significant_figures_info: GsaSignificantFiguresInfo, optional - low_endpoint: GsaRangeEndpoint, optional low_value_significant_figures_info: GsaSignificantFiguresInfo, optional unit: GsaSlimUnit, optional """ super().__init__(datum_type=datum_type, not_applicable=not_applicable) - self._high_endpoint: GsaRangeEndpoint | Unset_Type = Unset - self._low_endpoint: GsaRangeEndpoint | Unset_Type = Unset + self._low_value: float + self._high_value: float + self._low_value_is_inclusive: bool + self._high_value_is_inclusive: bool self._low_value_significant_figures_info: GsaSignificantFiguresInfo | Unset_Type = Unset self._high_value_significant_figures_info: GsaSignificantFiguresInfo | Unset_Type = Unset self._estimated: bool self._unit: GsaSlimUnit | Unset_Type = Unset - if high_endpoint is not Unset: - self.high_endpoint = high_endpoint - if low_endpoint is not Unset: - self.low_endpoint = low_endpoint + self.low_value = low_value + self.high_value = high_value + self.low_value_is_inclusive = low_value_is_inclusive + self.high_value_is_inclusive = high_value_is_inclusive if low_value_significant_figures_info is not Unset: self.low_value_significant_figures_info = low_value_significant_figures_info if high_value_significant_figures_info is not Unset: @@ -143,54 +151,116 @@ def __init__( self.unit = unit @property - def high_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the high_endpoint of this GsaRangeDatum. + def low_value(self) -> "float": + """Gets the low_value of this GsaRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaRangeDatum. + float + The low_value of this GsaRangeDatum. """ - return self._high_endpoint + return self._low_value - @high_endpoint.setter - def high_endpoint(self, high_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the high_endpoint of this GsaRangeDatum. + @low_value.setter + def low_value(self, low_value: "float") -> None: + """Sets the low_value of this GsaRangeDatum. Parameters ---------- - high_endpoint: GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaRangeDatum. + low_value: float + The low_value of this GsaRangeDatum. """ # Field is not nullable - if high_endpoint is None: - raise ValueError("Invalid value for 'high_endpoint', must not be 'None'") - self._high_endpoint = high_endpoint + if low_value is None: + raise ValueError("Invalid value for 'low_value', must not be 'None'") + # Field is required + if low_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value', must not be 'Unset'") + self._low_value = low_value + + @property + def high_value(self) -> "float": + """Gets the high_value of this GsaRangeDatum. + + Returns + ------- + float + The high_value of this GsaRangeDatum. + """ + return self._high_value + + @high_value.setter + def high_value(self, high_value: "float") -> None: + """Sets the high_value of this GsaRangeDatum. + + Parameters + ---------- + high_value: float + The high_value of this GsaRangeDatum. + """ + # Field is not nullable + if high_value is None: + raise ValueError("Invalid value for 'high_value', must not be 'None'") + # Field is required + if high_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value', must not be 'Unset'") + self._high_value = high_value + + @property + def low_value_is_inclusive(self) -> "bool": + """Gets the low_value_is_inclusive of this GsaRangeDatum. + + Returns + ------- + bool + The low_value_is_inclusive of this GsaRangeDatum. + """ + return self._low_value_is_inclusive + + @low_value_is_inclusive.setter + def low_value_is_inclusive(self, low_value_is_inclusive: "bool") -> None: + """Sets the low_value_is_inclusive of this GsaRangeDatum. + + Parameters + ---------- + low_value_is_inclusive: bool + The low_value_is_inclusive of this GsaRangeDatum. + """ + # Field is not nullable + if low_value_is_inclusive is None: + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'None'") + # Field is required + if low_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'Unset'") + self._low_value_is_inclusive = low_value_is_inclusive @property - def low_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the low_endpoint of this GsaRangeDatum. + def high_value_is_inclusive(self) -> "bool": + """Gets the high_value_is_inclusive of this GsaRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaRangeDatum. + bool + The high_value_is_inclusive of this GsaRangeDatum. """ - return self._low_endpoint + return self._high_value_is_inclusive - @low_endpoint.setter - def low_endpoint(self, low_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the low_endpoint of this GsaRangeDatum. + @high_value_is_inclusive.setter + def high_value_is_inclusive(self, high_value_is_inclusive: "bool") -> None: + """Sets the high_value_is_inclusive of this GsaRangeDatum. Parameters ---------- - low_endpoint: GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaRangeDatum. + high_value_is_inclusive: bool + The high_value_is_inclusive of this GsaRangeDatum. """ # Field is not nullable - if low_endpoint is None: - raise ValueError("Invalid value for 'low_endpoint', must not be 'None'") - self._low_endpoint = low_endpoint + if high_value_is_inclusive is None: + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'None'") + # Field is required + if high_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'Unset'") + self._high_value_is_inclusive = high_value_is_inclusive @property def low_value_significant_figures_info(self) -> "GsaSignificantFiguresInfo | Unset_Type": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_endpoint.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_endpoint.py deleted file mode 100644 index 65982c52..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_range_endpoint.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRangeEndpoint(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "inclusiveness": "GsaInclusiveness", - "value": "float", - } - - attribute_map: dict[str, str] = { - "inclusiveness": "inclusiveness", - "value": "value", - } - - subtype_mapping: dict[str, str] = { - "inclusiveness": "GsaInclusiveness", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - inclusiveness: "GsaInclusiveness", - value: "float", - ) -> None: - """GsaRangeEndpoint - a model defined in Swagger - - Parameters - ---------- - inclusiveness: GsaInclusiveness - value: float - """ - self._value: float - self._inclusiveness: GsaInclusiveness - - self.value = value - self.inclusiveness = inclusiveness - - @property - def value(self) -> "float": - """Gets the value of this GsaRangeEndpoint. - - Returns - ------- - float - The value of this GsaRangeEndpoint. - """ - return self._value - - @value.setter - def value(self, value: "float") -> None: - """Sets the value of this GsaRangeEndpoint. - - Parameters - ---------- - value: float - The value of this GsaRangeEndpoint. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - # Field is required - if value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'value', must not be 'Unset'") - self._value = value - - @property - def inclusiveness(self) -> "GsaInclusiveness": - """Gets the inclusiveness of this GsaRangeEndpoint. - - Returns - ------- - GsaInclusiveness - The inclusiveness of this GsaRangeEndpoint. - """ - return self._inclusiveness - - @inclusiveness.setter - def inclusiveness(self, inclusiveness: "GsaInclusiveness") -> None: - """Sets the inclusiveness of this GsaRangeEndpoint. - - Parameters - ---------- - inclusiveness: GsaInclusiveness - The inclusiveness of this GsaRangeEndpoint. - """ - # Field is not nullable - if inclusiveness is None: - raise ValueError("Invalid value for 'inclusiveness', must not be 'None'") - # Field is required - if inclusiveness is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'inclusiveness', must not be 'Unset'") - self._inclusiveness = inclusiveness - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRangeEndpoint): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_and_attribute_selection_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_and_attribute_selection_type.py deleted file mode 100644 index 32ff25b2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_and_attribute_selection_type.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaRecordAndAttributeSelectionType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - PROFILE = "Profile" - ALLATTRIBUTES = "AllAttributes" - ALLATTRIBUTESANDRECORDS = "AllAttributesAndRecords" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_user_capabilities.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_capabilities.py similarity index 86% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_user_capabilities.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_capabilities.py index a435ddb1..64de483c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_user_capabilities.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_capabilities.py @@ -42,7 +42,7 @@ from . import * -class GsaRecordUserCapabilities(ModelBase): +class GsaRecordCapabilities(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -92,7 +92,7 @@ def __init__( can_withdraw: "bool", can_write: "bool", ) -> None: - """GsaRecordUserCapabilities - a model defined in Swagger + """GsaRecordCapabilities - a model defined in Swagger Parameters ---------- @@ -119,25 +119,25 @@ def __init__( @property def can_write(self) -> "bool": - """Gets the can_write of this GsaRecordUserCapabilities. + """Gets the can_write of this GsaRecordCapabilities. True if the current user has write permission for this record version, and is in write mode. Write permission is required to edit record properties, and to perform version control actions. Returns ------- bool - The can_write of this GsaRecordUserCapabilities. + The can_write of this GsaRecordCapabilities. """ return self._can_write @can_write.setter def can_write(self, can_write: "bool") -> None: - """Sets the can_write of this GsaRecordUserCapabilities. + """Sets the can_write of this GsaRecordCapabilities. True if the current user has write permission for this record version, and is in write mode. Write permission is required to edit record properties, and to perform version control actions. Parameters ---------- can_write: bool - The can_write of this GsaRecordUserCapabilities. + The can_write of this GsaRecordCapabilities. """ # Field is not nullable if can_write is None: @@ -149,25 +149,25 @@ def can_write(self, can_write: "bool") -> None: @property def can_modify(self) -> "bool": - """Gets the can_modify of this GsaRecordUserCapabilities. + """Gets the can_modify of this GsaRecordCapabilities. True if the current user can modify this record version, e.g. edit record properties. The user needs write permission, and if the table is version controlled, the record must be unreleased. Returns ------- bool - The can_modify of this GsaRecordUserCapabilities. + The can_modify of this GsaRecordCapabilities. """ return self._can_modify @can_modify.setter def can_modify(self, can_modify: "bool") -> None: - """Sets the can_modify of this GsaRecordUserCapabilities. + """Sets the can_modify of this GsaRecordCapabilities. True if the current user can modify this record version, e.g. edit record properties. The user needs write permission, and if the table is version controlled, the record must be unreleased. Parameters ---------- can_modify: bool - The can_modify of this GsaRecordUserCapabilities. + The can_modify of this GsaRecordCapabilities. """ # Field is not nullable if can_modify is None: @@ -179,25 +179,25 @@ def can_modify(self, can_modify: "bool") -> None: @property def can_release(self) -> "bool": - """Gets the can_release of this GsaRecordUserCapabilities. + """Gets the can_release of this GsaRecordCapabilities. True if the current user can release this record version. Returns ------- bool - The can_release of this GsaRecordUserCapabilities. + The can_release of this GsaRecordCapabilities. """ return self._can_release @can_release.setter def can_release(self, can_release: "bool") -> None: - """Sets the can_release of this GsaRecordUserCapabilities. + """Sets the can_release of this GsaRecordCapabilities. True if the current user can release this record version. Parameters ---------- can_release: bool - The can_release of this GsaRecordUserCapabilities. + The can_release of this GsaRecordCapabilities. """ # Field is not nullable if can_release is None: @@ -209,25 +209,25 @@ def can_release(self, can_release: "bool") -> None: @property def can_get_modifiable_version(self) -> "bool": - """Gets the can_get_modifiable_version of this GsaRecordUserCapabilities. + """Gets the can_get_modifiable_version of this GsaRecordCapabilities. True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists). Returns ------- bool - The can_get_modifiable_version of this GsaRecordUserCapabilities. + The can_get_modifiable_version of this GsaRecordCapabilities. """ return self._can_get_modifiable_version @can_get_modifiable_version.setter def can_get_modifiable_version(self, can_get_modifiable_version: "bool") -> None: - """Sets the can_get_modifiable_version of this GsaRecordUserCapabilities. + """Sets the can_get_modifiable_version of this GsaRecordCapabilities. True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists). Parameters ---------- can_get_modifiable_version: bool - The can_get_modifiable_version of this GsaRecordUserCapabilities. + The can_get_modifiable_version of this GsaRecordCapabilities. """ # Field is not nullable if can_get_modifiable_version is None: @@ -239,25 +239,25 @@ def can_get_modifiable_version(self, can_get_modifiable_version: "bool") -> None @property def can_withdraw(self) -> "bool": - """Gets the can_withdraw of this GsaRecordUserCapabilities. + """Gets the can_withdraw of this GsaRecordCapabilities. True if the current user can withdraw this record version. Returns ------- bool - The can_withdraw of this GsaRecordUserCapabilities. + The can_withdraw of this GsaRecordCapabilities. """ return self._can_withdraw @can_withdraw.setter def can_withdraw(self, can_withdraw: "bool") -> None: - """Sets the can_withdraw of this GsaRecordUserCapabilities. + """Sets the can_withdraw of this GsaRecordCapabilities. True if the current user can withdraw this record version. Parameters ---------- can_withdraw: bool - The can_withdraw of this GsaRecordUserCapabilities. + The can_withdraw of this GsaRecordCapabilities. """ # Field is not nullable if can_withdraw is None: @@ -269,25 +269,25 @@ def can_withdraw(self, can_withdraw: "bool") -> None: @property def can_delete(self) -> "bool": - """Gets the can_delete of this GsaRecordUserCapabilities. + """Gets the can_delete of this GsaRecordCapabilities. True if the current user can delete this record version. Returns ------- bool - The can_delete of this GsaRecordUserCapabilities. + The can_delete of this GsaRecordCapabilities. """ return self._can_delete @can_delete.setter def can_delete(self, can_delete: "bool") -> None: - """Sets the can_delete of this GsaRecordUserCapabilities. + """Sets the can_delete of this GsaRecordCapabilities. True if the current user can delete this record version. Parameters ---------- can_delete: bool - The can_delete of this GsaRecordUserCapabilities. + The can_delete of this GsaRecordCapabilities. """ # Field is not nullable if can_delete is None: @@ -319,7 +319,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordUserCapabilities): + if not isinstance(other, GsaRecordCapabilities): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_copy_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_copy_exception.py index 7ede021f..172e8dec 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_copy_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_copy_exception.py @@ -61,22 +61,20 @@ class GsaRecordHistoryCopyException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaErrorDetailOfRecordHistoryErrorReason]", + "code": "SystemNetHttpStatusCode", + "errors": "list[GsaErrorDetail]", "message": "str", - "record_history_guid": "str", } attribute_map: dict[str, str] = { "code": "code", "errors": "errors", "message": "message", - "record_history_guid": "recordHistoryGuid", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaErrorDetailOfRecordHistoryErrorReason", + "code": "SystemNetHttpStatusCode", + "errors": "GsaErrorDetail", } discriminator: Optional[str] = None @@ -84,31 +82,26 @@ class GsaRecordHistoryCopyException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, + errors: "list[GsaErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, - record_history_guid: "str | Unset_Type" = Unset, ) -> None: """GsaRecordHistoryCopyException - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional - errors: list[GsaErrorDetailOfRecordHistoryErrorReason] | None, optional + code: SystemNetHttpStatusCode, optional + errors: list[GsaErrorDetail] | None, optional message: str | None, optional - record_history_guid: str, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._record_history_guid: str | Unset_Type = Unset - self._errors: list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - if record_history_guid is not Unset: - self.record_history_guid = record_history_guid if errors is not Unset: self.errors = errors @@ -135,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaRecordHistoryCopyException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryCopyException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaRecordHistoryCopyException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryCopyException. """ # Field is not nullable @@ -160,50 +153,23 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: self._code = code @property - def record_history_guid(self) -> "str | Unset_Type": - """Gets the record_history_guid of this GsaRecordHistoryCopyException. - - Returns - ------- - str | Unset_Type - The record_history_guid of this GsaRecordHistoryCopyException. - """ - return self._record_history_guid - - @record_history_guid.setter - def record_history_guid(self, record_history_guid: "str | Unset_Type") -> None: - """Sets the record_history_guid of this GsaRecordHistoryCopyException. - - Parameters - ---------- - record_history_guid: str | Unset_Type - The record_history_guid of this GsaRecordHistoryCopyException. - """ - # Field is not nullable - if record_history_guid is None: - raise ValueError("Invalid value for 'record_history_guid', must not be 'None'") - self._record_history_guid = record_history_guid - - @property - def errors(self) -> "list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type": + def errors(self) -> "list[GsaErrorDetail] | None | Unset_Type": """Gets the errors of this GsaRecordHistoryCopyException. Returns ------- - list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type + list[GsaErrorDetail] | None | Unset_Type The errors of this GsaRecordHistoryCopyException. """ return self._errors @errors.setter - def errors( - self, errors: "list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type" - ) -> None: + def errors(self, errors: "list[GsaErrorDetail] | None | Unset_Type") -> None: """Sets the errors of this GsaRecordHistoryCopyException. Parameters ---------- - errors: list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type + errors: list[GsaErrorDetail] | None | Unset_Type The errors of this GsaRecordHistoryCopyException. """ self._errors = errors diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_descendants_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_descendants_access_control_entity.py deleted file mode 100644 index f3c890b2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_descendants_access_control_entity.py +++ /dev/null @@ -1,259 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity import ( # noqa: F401 - GsaAccessControlEntity, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity_type import ( - GsaAccessControlEntityType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordHistoryDescendantsAccessControlEntity(GsaAccessControlEntity): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlEntityType", - "record_history_guid": "str", - "table_guid": "str", - "latest_version_filter": "list[GsaVersionControlMode]", - "subset_guid": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "record_history_guid": "recordHistoryGuid", - "table_guid": "tableGuid", - "latest_version_filter": "latestVersionFilter", - "subset_guid": "subsetGuid", - } - - subtype_mapping: dict[str, str] = { - "latestVersionFilter": "GsaVersionControlMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlEntityType" = GsaAccessControlEntityType.RECORDHISTORYDESCENDANTS, - record_history_guid: "str", - table_guid: "str", - latest_version_filter: "list[GsaVersionControlMode] | None | Unset_Type" = Unset, - subset_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordHistoryDescendantsAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - record_history_guid: str - table_guid: str - latest_version_filter: list[GsaVersionControlMode] | None, optional - subset_guid: str | None, optional - """ - super().__init__(entity_type=entity_type) - self._record_history_guid: str - self._table_guid: str - self._subset_guid: str | None | Unset_Type = Unset - self._latest_version_filter: list[GsaVersionControlMode] | None | Unset_Type = Unset - - self.record_history_guid = record_history_guid - self.table_guid = table_guid - if subset_guid is not Unset: - self.subset_guid = subset_guid - if latest_version_filter is not Unset: - self.latest_version_filter = latest_version_filter - - @property - def record_history_guid(self) -> "str": - """Gets the record_history_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - - Returns - ------- - str - The record_history_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - return self._record_history_guid - - @record_history_guid.setter - def record_history_guid(self, record_history_guid: "str") -> None: - """Sets the record_history_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - - Parameters - ---------- - record_history_guid: str - The record_history_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - # Field is not nullable - if record_history_guid is None: - raise ValueError("Invalid value for 'record_history_guid', must not be 'None'") - # Field is required - if record_history_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_history_guid', must not be 'Unset'") - self._record_history_guid = record_history_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - - Returns - ------- - str - The table_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def subset_guid(self) -> "str | None | Unset_Type": - """Gets the subset_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - Optional. If set, only include descendants in this subset - - Returns - ------- - str | None | Unset_Type - The subset_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - return self._subset_guid - - @subset_guid.setter - def subset_guid(self, subset_guid: "str | None | Unset_Type") -> None: - """Sets the subset_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - Optional. If set, only include descendants in this subset - - Parameters - ---------- - subset_guid: str | None | Unset_Type - The subset_guid of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - self._subset_guid = subset_guid - - @property - def latest_version_filter(self) -> "list[GsaVersionControlMode] | None | Unset_Type": - """Gets the latest_version_filter of this GsaRecordHistoryDescendantsAccessControlEntity. - Optional. If set, only include descendants that match this filter. For each descendant record history: - read: include only the record version that is the latest version in read mode. - write: include only the record version that is the latest version in write mode. - read and write: include the record versions that are the latest versions in read or write mode. - empty: include record versions that are not the latest version in read or write mode. If not set, include all versions of all descendant record histories. - - Returns - ------- - list[GsaVersionControlMode] | None | Unset_Type - The latest_version_filter of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - return self._latest_version_filter - - @latest_version_filter.setter - def latest_version_filter( - self, latest_version_filter: "list[GsaVersionControlMode] | None | Unset_Type" - ) -> None: - """Sets the latest_version_filter of this GsaRecordHistoryDescendantsAccessControlEntity. - Optional. If set, only include descendants that match this filter. For each descendant record history: - read: include only the record version that is the latest version in read mode. - write: include only the record version that is the latest version in write mode. - read and write: include the record versions that are the latest versions in read or write mode. - empty: include record versions that are not the latest version in read or write mode. If not set, include all versions of all descendant record histories. - - Parameters - ---------- - latest_version_filter: list[GsaVersionControlMode] | None | Unset_Type - The latest_version_filter of this GsaRecordHistoryDescendantsAccessControlEntity. - """ - self._latest_version_filter = latest_version_filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordHistoryDescendantsAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_error_reason.py deleted file mode 100644 index 6c4c46e7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_error_reason.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaRecordHistoryErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NONAME = "NoName" - NOSHORTNAME = "NoShortName" - PARENTNOTINSAMETABLE = "ParentNotInSameTable" - PARENTNOTAFOLDER = "ParentNotAFolder" - PARENTISADESCENDANT = "ParentIsADescendant" - PARENTISITSELF = "ParentIsItself" - PARENTISWITHDRAWN = "ParentIsWithdrawn" - SHORTNAMEEXISTSINFOLDER = "ShortNameExistsInFolder" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_move_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_move_exception.py index a4212214..bac8cdc3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_move_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_history_move_exception.py @@ -61,22 +61,20 @@ class GsaRecordHistoryMoveException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaErrorDetailOfRecordHistoryErrorReason]", + "code": "SystemNetHttpStatusCode", + "errors": "list[GsaErrorDetail]", "message": "str", - "record_history_guid": "str", } attribute_map: dict[str, str] = { "code": "code", "errors": "errors", "message": "message", - "record_history_guid": "recordHistoryGuid", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaErrorDetailOfRecordHistoryErrorReason", + "code": "SystemNetHttpStatusCode", + "errors": "GsaErrorDetail", } discriminator: Optional[str] = None @@ -84,31 +82,26 @@ class GsaRecordHistoryMoveException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, + errors: "list[GsaErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, - record_history_guid: "str | Unset_Type" = Unset, ) -> None: """GsaRecordHistoryMoveException - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional - errors: list[GsaErrorDetailOfRecordHistoryErrorReason] | None, optional + code: SystemNetHttpStatusCode, optional + errors: list[GsaErrorDetail] | None, optional message: str | None, optional - record_history_guid: str, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._record_history_guid: str | Unset_Type = Unset - self._errors: list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - if record_history_guid is not Unset: - self.record_history_guid = record_history_guid if errors is not Unset: self.errors = errors @@ -135,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaRecordHistoryMoveException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryMoveException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaRecordHistoryMoveException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryMoveException. """ # Field is not nullable @@ -160,50 +153,23 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: self._code = code @property - def record_history_guid(self) -> "str | Unset_Type": - """Gets the record_history_guid of this GsaRecordHistoryMoveException. - - Returns - ------- - str | Unset_Type - The record_history_guid of this GsaRecordHistoryMoveException. - """ - return self._record_history_guid - - @record_history_guid.setter - def record_history_guid(self, record_history_guid: "str | Unset_Type") -> None: - """Sets the record_history_guid of this GsaRecordHistoryMoveException. - - Parameters - ---------- - record_history_guid: str | Unset_Type - The record_history_guid of this GsaRecordHistoryMoveException. - """ - # Field is not nullable - if record_history_guid is None: - raise ValueError("Invalid value for 'record_history_guid', must not be 'None'") - self._record_history_guid = record_history_guid - - @property - def errors(self) -> "list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type": + def errors(self) -> "list[GsaErrorDetail] | None | Unset_Type": """Gets the errors of this GsaRecordHistoryMoveException. Returns ------- - list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type + list[GsaErrorDetail] | None | Unset_Type The errors of this GsaRecordHistoryMoveException. """ return self._errors @errors.setter - def errors( - self, errors: "list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type" - ) -> None: + def errors(self, errors: "list[GsaErrorDetail] | None | Unset_Type") -> None: """Sets the errors of this GsaRecordHistoryMoveException. Parameters ---------- - errors: list[GsaErrorDetailOfRecordHistoryErrorReason] | None | Unset_Type + errors: list[GsaErrorDetail] | None | Unset_Type The errors of this GsaRecordHistoryMoveException. """ self._errors = errors diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link.py deleted file mode 100644 index d2fa5491..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link.py +++ /dev/null @@ -1,189 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "include_indirect_links": "bool", - "link_info": "GsaLinkInfo", - "name": "str", - "reverse_name": "str", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "include_indirect_links": "includeIndirectLinks", - "link_info": "linkInfo", - "name": "name", - "reverse_name": "reverseName", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - include_indirect_links: "bool", - link_info: "GsaLinkInfo", - name: "str", - reverse_name: "str", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.RECORDLINK, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLink - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - include_indirect_links: bool - link_info: GsaLinkInfo - name: str - reverse_name: str - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._include_indirect_links: bool - - self.include_indirect_links = include_indirect_links - - @property - def include_indirect_links(self) -> "bool": - """Gets the include_indirect_links of this GsaRecordLink. - - Returns - ------- - bool - The include_indirect_links of this GsaRecordLink. - """ - return self._include_indirect_links - - @include_indirect_links.setter - def include_indirect_links(self, include_indirect_links: "bool") -> None: - """Sets the include_indirect_links of this GsaRecordLink. - - Parameters - ---------- - include_indirect_links: bool - The include_indirect_links of this GsaRecordLink. - """ - # Field is not nullable - if include_indirect_links is None: - raise ValueError("Invalid value for 'include_indirect_links', must not be 'None'") - # Field is required - if include_indirect_links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'include_indirect_links', must not be 'Unset'") - self._include_indirect_links = include_indirect_links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_base.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_base.py deleted file mode 100644 index 8e6d7195..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_base.py +++ /dev/null @@ -1,292 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkBase(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "record_link_group_type": "GsaRecordLinkGroupType", - "source_record_history_guid": "str", - "target_record_history_guid": "str", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "record_link_group_type": "recordLinkGroupType", - "source_record_history_guid": "sourceRecordHistoryGuid", - "target_record_history_guid": "targetRecordHistoryGuid", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroupType": "GsaRecordLinkGroupType", - } - - discriminator_value_class_map = { - "static".lower(): "#/components/schemas/GsaStaticRecordLink", - "crossDatabase".lower(): "#/components/schemas/GsaCrossDatabaseRecordLink", - } - - discriminator: Optional[str] = "recordLinkGroupType" - - def __init__( - self, - *, - guid: "str", - record_link_group_type: "GsaRecordLinkGroupType", - source_record_history_guid: "str", - target_record_history_guid: "str", - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkBase - a model defined in Swagger - - Parameters - ---------- - guid: str - record_link_group_type: GsaRecordLinkGroupType - source_record_history_guid: str - target_record_history_guid: str - notes: str | None, optional - """ - self._record_link_group_type: GsaRecordLinkGroupType - self._source_record_history_guid: str - self._target_record_history_guid: str - self._notes: str | None | Unset_Type = Unset - self._guid: str - - self.record_link_group_type = record_link_group_type - self.source_record_history_guid = source_record_history_guid - self.target_record_history_guid = target_record_history_guid - if notes is not Unset: - self.notes = notes - self.guid = guid - - @property - def record_link_group_type(self) -> "GsaRecordLinkGroupType": - """Gets the record_link_group_type of this GsaRecordLinkBase. - - Returns - ------- - GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkBase. - """ - return self._record_link_group_type - - @record_link_group_type.setter - def record_link_group_type(self, record_link_group_type: "GsaRecordLinkGroupType") -> None: - """Sets the record_link_group_type of this GsaRecordLinkBase. - - Parameters - ---------- - record_link_group_type: GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkBase. - """ - # Field is not nullable - if record_link_group_type is None: - raise ValueError("Invalid value for 'record_link_group_type', must not be 'None'") - # Field is required - if record_link_group_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group_type', must not be 'Unset'") - self._record_link_group_type = record_link_group_type - - @property - def source_record_history_guid(self) -> "str": - """Gets the source_record_history_guid of this GsaRecordLinkBase. - - Returns - ------- - str - The source_record_history_guid of this GsaRecordLinkBase. - """ - return self._source_record_history_guid - - @source_record_history_guid.setter - def source_record_history_guid(self, source_record_history_guid: "str") -> None: - """Sets the source_record_history_guid of this GsaRecordLinkBase. - - Parameters - ---------- - source_record_history_guid: str - The source_record_history_guid of this GsaRecordLinkBase. - """ - # Field is not nullable - if source_record_history_guid is None: - raise ValueError("Invalid value for 'source_record_history_guid', must not be 'None'") - # Field is required - if source_record_history_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_record_history_guid', must not be 'Unset'") - self._source_record_history_guid = source_record_history_guid - - @property - def target_record_history_guid(self) -> "str": - """Gets the target_record_history_guid of this GsaRecordLinkBase. - - Returns - ------- - str - The target_record_history_guid of this GsaRecordLinkBase. - """ - return self._target_record_history_guid - - @target_record_history_guid.setter - def target_record_history_guid(self, target_record_history_guid: "str") -> None: - """Sets the target_record_history_guid of this GsaRecordLinkBase. - - Parameters - ---------- - target_record_history_guid: str - The target_record_history_guid of this GsaRecordLinkBase. - """ - # Field is not nullable - if target_record_history_guid is None: - raise ValueError("Invalid value for 'target_record_history_guid', must not be 'None'") - # Field is required - if target_record_history_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_record_history_guid', must not be 'Unset'") - self._target_record_history_guid = target_record_history_guid - - @property - def notes(self) -> "str | None | Unset_Type": - """Gets the notes of this GsaRecordLinkBase. - - Returns - ------- - str | None | Unset_Type - The notes of this GsaRecordLinkBase. - """ - return self._notes - - @notes.setter - def notes(self, notes: "str | None | Unset_Type") -> None: - """Sets the notes of this GsaRecordLinkBase. - - Parameters - ---------- - notes: str | None | Unset_Type - The notes of this GsaRecordLinkBase. - """ - self._notes = notes - - @property - def guid(self) -> "str": - """Gets the guid of this GsaRecordLinkBase. - - Returns - ------- - str - The guid of this GsaRecordLinkBase. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaRecordLinkBase. - - Parameters - ---------- - guid: str - The guid of this GsaRecordLinkBase. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkBase): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_create_put_layout_item.py deleted file mode 100644 index 60cba523..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_create_put_layout_item.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "link_group_guid": "str", - "type": "GsaPutType", - "forwards": "bool", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "link_group_guid": "linkGroupGuid", - "type": "type", - "forwards": "forwards", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.RECORDLINK, - link_group_guid: "str", - type: "GsaPutType" = GsaPutType.CREATE, - forwards: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - link_group_guid: str - type: GsaPutType - forwards: bool | None, optional - """ - super().__init__(item_type=item_type, type=type) - self._forwards: bool | None | Unset_Type = Unset - self._link_group_guid: str - - if forwards is not Unset: - self.forwards = forwards - self.link_group_guid = link_group_guid - - @property - def forwards(self) -> "bool | None | Unset_Type": - """Gets the forwards of this GsaRecordLinkCreatePutLayoutItem. - - Returns - ------- - bool | None | Unset_Type - The forwards of this GsaRecordLinkCreatePutLayoutItem. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool | None | Unset_Type") -> None: - """Sets the forwards of this GsaRecordLinkCreatePutLayoutItem. - - Parameters - ---------- - forwards: bool | None | Unset_Type - The forwards of this GsaRecordLinkCreatePutLayoutItem. - """ - self._forwards = forwards - - @property - def link_group_guid(self) -> "str": - """Gets the link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - - Returns - ------- - str - The link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - """ - return self._link_group_guid - - @link_group_guid.setter - def link_group_guid(self, link_group_guid: "str") -> None: - """Sets the link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - - Parameters - ---------- - link_group_guid: str - The link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - """ - # Field is not nullable - if link_group_guid is None: - raise ValueError("Invalid value for 'link_group_guid', must not be 'None'") - # Field is required - if link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_group_guid', must not be 'Unset'") - self._link_group_guid = link_group_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group.py index e6e5e3c4..744d89a7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group.py @@ -91,7 +91,7 @@ class GsaRecordLinkGroup(ModelBase): discriminator_value_class_map = { "static".lower(): "#/components/schemas/GsaStaticRecordLinkGroup", - "smart".lower(): "#/components/schemas/GsaSmartRecordLinkGroup", + "dynamic".lower(): "#/components/schemas/GsaDynamicRecordLinkGroup", "crossDatabase".lower(): "#/components/schemas/GsaCrossDatabaseRecordLinkGroup", } @@ -275,7 +275,6 @@ def reverse_display_names( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -287,7 +286,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_creation_exception.py deleted file mode 100644 index 349e4ded..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_creation_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkGroupCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaRecordLinkGroupErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaRecordLinkGroupErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkGroupCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaRecordLinkGroupErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaRecordLinkGroupCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaRecordLinkGroupCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaRecordLinkGroupCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaRecordLinkGroupCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaRecordLinkGroupCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaRecordLinkGroupCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaRecordLinkGroupCreationException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaRecordLinkGroupCreationException. - - Returns - ------- - list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkGroupCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_detail.py deleted file mode 100644 index 8bd24759..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_detail.py +++ /dev/null @@ -1,205 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkGroupErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaRecordLinkGroupErrorReason", - } - - discriminator_value_class_map = { - "forbidOrphans".lower(): "#/components/schemas/GsaForbidOrphansRecordLinkGroupErrorDetail", - "manyToManyForbidOrphans".lower(): "#/components/schemas/GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", - "nameAlreadyExistsAsReverse".lower(): "#/components/schemas/GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityRecordLinkGroupErrorDetail", - "nameSameAsReverseName".lower(): "#/components/schemas/GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "noSuchTargetTable".lower(): "#/components/schemas/GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "referentialIntegrityModel".lower(): "#/components/schemas/GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "reverseNameAlreadyExists".lower(): "#/components/schemas/GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "reverseNameAlreadyExistsAsName".lower(): "#/components/schemas/GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "reverseNameNotProvided".lower(): "#/components/schemas/GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", - "smartAttributes".lower(): "#/components/schemas/GsaSmartAttributesRecordLinkGroupErrorDetail", - "swapNameAndReverseNameCircular".lower(): "#/components/schemas/GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason", - ) -> None: - """GsaRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - self._message: str - self._reason: GsaRecordLinkGroupErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaRecordLinkGroupErrorDetail. - - Returns - ------- - str - The message of this GsaRecordLinkGroupErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaRecordLinkGroupErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaRecordLinkGroupErrorReason": - """Gets the reason of this GsaRecordLinkGroupErrorDetail. - - Returns - ------- - GsaRecordLinkGroupErrorReason - The reason of this GsaRecordLinkGroupErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaRecordLinkGroupErrorReason") -> None: - """Sets the reason of this GsaRecordLinkGroupErrorDetail. - - Parameters - ---------- - reason: GsaRecordLinkGroupErrorReason - The reason of this GsaRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_reason.py deleted file mode 100644 index 75c45469..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_error_reason.py +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaRecordLinkGroupErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FORBIDORPHANS = "forbidOrphans" - MANYTOMANYFORBIDORPHANS = "manyToManyForbidOrphans" - NAMEALREADYEXISTSASREVERSE = "nameAlreadyExistsAsReverse" - NAMEDENTITY = "namedEntity" - NAMESAMEASREVERSENAME = "nameSameAsReverseName" - NOSUCHTARGETTABLE = "noSuchTargetTable" - REFERENTIALINTEGRITYMODEL = "referentialIntegrityModel" - REVERSENAMEALREADYEXISTS = "reverseNameAlreadyExists" - REVERSENAMEALREADYEXISTSASNAME = "reverseNameAlreadyExistsAsName" - REVERSENAMENOTPROVIDED = "reverseNameNotProvided" - SMARTATTRIBUTES = "smartAttributes" - SWAPNAMEANDREVERSENAMECIRCULAR = "swapNameAndReverseNameCircular" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_type.py index ea135216..561b98a5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_type.py @@ -43,5 +43,5 @@ class GsaRecordLinkGroupType(Enum): Allowed Enum values """ STATIC = "static" - SMART = "smart" + DYNAMIC = "dynamic" CROSSDATABASE = "crossDatabase" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_update_exception.py deleted file mode 100644 index bf1d7163..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_group_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkGroupUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_link_group_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaRecordLinkGroupErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "record_link_group_guid": "recordLinkGroupGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaRecordLinkGroupErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_link_group_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkGroupUpdateException - a model defined in Swagger - - Parameters - ---------- - record_link_group_guid: str - code: GsaErrorCode, optional - errors: list[GsaRecordLinkGroupErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._record_link_group_guid: str - self._errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.record_link_group_guid = record_link_group_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaRecordLinkGroupUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaRecordLinkGroupUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def record_link_group_guid(self) -> "str": - """Gets the record_link_group_guid of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - str - The record_link_group_guid of this GsaRecordLinkGroupUpdateException. - """ - return self._record_link_group_guid - - @record_link_group_guid.setter - def record_link_group_guid(self, record_link_group_guid: "str") -> None: - """Sets the record_link_group_guid of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - record_link_group_guid: str - The record_link_group_guid of this GsaRecordLinkGroupUpdateException. - """ - # Field is not nullable - if record_link_group_guid is None: - raise ValueError("Invalid value for 'record_link_group_guid', must not be 'None'") - # Field is required - if record_link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group_guid', must not be 'Unset'") - self._record_link_group_guid = record_link_group_guid - - @property - def errors(self) -> "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkGroupUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_groups_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_groups_info.py index 609c782c..d9050ad5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_groups_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_groups_info.py @@ -61,7 +61,7 @@ class GsaRecordLinkGroupsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "record_link_groups": "list[GsaRecordLinkGroup]", + "record_link_groups": "list[GsaSlimRecordLinkGroup]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaRecordLinkGroupsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "recordLinkGroups": "GsaRecordLinkGroup", + "recordLinkGroups": "GsaSlimRecordLinkGroup", } discriminator: Optional[str] = None @@ -77,39 +77,39 @@ class GsaRecordLinkGroupsInfo(ModelBase): def __init__( self, *, - record_link_groups: "list[GsaRecordLinkGroup] | None | Unset_Type" = Unset, + record_link_groups: "list[GsaSlimRecordLinkGroup] | None | Unset_Type" = Unset, ) -> None: """GsaRecordLinkGroupsInfo - a model defined in Swagger Parameters ---------- - record_link_groups: list[GsaRecordLinkGroup] | None, optional + record_link_groups: list[GsaSlimRecordLinkGroup] | None, optional """ - self._record_link_groups: list[GsaRecordLinkGroup] | None | Unset_Type = Unset + self._record_link_groups: list[GsaSlimRecordLinkGroup] | None | Unset_Type = Unset if record_link_groups is not Unset: self.record_link_groups = record_link_groups @property - def record_link_groups(self) -> "list[GsaRecordLinkGroup] | None | Unset_Type": + def record_link_groups(self) -> "list[GsaSlimRecordLinkGroup] | None | Unset_Type": """Gets the record_link_groups of this GsaRecordLinkGroupsInfo. Returns ------- - list[GsaRecordLinkGroup] | None | Unset_Type + list[GsaSlimRecordLinkGroup] | None | Unset_Type The record_link_groups of this GsaRecordLinkGroupsInfo. """ return self._record_link_groups @record_link_groups.setter def record_link_groups( - self, record_link_groups: "list[GsaRecordLinkGroup] | None | Unset_Type" + self, record_link_groups: "list[GsaSlimRecordLinkGroup] | None | Unset_Type" ) -> None: """Sets the record_link_groups of this GsaRecordLinkGroupsInfo. Parameters ---------- - record_link_groups: list[GsaRecordLinkGroup] | None | Unset_Type + record_link_groups: list[GsaSlimRecordLinkGroup] | None | Unset_Type The record_link_groups of this GsaRecordLinkGroupsInfo. """ self._record_link_groups = record_link_groups diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_result.py deleted file mode 100644 index 86f10fe3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_result.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkResult(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - } - - attribute_map: dict[str, str] = { - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroupType": "GsaRecordLinkGroupType", - "linkedRecord": "GsaSlimRecordVersion", - } - - discriminator_value_class_map = { - "static".lower(): "#/components/schemas/GsaStaticRecordLinkResult", - "smart".lower(): "#/components/schemas/GsaSmartRecordLinkResult", - "crossDatabase".lower(): "#/components/schemas/GsaCrossDatabaseRecordLinkResult", - } - - discriminator: Optional[str] = "recordLinkGroupType" - - def __init__( - self, - *, - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType", - ) -> None: - """GsaRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - """ - self._record_link_group_type: GsaRecordLinkGroupType - self._linked_record: GsaSlimRecordVersion - - self.record_link_group_type = record_link_group_type - self.linked_record = linked_record - - @property - def record_link_group_type(self) -> "GsaRecordLinkGroupType": - """Gets the record_link_group_type of this GsaRecordLinkResult. - - Returns - ------- - GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkResult. - """ - return self._record_link_group_type - - @record_link_group_type.setter - def record_link_group_type(self, record_link_group_type: "GsaRecordLinkGroupType") -> None: - """Sets the record_link_group_type of this GsaRecordLinkResult. - - Parameters - ---------- - record_link_group_type: GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkResult. - """ - # Field is not nullable - if record_link_group_type is None: - raise ValueError("Invalid value for 'record_link_group_type', must not be 'None'") - # Field is required - if record_link_group_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group_type', must not be 'Unset'") - self._record_link_group_type = record_link_group_type - - @property - def linked_record(self) -> "GsaSlimRecordVersion": - """Gets the linked_record of this GsaRecordLinkResult. - - Returns - ------- - GsaSlimRecordVersion - The linked_record of this GsaRecordLinkResult. - """ - return self._linked_record - - @linked_record.setter - def linked_record(self, linked_record: "GsaSlimRecordVersion") -> None: - """Sets the linked_record of this GsaRecordLinkResult. - - Parameters - ---------- - linked_record: GsaSlimRecordVersion - The linked_record of this GsaRecordLinkResult. - """ - # Field is not nullable - if linked_record is None: - raise ValueError("Invalid value for 'linked_record', must not be 'None'") - # Field is required - if linked_record is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'linked_record', must not be 'Unset'") - self._linked_record = linked_record - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_results.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_results.py deleted file mode 100644 index 1c8b1ee5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_link_results.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkResults(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_link_group": "GsaSlimRecordLinkGroup", - "results": "list[GsaRecordLinkResult]", - } - - attribute_map: dict[str, str] = { - "record_link_group": "recordLinkGroup", - "results": "results", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroup": "GsaSlimRecordLinkGroup", - "results": "GsaRecordLinkResult", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_link_group: "GsaSlimRecordLinkGroup", - results: "list[GsaRecordLinkResult]", - ) -> None: - """GsaRecordLinkResults - a model defined in Swagger - - Parameters - ---------- - record_link_group: GsaSlimRecordLinkGroup - results: list[GsaRecordLinkResult] - """ - self._record_link_group: GsaSlimRecordLinkGroup - self._results: list[GsaRecordLinkResult] - - self.record_link_group = record_link_group - self.results = results - - @property - def record_link_group(self) -> "GsaSlimRecordLinkGroup": - """Gets the record_link_group of this GsaRecordLinkResults. - - Returns - ------- - GsaSlimRecordLinkGroup - The record_link_group of this GsaRecordLinkResults. - """ - return self._record_link_group - - @record_link_group.setter - def record_link_group(self, record_link_group: "GsaSlimRecordLinkGroup") -> None: - """Sets the record_link_group of this GsaRecordLinkResults. - - Parameters - ---------- - record_link_group: GsaSlimRecordLinkGroup - The record_link_group of this GsaRecordLinkResults. - """ - # Field is not nullable - if record_link_group is None: - raise ValueError("Invalid value for 'record_link_group', must not be 'None'") - # Field is required - if record_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group', must not be 'Unset'") - self._record_link_group = record_link_group - - @property - def results(self) -> "list[GsaRecordLinkResult]": - """Gets the results of this GsaRecordLinkResults. - - Returns - ------- - list[GsaRecordLinkResult] - The results of this GsaRecordLinkResults. - """ - return self._results - - @results.setter - def results(self, results: "list[GsaRecordLinkResult]") -> None: - """Sets the results of this GsaRecordLinkResults. - - Parameters - ---------- - results: list[GsaRecordLinkResult] - The results of this GsaRecordLinkResults. - """ - # Field is not nullable - if results is None: - raise ValueError("Invalid value for 'results', must not be 'None'") - # Field is required - if results is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'results', must not be 'Unset'") - self._results = results - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkResults): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_property.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_property.py index f977d222..ac90d63b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_property.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_property.py @@ -56,7 +56,6 @@ class GsaRecordProperty(Enum): VERSIONSTATE = "versionState" VERSIONNUMBER = "versionNumber" RELEASEDDATE = "releasedDate" - BREADCRUMBS = "breadcrumbs" FULLNAME = "fullName" SHORTNAME = "shortName" RECORDCOLOR = "recordColor" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_reference_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_reference_criterion.py index 4d097e94..e47974df 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_reference_criterion.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_reference_criterion.py @@ -66,8 +66,6 @@ class GsaRecordReferenceCriterion(GsaCriterion): swagger_types: dict[str, str] = { "database_key": "str", "type": "GsaCriterionType", - "any_record_guids": "list[str]", - "any_record_history_guids": "list[str]", "record_guid": "str", "record_history_guid": "str", } @@ -75,8 +73,6 @@ class GsaRecordReferenceCriterion(GsaCriterion): attribute_map: dict[str, str] = { "database_key": "databaseKey", "type": "type", - "any_record_guids": "anyRecordGuids", - "any_record_history_guids": "anyRecordHistoryGuids", "record_guid": "recordGuid", "record_history_guid": "recordHistoryGuid", } @@ -90,8 +86,6 @@ def __init__( *, database_key: "str", type: "GsaCriterionType" = GsaCriterionType.REFERENCE, - any_record_guids: "list[str] | None | Unset_Type" = Unset, - any_record_history_guids: "list[str] | None | Unset_Type" = Unset, record_guid: "str | None | Unset_Type" = Unset, record_history_guid: "str | None | Unset_Type" = Unset, ) -> None: @@ -101,27 +95,19 @@ def __init__( ---------- database_key: str type: GsaCriterionType - any_record_guids: list[str] | None, optional - any_record_history_guids: list[str] | None, optional record_guid: str | None, optional record_history_guid: str | None, optional """ super().__init__(type=type) self._database_key: str - self._record_guid: str | None | Unset_Type = Unset self._record_history_guid: str | None | Unset_Type = Unset - self._any_record_history_guids: list[str] | None | Unset_Type = Unset - self._any_record_guids: list[str] | None | Unset_Type = Unset + self._record_guid: str | None | Unset_Type = Unset self.database_key = database_key - if record_guid is not Unset: - self.record_guid = record_guid if record_history_guid is not Unset: self.record_history_guid = record_history_guid - if any_record_history_guids is not Unset: - self.any_record_history_guids = any_record_history_guids - if any_record_guids is not Unset: - self.any_record_guids = any_record_guids + if record_guid is not Unset: + self.record_guid = record_guid @property def database_key(self) -> "str": @@ -151,28 +137,6 @@ def database_key(self, database_key: "str") -> None: raise ValueError("Invalid value for 'database_key', must not be 'Unset'") self._database_key = database_key - @property - def record_guid(self) -> "str | None | Unset_Type": - """Gets the record_guid of this GsaRecordReferenceCriterion. - - Returns - ------- - str | None | Unset_Type - The record_guid of this GsaRecordReferenceCriterion. - """ - return self._record_guid - - @record_guid.setter - def record_guid(self, record_guid: "str | None | Unset_Type") -> None: - """Sets the record_guid of this GsaRecordReferenceCriterion. - - Parameters - ---------- - record_guid: str | None | Unset_Type - The record_guid of this GsaRecordReferenceCriterion. - """ - self._record_guid = record_guid - @property def record_history_guid(self) -> "str | None | Unset_Type": """Gets the record_history_guid of this GsaRecordReferenceCriterion. @@ -196,50 +160,26 @@ def record_history_guid(self, record_history_guid: "str | None | Unset_Type") -> self._record_history_guid = record_history_guid @property - def any_record_history_guids(self) -> "list[str] | None | Unset_Type": - """Gets the any_record_history_guids of this GsaRecordReferenceCriterion. - - Returns - ------- - list[str] | None | Unset_Type - The any_record_history_guids of this GsaRecordReferenceCriterion. - """ - return self._any_record_history_guids - - @any_record_history_guids.setter - def any_record_history_guids( - self, any_record_history_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the any_record_history_guids of this GsaRecordReferenceCriterion. - - Parameters - ---------- - any_record_history_guids: list[str] | None | Unset_Type - The any_record_history_guids of this GsaRecordReferenceCriterion. - """ - self._any_record_history_guids = any_record_history_guids - - @property - def any_record_guids(self) -> "list[str] | None | Unset_Type": - """Gets the any_record_guids of this GsaRecordReferenceCriterion. + def record_guid(self) -> "str | None | Unset_Type": + """Gets the record_guid of this GsaRecordReferenceCriterion. Returns ------- - list[str] | None | Unset_Type - The any_record_guids of this GsaRecordReferenceCriterion. + str | None | Unset_Type + The record_guid of this GsaRecordReferenceCriterion. """ - return self._any_record_guids + return self._record_guid - @any_record_guids.setter - def any_record_guids(self, any_record_guids: "list[str] | None | Unset_Type") -> None: - """Sets the any_record_guids of this GsaRecordReferenceCriterion. + @record_guid.setter + def record_guid(self, record_guid: "str | None | Unset_Type") -> None: + """Sets the record_guid of this GsaRecordReferenceCriterion. Parameters ---------- - any_record_guids: list[str] | None | Unset_Type - The any_record_guids of this GsaRecordReferenceCriterion. + record_guid: str | None | Unset_Type + The record_guid of this GsaRecordReferenceCriterion. """ - self._any_record_guids = any_record_guids + self._record_guid = record_guid @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_type_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_type_criterion.py deleted file mode 100644 index 5184de9d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_type_criterion.py +++ /dev/null @@ -1,144 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordTypeCriterion(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_types": "list[GsaRecordType]", - } - - attribute_map: dict[str, str] = { - "record_types": "recordTypes", - } - - subtype_mapping: dict[str, str] = { - "recordTypes": "GsaRecordType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_types: "list[GsaRecordType] | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordTypeCriterion - a model defined in Swagger - - Parameters - ---------- - record_types: list[GsaRecordType] | None, optional - """ - self._record_types: list[GsaRecordType] | None | Unset_Type = Unset - - if record_types is not Unset: - self.record_types = record_types - - @property - def record_types(self) -> "list[GsaRecordType] | None | Unset_Type": - """Gets the record_types of this GsaRecordTypeCriterion. - - Returns - ------- - list[GsaRecordType] | None | Unset_Type - The record_types of this GsaRecordTypeCriterion. - """ - return self._record_types - - @record_types.setter - def record_types(self, record_types: "list[GsaRecordType] | None | Unset_Type") -> None: - """Sets the record_types of this GsaRecordTypeCriterion. - - Parameters - ---------- - record_types: list[GsaRecordType] | None | Unset_Type - The record_types of this GsaRecordTypeCriterion. - """ - self._record_types = record_types - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordTypeCriterion): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version.py index 338fe608..67901d48 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version.py @@ -61,6 +61,7 @@ class GsaRecordVersion(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { + "capabilities": "GsaRecordCapabilities", "created_by_user": "str", "created_date": "datetime", "database_key": "str", @@ -73,13 +74,13 @@ class GsaRecordVersion(ModelBase): "record_type": "GsaRecordType", "short_name": "str", "table": "GsaSlimTable", - "user_capabilities": "GsaRecordUserCapabilities", "version_number": "int", "version_state": "GsaVersionState", "released_date": "datetime", } attribute_map: dict[str, str] = { + "capabilities": "capabilities", "created_by_user": "createdByUser", "created_date": "createdDate", "database_key": "databaseKey", @@ -92,7 +93,6 @@ class GsaRecordVersion(ModelBase): "record_type": "recordType", "short_name": "shortName", "table": "table", - "user_capabilities": "userCapabilities", "version_number": "versionNumber", "version_state": "versionState", "released_date": "releasedDate", @@ -103,7 +103,7 @@ class GsaRecordVersion(ModelBase): "table": "GsaSlimTable", "recordType": "GsaRecordType", "recordColor": "GsaRecordColor", - "userCapabilities": "GsaRecordUserCapabilities", + "capabilities": "GsaRecordCapabilities", "versionState": "GsaVersionState", } @@ -112,6 +112,7 @@ class GsaRecordVersion(ModelBase): def __init__( self, *, + capabilities: "GsaRecordCapabilities", created_by_user: "str", created_date: "datetime", database_key: "str", @@ -124,7 +125,6 @@ def __init__( record_type: "GsaRecordType", short_name: "str", table: "GsaSlimTable", - user_capabilities: "GsaRecordUserCapabilities", version_number: "int", version_state: "GsaVersionState", released_date: "datetime | None | Unset_Type" = Unset, @@ -133,6 +133,7 @@ def __init__( Parameters ---------- + capabilities: GsaRecordCapabilities created_by_user: str created_date: datetime database_key: str @@ -145,7 +146,6 @@ def __init__( record_type: GsaRecordType short_name: str table: GsaSlimTable - user_capabilities: GsaRecordUserCapabilities version_number: int version_state: GsaVersionState released_date: datetime | None, optional @@ -161,7 +161,7 @@ def __init__( self._released_date: datetime | None | Unset_Type = Unset self._short_name: str self._record_color: GsaRecordColor - self._user_capabilities: GsaRecordUserCapabilities + self._capabilities: GsaRecordCapabilities self._version_number: int self._version_state: GsaVersionState self._name: str @@ -179,7 +179,7 @@ def __init__( self.released_date = released_date self.short_name = short_name self.record_color = record_color - self.user_capabilities = user_capabilities + self.capabilities = capabilities self.version_number = version_number self.version_state = version_state self.name = name @@ -488,32 +488,32 @@ def record_color(self, record_color: "GsaRecordColor") -> None: self._record_color = record_color @property - def user_capabilities(self) -> "GsaRecordUserCapabilities": - """Gets the user_capabilities of this GsaRecordVersion. + def capabilities(self) -> "GsaRecordCapabilities": + """Gets the capabilities of this GsaRecordVersion. Returns ------- - GsaRecordUserCapabilities - The user_capabilities of this GsaRecordVersion. + GsaRecordCapabilities + The capabilities of this GsaRecordVersion. """ - return self._user_capabilities + return self._capabilities - @user_capabilities.setter - def user_capabilities(self, user_capabilities: "GsaRecordUserCapabilities") -> None: - """Sets the user_capabilities of this GsaRecordVersion. + @capabilities.setter + def capabilities(self, capabilities: "GsaRecordCapabilities") -> None: + """Sets the capabilities of this GsaRecordVersion. Parameters ---------- - user_capabilities: GsaRecordUserCapabilities - The user_capabilities of this GsaRecordVersion. + capabilities: GsaRecordCapabilities + The capabilities of this GsaRecordVersion. """ # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") + if capabilities is None: + raise ValueError("Invalid value for 'capabilities', must not be 'None'") # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities + if capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'capabilities', must not be 'Unset'") + self._capabilities = capabilities @property def version_number(self) -> "int": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version_access_control_entity.py deleted file mode 100644 index 9479337f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_record_version_access_control_entity.py +++ /dev/null @@ -1,227 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity import ( # noqa: F401 - GsaAccessControlEntity, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity_type import ( - GsaAccessControlEntityType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordVersionAccessControlEntity(GsaAccessControlEntity): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlEntityType", - "record_history_guid": "str", - "record_version_guid": "str", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "record_history_guid": "recordHistoryGuid", - "record_version_guid": "recordVersionGuid", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlEntityType" = GsaAccessControlEntityType.RECORDVERSION, - record_history_guid: "str", - record_version_guid: "str", - table_guid: "str", - ) -> None: - """GsaRecordVersionAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - record_history_guid: str - record_version_guid: str - table_guid: str - """ - super().__init__(entity_type=entity_type) - self._table_guid: str - self._record_history_guid: str - self._record_version_guid: str - - self.table_guid = table_guid - self.record_history_guid = record_history_guid - self.record_version_guid = record_version_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaRecordVersionAccessControlEntity. - - Returns - ------- - str - The table_guid of this GsaRecordVersionAccessControlEntity. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaRecordVersionAccessControlEntity. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaRecordVersionAccessControlEntity. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def record_history_guid(self) -> "str": - """Gets the record_history_guid of this GsaRecordVersionAccessControlEntity. - - Returns - ------- - str - The record_history_guid of this GsaRecordVersionAccessControlEntity. - """ - return self._record_history_guid - - @record_history_guid.setter - def record_history_guid(self, record_history_guid: "str") -> None: - """Sets the record_history_guid of this GsaRecordVersionAccessControlEntity. - - Parameters - ---------- - record_history_guid: str - The record_history_guid of this GsaRecordVersionAccessControlEntity. - """ - # Field is not nullable - if record_history_guid is None: - raise ValueError("Invalid value for 'record_history_guid', must not be 'None'") - # Field is required - if record_history_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_history_guid', must not be 'Unset'") - self._record_history_guid = record_history_guid - - @property - def record_version_guid(self) -> "str": - """Gets the record_version_guid of this GsaRecordVersionAccessControlEntity. - - Returns - ------- - str - The record_version_guid of this GsaRecordVersionAccessControlEntity. - """ - return self._record_version_guid - - @record_version_guid.setter - def record_version_guid(self, record_version_guid: "str") -> None: - """Sets the record_version_guid of this GsaRecordVersionAccessControlEntity. - - Parameters - ---------- - record_version_guid: str - The record_version_guid of this GsaRecordVersionAccessControlEntity. - """ - # Field is not nullable - if record_version_guid is None: - raise ValueError("Invalid value for 'record_version_guid', must not be 'None'") - # Field is required - if record_version_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_version_guid', must not be 'Unset'") - self._record_version_guid = record_version_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordVersionAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referenced_by_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referenced_by_type.py index 69962b5c..b254b084 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referenced_by_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referenced_by_type.py @@ -44,7 +44,7 @@ class GsaReferencedByType(Enum): """ EXPRESSION = "expression" VERSIONCONTROLLEDDATA = "versionControlledData" - SMARTLINKGROUP = "smartLinkGroup" + DYNAMICLINKGROUP = "dynamicLinkGroup" TABULARATTRIBUTE = "tabularAttribute" XYCHARTTEMPLATE = "xyChartTemplate" SEARCHMASK = "searchMask" @@ -52,11 +52,3 @@ class GsaReferencedByType(Enum): ATTRIBUTE = "attribute" DATA = "data" DEFAULTPARAMETERVALUE = "defaultParameterValue" - FUNCTIONALDATADEFAULT = "functionalDataDefault" - MULTIVALUEDPOINTDATA = "multiValuedPointData" - TABULARCOLUMN = "tabularColumn" - DATABASECURRENCYUNIT = "databaseCurrencyUnit" - UNIT = "unit" - PARAMETER = "parameter" - CONSTANT = "constant" - TABLE = "table" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referential_integrity_model_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referential_integrity_model_record_link_group_error_detail.py deleted file mode 100644 index 3e5415f1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_referential_integrity_model_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReferentialIntegrityModelRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REFERENTIALINTEGRITYMODEL, - ) -> None: - """GsaReferentialIntegrityModelRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReferentialIntegrityModelRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_register_update_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_register_update_request.py deleted file mode 100644 index 52611675..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_register_update_request.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRegisterUpdateRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "apply_options": "GsaApplyOptions", - "header": "GsaDataUpdateHeader", - } - - attribute_map: dict[str, str] = { - "apply_options": "applyOptions", - "header": "header", - } - - subtype_mapping: dict[str, str] = { - "header": "GsaDataUpdateHeader", - "applyOptions": "GsaApplyOptions", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - apply_options: "GsaApplyOptions", - header: "GsaDataUpdateHeader", - ) -> None: - """GsaRegisterUpdateRequest - a model defined in Swagger - - Parameters - ---------- - apply_options: GsaApplyOptions - header: GsaDataUpdateHeader - """ - self._header: GsaDataUpdateHeader - self._apply_options: GsaApplyOptions - - self.header = header - self.apply_options = apply_options - - @property - def header(self) -> "GsaDataUpdateHeader": - """Gets the header of this GsaRegisterUpdateRequest. - - Returns - ------- - GsaDataUpdateHeader - The header of this GsaRegisterUpdateRequest. - """ - return self._header - - @header.setter - def header(self, header: "GsaDataUpdateHeader") -> None: - """Sets the header of this GsaRegisterUpdateRequest. - - Parameters - ---------- - header: GsaDataUpdateHeader - The header of this GsaRegisterUpdateRequest. - """ - # Field is not nullable - if header is None: - raise ValueError("Invalid value for 'header', must not be 'None'") - # Field is required - if header is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'header', must not be 'Unset'") - self._header = header - - @property - def apply_options(self) -> "GsaApplyOptions": - """Gets the apply_options of this GsaRegisterUpdateRequest. - - Returns - ------- - GsaApplyOptions - The apply_options of this GsaRegisterUpdateRequest. - """ - return self._apply_options - - @apply_options.setter - def apply_options(self, apply_options: "GsaApplyOptions") -> None: - """Sets the apply_options of this GsaRegisterUpdateRequest. - - Parameters - ---------- - apply_options: GsaApplyOptions - The apply_options of this GsaRegisterUpdateRequest. - """ - # Field is not nullable - if apply_options is None: - raise ValueError("Invalid value for 'apply_options', must not be 'None'") - # Field is required - if apply_options is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'apply_options', must not be 'Unset'") - self._apply_options = apply_options - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRegisterUpdateRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_record_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_record_version_control_exception.py index 37311d7f..48816910 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_record_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_record_version_control_exception.py @@ -61,21 +61,19 @@ class GsaReleaseRecordVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", - "record_version_guid": "str", } attribute_map: dict[str, str] = { "code": "code", "errors": "errors", "message": "message", - "record_version_guid": "recordVersionGuid", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -84,31 +82,26 @@ class GsaReleaseRecordVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, ) -> None: """GsaReleaseRecordVersionControlException - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional - record_version_guid: str, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._record_version_guid: str | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - if record_version_guid is not Unset: - self.record_version_guid = record_version_guid if errors is not Unset: self.errors = errors @@ -135,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaReleaseRecordVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseRecordVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaReleaseRecordVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseRecordVersionControlException. """ # Field is not nullable @@ -159,31 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def record_version_guid(self) -> "str | Unset_Type": - """Gets the record_version_guid of this GsaReleaseRecordVersionControlException. - - Returns - ------- - str | Unset_Type - The record_version_guid of this GsaReleaseRecordVersionControlException. - """ - return self._record_version_guid - - @record_version_guid.setter - def record_version_guid(self, record_version_guid: "str | Unset_Type") -> None: - """Sets the record_version_guid of this GsaReleaseRecordVersionControlException. - - Parameters - ---------- - record_version_guid: str | Unset_Type - The record_version_guid of this GsaReleaseRecordVersionControlException. - """ - # Field is not nullable - if record_version_guid is None: - raise ValueError("Invalid value for 'record_version_guid', must not be 'None'") - self._record_version_guid = record_version_guid - @property def errors(self) -> "list[GsaVersionControlErrorDetail] | None | Unset_Type": """Gets the errors of this GsaReleaseRecordVersionControlException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_table_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_table_version_control_exception.py index 3c59f5d6..462fcf1f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_table_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_release_table_version_control_exception.py @@ -61,21 +61,19 @@ class GsaReleaseTableVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", - "table_guid": "str", } attribute_map: dict[str, str] = { "code": "code", "errors": "errors", "message": "message", - "table_guid": "tableGuid", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -84,31 +82,26 @@ class GsaReleaseTableVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, - table_guid: "str | Unset_Type" = Unset, ) -> None: """GsaReleaseTableVersionControlException - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional - table_guid: str, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._table_guid: str | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - if table_guid is not Unset: - self.table_guid = table_guid if errors is not Unset: self.errors = errors @@ -135,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaReleaseTableVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseTableVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaReleaseTableVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseTableVersionControlException. """ # Field is not nullable @@ -159,31 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def table_guid(self) -> "str | Unset_Type": - """Gets the table_guid of this GsaReleaseTableVersionControlException. - - Returns - ------- - str | Unset_Type - The table_guid of this GsaReleaseTableVersionControlException. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | Unset_Type") -> None: - """Sets the table_guid of this GsaReleaseTableVersionControlException. - - Parameters - ---------- - table_guid: str | Unset_Type - The table_guid of this GsaReleaseTableVersionControlException. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - self._table_guid = table_guid - @property def errors(self) -> "list[GsaVersionControlErrorDetail] | None | Unset_Type": """Gets the errors of this GsaReleaseTableVersionControlException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_detail.py deleted file mode 100644 index 4c3438db..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReorderTablesErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaReorderTablesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaReorderTablesErrorReason", - } - - discriminator_value_class_map = { - "tablesMissing".lower(): "#/components/schemas/GsaTablesMissingReorderTablesErrorDetail", - "noSuchTables".lower(): "#/components/schemas/GsaNoSuchTablesReorderTablesErrorDetail", - "duplicateTables".lower(): "#/components/schemas/GsaDuplicateTablesReorderTablesErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaReorderTablesErrorReason", - ) -> None: - """GsaReorderTablesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaReorderTablesErrorReason - """ - self._message: str - self._reason: GsaReorderTablesErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaReorderTablesErrorDetail. - - Returns - ------- - str - The message of this GsaReorderTablesErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaReorderTablesErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaReorderTablesErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaReorderTablesErrorReason": - """Gets the reason of this GsaReorderTablesErrorDetail. - - Returns - ------- - GsaReorderTablesErrorReason - The reason of this GsaReorderTablesErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaReorderTablesErrorReason") -> None: - """Sets the reason of this GsaReorderTablesErrorDetail. - - Parameters - ---------- - reason: GsaReorderTablesErrorReason - The reason of this GsaReorderTablesErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReorderTablesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_reason.py deleted file mode 100644 index b4b0c109..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaReorderTablesErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - TABLESMISSING = "tablesMissing" - NOSUCHTABLES = "noSuchTables" - DUPLICATETABLES = "duplicateTables" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_exception.py deleted file mode 100644 index 0869b72b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReorderTablesException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "database_key": "str", - "errors": "list[GsaReorderTablesErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "database_key": "databaseKey", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaReorderTablesErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - database_key: "str | None | Unset_Type" = Unset, - errors: "list[GsaReorderTablesErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaReorderTablesException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - database_key: str | None, optional - errors: list[GsaReorderTablesErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._database_key: str | None | Unset_Type = Unset - self._errors: list[GsaReorderTablesErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if database_key is not Unset: - self.database_key = database_key - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaReorderTablesException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaReorderTablesException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaReorderTablesException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaReorderTablesException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaReorderTablesException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaReorderTablesException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaReorderTablesException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaReorderTablesException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaReorderTablesException. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaReorderTablesException. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaReorderTablesException. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaReorderTablesException. - """ - self._database_key = database_key - - @property - def errors(self) -> "list[GsaReorderTablesErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaReorderTablesException. - - Returns - ------- - list[GsaReorderTablesErrorDetail] | None | Unset_Type - The errors of this GsaReorderTablesException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaReorderTablesErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaReorderTablesException. - - Parameters - ---------- - errors: list[GsaReorderTablesErrorDetail] | None | Unset_Type - The errors of this GsaReorderTablesException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReorderTablesException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_request.py deleted file mode 100644 index 0a8f97b4..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reorder_tables_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReorderTablesRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "tables": "list[GsaSlimEntity]", - } - - attribute_map: dict[str, str] = { - "tables": "tables", - } - - subtype_mapping: dict[str, str] = { - "tables": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - tables: "list[GsaSlimEntity]", - ) -> None: - """GsaReorderTablesRequest - a model defined in Swagger - - Parameters - ---------- - tables: list[GsaSlimEntity] - """ - self._tables: list[GsaSlimEntity] - - self.tables = tables - - @property - def tables(self) -> "list[GsaSlimEntity]": - """Gets the tables of this GsaReorderTablesRequest. - - Returns - ------- - list[GsaSlimEntity] - The tables of this GsaReorderTablesRequest. - """ - return self._tables - - @tables.setter - def tables(self, tables: "list[GsaSlimEntity]") -> None: - """Sets the tables of this GsaReorderTablesRequest. - - Parameters - ---------- - tables: list[GsaSlimEntity] - The tables of this GsaReorderTablesRequest. - """ - # Field is not nullable - if tables is None: - raise ValueError("Invalid value for 'tables', must not be 'None'") - # Field is required - if tables is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'tables', must not be 'Unset'") - self._tables = tables - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReorderTablesRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_discrete_values_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_discrete_values_exception.py deleted file mode 100644 index bbe99054..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_discrete_values_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReplaceDiscreteValuesException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaDiscreteValueErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "discrete_type_guid": "discreteTypeGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDiscreteValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDiscreteValueErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaReplaceDiscreteValuesException - a model defined in Swagger - - Parameters - ---------- - discrete_type_guid: str - code: GsaErrorCode, optional - errors: list[GsaDiscreteValueErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._discrete_type_guid: str - self._errors: list[GsaDiscreteValueErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.discrete_type_guid = discrete_type_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaReplaceDiscreteValuesException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaReplaceDiscreteValuesException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaReplaceDiscreteValuesException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaReplaceDiscreteValuesException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaReplaceDiscreteValuesException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaReplaceDiscreteValuesException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaReplaceDiscreteValuesException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaReplaceDiscreteValuesException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def discrete_type_guid(self) -> "str": - """Gets the discrete_type_guid of this GsaReplaceDiscreteValuesException. - - Returns - ------- - str - The discrete_type_guid of this GsaReplaceDiscreteValuesException. - """ - return self._discrete_type_guid - - @discrete_type_guid.setter - def discrete_type_guid(self, discrete_type_guid: "str") -> None: - """Sets the discrete_type_guid of this GsaReplaceDiscreteValuesException. - - Parameters - ---------- - discrete_type_guid: str - The discrete_type_guid of this GsaReplaceDiscreteValuesException. - """ - # Field is not nullable - if discrete_type_guid is None: - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'None'") - # Field is required - if discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'Unset'") - self._discrete_type_guid = discrete_type_guid - - @property - def errors(self) -> "list[GsaDiscreteValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaReplaceDiscreteValuesException. - - Returns - ------- - list[GsaDiscreteValueErrorDetail] | None | Unset_Type - The errors of this GsaReplaceDiscreteValuesException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDiscreteValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaReplaceDiscreteValuesException. - - Parameters - ---------- - errors: list[GsaDiscreteValueErrorDetail] | None | Unset_Type - The errors of this GsaReplaceDiscreteValuesException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReplaceDiscreteValuesException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_categories_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_categories_request.py deleted file mode 100644 index 99b14c77..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_categories_request.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReplacePermissionCategoriesRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "categories": "list[GsaPutPermissionCategory]", - } - - attribute_map: dict[str, str] = { - "categories": "categories", - } - - subtype_mapping: dict[str, str] = { - "categories": "GsaPutPermissionCategory", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - categories: "list[GsaPutPermissionCategory]", - ) -> None: - """GsaReplacePermissionCategoriesRequest - a model defined in Swagger - - Parameters - ---------- - categories: list[GsaPutPermissionCategory] - """ - self._categories: list[GsaPutPermissionCategory] - - self.categories = categories - - @property - def categories(self) -> "list[GsaPutPermissionCategory]": - """Gets the categories of this GsaReplacePermissionCategoriesRequest. - This can result in adding, modifying and deleting permission categories. To insert a new category, use a [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory). To modify an existing category, use a [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory). Existing categories will be matched by GUID. If an existing category is not included, it will be deleted. - - Returns - ------- - list[GsaPutPermissionCategory] - The categories of this GsaReplacePermissionCategoriesRequest. - """ - return self._categories - - @categories.setter - def categories(self, categories: "list[GsaPutPermissionCategory]") -> None: - """Sets the categories of this GsaReplacePermissionCategoriesRequest. - This can result in adding, modifying and deleting permission categories. To insert a new category, use a [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory). To modify an existing category, use a [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory). Existing categories will be matched by GUID. If an existing category is not included, it will be deleted. - - Parameters - ---------- - categories: list[GsaPutPermissionCategory] - The categories of this GsaReplacePermissionCategoriesRequest. - """ - # Field is not nullable - if categories is None: - raise ValueError("Invalid value for 'categories', must not be 'None'") - # Field is required - if categories is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'categories', must not be 'Unset'") - self._categories = categories - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReplacePermissionCategoriesRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_detail.py deleted file mode 100644 index 512dec12..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReplacePermissionCategoryErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - discriminator_value_class_map = { - "duplicateCategories".lower(): "#/components/schemas/GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "category".lower(): "#/components/schemas/GsaCategoryReplacePermissionCategoryErrorDetail", - "noSuchCategories".lower(): "#/components/schemas/GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "tooManyPermissions".lower(): "#/components/schemas/GsaTooManyPermissionsReplacePermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason", - ) -> None: - """GsaReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaReplacePermissionCategoryErrorReason - """ - self._message: str - self._reason: GsaReplacePermissionCategoryErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaReplacePermissionCategoryErrorDetail. - - Returns - ------- - str - The message of this GsaReplacePermissionCategoryErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaReplacePermissionCategoryErrorReason": - """Gets the reason of this GsaReplacePermissionCategoryErrorDetail. - - Returns - ------- - GsaReplacePermissionCategoryErrorReason - The reason of this GsaReplacePermissionCategoryErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaReplacePermissionCategoryErrorReason") -> None: - """Sets the reason of this GsaReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - reason: GsaReplacePermissionCategoryErrorReason - The reason of this GsaReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_reason.py deleted file mode 100644 index 5949d3bd..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_replace_permission_category_error_reason.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaReplacePermissionCategoryErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - DUPLICATECATEGORIES = "duplicateCategories" - CATEGORY = "category" - NOSUCHCATEGORIES = "noSuchCategories" - TOOMANYPERMISSIONS = "tooManyPermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_info.py deleted file mode 100644 index 6012ba65..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaResolveLinkTargetsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "resolved_link_targets": "list[GsaResolvedLinkTarget]", - } - - attribute_map: dict[str, str] = { - "resolved_link_targets": "resolvedLinkTargets", - } - - subtype_mapping: dict[str, str] = { - "resolvedLinkTargets": "GsaResolvedLinkTarget", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - resolved_link_targets: "list[GsaResolvedLinkTarget]", - ) -> None: - """GsaResolveLinkTargetsInfo - a model defined in Swagger - - Parameters - ---------- - resolved_link_targets: list[GsaResolvedLinkTarget] - """ - self._resolved_link_targets: list[GsaResolvedLinkTarget] - - self.resolved_link_targets = resolved_link_targets - - @property - def resolved_link_targets(self) -> "list[GsaResolvedLinkTarget]": - """Gets the resolved_link_targets of this GsaResolveLinkTargetsInfo. - - Returns - ------- - list[GsaResolvedLinkTarget] - The resolved_link_targets of this GsaResolveLinkTargetsInfo. - """ - return self._resolved_link_targets - - @resolved_link_targets.setter - def resolved_link_targets(self, resolved_link_targets: "list[GsaResolvedLinkTarget]") -> None: - """Sets the resolved_link_targets of this GsaResolveLinkTargetsInfo. - - Parameters - ---------- - resolved_link_targets: list[GsaResolvedLinkTarget] - The resolved_link_targets of this GsaResolveLinkTargetsInfo. - """ - # Field is not nullable - if resolved_link_targets is None: - raise ValueError("Invalid value for 'resolved_link_targets', must not be 'None'") - # Field is required - if resolved_link_targets is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'resolved_link_targets', must not be 'Unset'") - self._resolved_link_targets = resolved_link_targets - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaResolveLinkTargetsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_request.py deleted file mode 100644 index 94f214be..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolve_link_targets_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaResolveLinkTargetsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "link_targets": "list[GsaLinkTarget]", - } - - attribute_map: dict[str, str] = { - "link_targets": "linkTargets", - } - - subtype_mapping: dict[str, str] = { - "linkTargets": "GsaLinkTarget", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - link_targets: "list[GsaLinkTarget]", - ) -> None: - """GsaResolveLinkTargetsRequest - a model defined in Swagger - - Parameters - ---------- - link_targets: list[GsaLinkTarget] - """ - self._link_targets: list[GsaLinkTarget] - - self.link_targets = link_targets - - @property - def link_targets(self) -> "list[GsaLinkTarget]": - """Gets the link_targets of this GsaResolveLinkTargetsRequest. - - Returns - ------- - list[GsaLinkTarget] - The link_targets of this GsaResolveLinkTargetsRequest. - """ - return self._link_targets - - @link_targets.setter - def link_targets(self, link_targets: "list[GsaLinkTarget]") -> None: - """Sets the link_targets of this GsaResolveLinkTargetsRequest. - - Parameters - ---------- - link_targets: list[GsaLinkTarget] - The link_targets of this GsaResolveLinkTargetsRequest. - """ - # Field is not nullable - if link_targets is None: - raise ValueError("Invalid value for 'link_targets', must not be 'None'") - # Field is required - if link_targets is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_targets', must not be 'Unset'") - self._link_targets = link_targets - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaResolveLinkTargetsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_breadcrumb.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_breadcrumb.py deleted file mode 100644 index 11dd18f7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_breadcrumb.py +++ /dev/null @@ -1,225 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_breadcrumb import ( # noqa: F401 - GsaBreadcrumb, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_breadcrumb_type import GsaBreadcrumbType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaResolvedBreadcrumb(GsaBreadcrumb): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "breadcrumb_type": "GsaBreadcrumbType", - "name": "str", - "record_guid": "str", - "record_history_guid": "str", - } - - attribute_map: dict[str, str] = { - "breadcrumb_type": "breadcrumbType", - "name": "name", - "record_guid": "recordGuid", - "record_history_guid": "recordHistoryGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - breadcrumb_type: "GsaBreadcrumbType" = GsaBreadcrumbType.RESOLVED, - name: "str", - record_guid: "str", - record_history_guid: "str", - ) -> None: - """GsaResolvedBreadcrumb - a model defined in Swagger - - Parameters - ---------- - breadcrumb_type: GsaBreadcrumbType - name: str - record_guid: str - record_history_guid: str - """ - super().__init__(breadcrumb_type=breadcrumb_type) - self._name: str - self._record_history_guid: str - self._record_guid: str - - self.name = name - self.record_history_guid = record_history_guid - self.record_guid = record_guid - - @property - def name(self) -> "str": - """Gets the name of this GsaResolvedBreadcrumb. - - Returns - ------- - str - The name of this GsaResolvedBreadcrumb. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaResolvedBreadcrumb. - - Parameters - ---------- - name: str - The name of this GsaResolvedBreadcrumb. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def record_history_guid(self) -> "str": - """Gets the record_history_guid of this GsaResolvedBreadcrumb. - - Returns - ------- - str - The record_history_guid of this GsaResolvedBreadcrumb. - """ - return self._record_history_guid - - @record_history_guid.setter - def record_history_guid(self, record_history_guid: "str") -> None: - """Sets the record_history_guid of this GsaResolvedBreadcrumb. - - Parameters - ---------- - record_history_guid: str - The record_history_guid of this GsaResolvedBreadcrumb. - """ - # Field is not nullable - if record_history_guid is None: - raise ValueError("Invalid value for 'record_history_guid', must not be 'None'") - # Field is required - if record_history_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_history_guid', must not be 'Unset'") - self._record_history_guid = record_history_guid - - @property - def record_guid(self) -> "str": - """Gets the record_guid of this GsaResolvedBreadcrumb. - - Returns - ------- - str - The record_guid of this GsaResolvedBreadcrumb. - """ - return self._record_guid - - @record_guid.setter - def record_guid(self, record_guid: "str") -> None: - """Sets the record_guid of this GsaResolvedBreadcrumb. - - Parameters - ---------- - record_guid: str - The record_guid of this GsaResolvedBreadcrumb. - """ - # Field is not nullable - if record_guid is None: - raise ValueError("Invalid value for 'record_guid', must not be 'None'") - # Field is required - if record_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_guid', must not be 'Unset'") - self._record_guid = record_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaResolvedBreadcrumb): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link.py similarity index 73% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link.py index 9fa9fe63..1630bdea 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_link.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link.py @@ -42,7 +42,7 @@ from . import * -class GsaLink(ModelBase): +class GsaResolvedLink(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -57,18 +57,17 @@ class GsaLink(ModelBase): The key is attribute name and the value is json key in definition. subtype_mapping: dict[str, str] The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. discriminator: Optional[str] Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { "display_names": "dict(str, str)", "guid": "str", - "link_info": "GsaLinkInfo", + "link_info": "GsaResolvedLinkInfo", "name": "str", "reverse_name": "str", "type": "GsaLinkAttributeType", + "identity": "int", "reverse_display_names": "dict(str, str)", } @@ -79,54 +78,53 @@ class GsaLink(ModelBase): "name": "name", "reverse_name": "reverseName", "type": "type", + "identity": "identity", "reverse_display_names": "reverseDisplayNames", } subtype_mapping: dict[str, str] = { "type": "GsaLinkAttributeType", - "linkInfo": "GsaLinkInfo", + "linkInfo": "GsaResolvedLinkInfo", } - discriminator_value_class_map = { - "recordLink".lower(): "#/components/schemas/GsaRecordLink", - "smartLink".lower(): "#/components/schemas/GsaSmartLink", - "crossDatabaseLink".lower(): "#/components/schemas/GsaCrossDatabaseLink", - "tabularAttribute".lower(): "#/components/schemas/GsaTabularAttributeLink", - } - - discriminator: Optional[str] = "type" + discriminator: Optional[str] = None def __init__( self, *, display_names: "dict[str, str]", guid: "str", - link_info: "GsaLinkInfo", + link_info: "GsaResolvedLinkInfo", name: "str", reverse_name: "str", type: "GsaLinkAttributeType", + identity: "int | None | Unset_Type" = Unset, reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, ) -> None: - """GsaLink - a model defined in Swagger + """GsaResolvedLink - a model defined in Swagger Parameters ---------- display_names: dict[str, str] guid: str - link_info: GsaLinkInfo + link_info: GsaResolvedLinkInfo name: str reverse_name: str type: GsaLinkAttributeType + identity: int | None, optional reverse_display_names: dict[str, str] | None, optional """ + self._identity: int | None | Unset_Type = Unset self._type: GsaLinkAttributeType self._reverse_name: str self._reverse_display_names: dict[str, str] | None | Unset_Type = Unset - self._link_info: GsaLinkInfo + self._link_info: GsaResolvedLinkInfo self._display_names: dict[str, str] self._name: str self._guid: str + if identity is not Unset: + self.identity = identity self.type = type self.reverse_name = reverse_name if reverse_display_names is not Unset: @@ -136,25 +134,47 @@ def __init__( self.name = name self.guid = guid + @property + def identity(self) -> "int | None | Unset_Type": + """Gets the identity of this GsaResolvedLink. + + Returns + ------- + int | None | Unset_Type + The identity of this GsaResolvedLink. + """ + return self._identity + + @identity.setter + def identity(self, identity: "int | None | Unset_Type") -> None: + """Sets the identity of this GsaResolvedLink. + + Parameters + ---------- + identity: int | None | Unset_Type + The identity of this GsaResolvedLink. + """ + self._identity = identity + @property def type(self) -> "GsaLinkAttributeType": - """Gets the type of this GsaLink. + """Gets the type of this GsaResolvedLink. Returns ------- GsaLinkAttributeType - The type of this GsaLink. + The type of this GsaResolvedLink. """ return self._type @type.setter def type(self, type: "GsaLinkAttributeType") -> None: - """Sets the type of this GsaLink. + """Sets the type of this GsaResolvedLink. Parameters ---------- type: GsaLinkAttributeType - The type of this GsaLink. + The type of this GsaResolvedLink. """ # Field is not nullable if type is None: @@ -166,23 +186,23 @@ def type(self, type: "GsaLinkAttributeType") -> None: @property def reverse_name(self) -> "str": - """Gets the reverse_name of this GsaLink. + """Gets the reverse_name of this GsaResolvedLink. Returns ------- str - The reverse_name of this GsaLink. + The reverse_name of this GsaResolvedLink. """ return self._reverse_name @reverse_name.setter def reverse_name(self, reverse_name: "str") -> None: - """Sets the reverse_name of this GsaLink. + """Sets the reverse_name of this GsaResolvedLink. Parameters ---------- reverse_name: str - The reverse_name of this GsaLink. + The reverse_name of this GsaResolvedLink. """ # Field is not nullable if reverse_name is None: @@ -194,12 +214,12 @@ def reverse_name(self, reverse_name: "str") -> None: @property def reverse_display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the reverse_display_names of this GsaLink. + """Gets the reverse_display_names of this GsaResolvedLink. Returns ------- dict[str, str] | None | Unset_Type - The reverse_display_names of this GsaLink. + The reverse_display_names of this GsaResolvedLink. """ return self._reverse_display_names @@ -207,34 +227,34 @@ def reverse_display_names(self) -> "dict[str, str] | None | Unset_Type": def reverse_display_names( self, reverse_display_names: "dict[str, str] | None | Unset_Type" ) -> None: - """Sets the reverse_display_names of this GsaLink. + """Sets the reverse_display_names of this GsaResolvedLink. Parameters ---------- reverse_display_names: dict[str, str] | None | Unset_Type - The reverse_display_names of this GsaLink. + The reverse_display_names of this GsaResolvedLink. """ self._reverse_display_names = reverse_display_names @property - def link_info(self) -> "GsaLinkInfo": - """Gets the link_info of this GsaLink. + def link_info(self) -> "GsaResolvedLinkInfo": + """Gets the link_info of this GsaResolvedLink. Returns ------- - GsaLinkInfo - The link_info of this GsaLink. + GsaResolvedLinkInfo + The link_info of this GsaResolvedLink. """ return self._link_info @link_info.setter - def link_info(self, link_info: "GsaLinkInfo") -> None: - """Sets the link_info of this GsaLink. + def link_info(self, link_info: "GsaResolvedLinkInfo") -> None: + """Sets the link_info of this GsaResolvedLink. Parameters ---------- - link_info: GsaLinkInfo - The link_info of this GsaLink. + link_info: GsaResolvedLinkInfo + The link_info of this GsaResolvedLink. """ # Field is not nullable if link_info is None: @@ -246,25 +266,23 @@ def link_info(self, link_info: "GsaLinkInfo") -> None: @property def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaLink. - A dictionary of the culture name to the name that should be used in that culture for the item + """Gets the display_names of this GsaResolvedLink. Returns ------- dict[str, str] - The display_names of this GsaLink. + The display_names of this GsaResolvedLink. """ return self._display_names @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaLink. - A dictionary of the culture name to the name that should be used in that culture for the item + """Sets the display_names of this GsaResolvedLink. Parameters ---------- display_names: dict[str, str] - The display_names of this GsaLink. + The display_names of this GsaResolvedLink. """ # Field is not nullable if display_names is None: @@ -276,23 +294,23 @@ def display_names(self, display_names: "dict[str, str]") -> None: @property def name(self) -> "str": - """Gets the name of this GsaLink. + """Gets the name of this GsaResolvedLink. Returns ------- str - The name of this GsaLink. + The name of this GsaResolvedLink. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaLink. + """Sets the name of this GsaResolvedLink. Parameters ---------- name: str - The name of this GsaLink. + The name of this GsaResolvedLink. """ # Field is not nullable if name is None: @@ -304,23 +322,23 @@ def name(self, name: "str") -> None: @property def guid(self) -> "str": - """Gets the guid of this GsaLink. + """Gets the guid of this GsaResolvedLink. Returns ------- str - The guid of this GsaLink. + The guid of this GsaResolvedLink. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaLink. + """Sets the guid of this GsaResolvedLink. Parameters ---------- guid: str - The guid of this GsaLink. + The guid of this GsaResolvedLink. """ # Field is not nullable if guid is None: @@ -332,24 +350,19 @@ def guid(self, guid: "str") -> None: @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator + """Raises a NotImplementedError for a type without a discriminator defined. Parameters ---------- data: ModelBase Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) + Raises + ------ + NotImplementedError + This class has no discriminator, and hence no subclasses + """ + raise NotImplementedError() def __repr__(self) -> str: """For 'print' and 'pprint'""" @@ -357,7 +370,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaLink): + if not isinstance(other, GsaResolvedLink): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail_of_upgrade_database_failure_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link_info.py similarity index 60% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail_of_upgrade_database_failure_reason.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link_info.py index 3cd270da..aeb63909 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_detail_of_upgrade_database_failure_reason.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link_info.py @@ -42,7 +42,7 @@ from . import * -class GsaErrorDetailOfUpgradeDatabaseFailureReason(ModelBase): +class GsaResolvedLinkInfo(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,17 +61,18 @@ class GsaErrorDetailOfUpgradeDatabaseFailureReason(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUpgradeDatabaseFailureReason", + "link_source": "GsaResolvedLinkTarget", + "link_target": "GsaResolvedLinkTarget", } attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", + "link_source": "linkSource", + "link_target": "linkTarget", } subtype_mapping: dict[str, str] = { - "reason": "GsaUpgradeDatabaseFailureReason", + "linkSource": "GsaResolvedLinkTarget", + "linkTarget": "GsaResolvedLinkTarget", } discriminator: Optional[str] = None @@ -79,77 +80,77 @@ class GsaErrorDetailOfUpgradeDatabaseFailureReason(ModelBase): def __init__( self, *, - message: "str", - reason: "GsaUpgradeDatabaseFailureReason", + link_source: "GsaResolvedLinkTarget", + link_target: "GsaResolvedLinkTarget", ) -> None: - """GsaErrorDetailOfUpgradeDatabaseFailureReason - a model defined in Swagger + """GsaResolvedLinkInfo - a model defined in Swagger Parameters ---------- - message: str - reason: GsaUpgradeDatabaseFailureReason + link_source: GsaResolvedLinkTarget + link_target: GsaResolvedLinkTarget """ - self._message: str - self._reason: GsaUpgradeDatabaseFailureReason + self._link_source: GsaResolvedLinkTarget + self._link_target: GsaResolvedLinkTarget - self.message = message - self.reason = reason + self.link_source = link_source + self.link_target = link_target @property - def message(self) -> "str": - """Gets the message of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + def link_source(self) -> "GsaResolvedLinkTarget": + """Gets the link_source of this GsaResolvedLinkInfo. Returns ------- - str - The message of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + GsaResolvedLinkTarget + The link_source of this GsaResolvedLinkInfo. """ - return self._message + return self._link_source - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + @link_source.setter + def link_source(self, link_source: "GsaResolvedLinkTarget") -> None: + """Sets the link_source of this GsaResolvedLinkInfo. Parameters ---------- - message: str - The message of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + link_source: GsaResolvedLinkTarget + The link_source of this GsaResolvedLinkInfo. """ # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") + if link_source is None: + raise ValueError("Invalid value for 'link_source', must not be 'None'") # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message + if link_source is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'link_source', must not be 'Unset'") + self._link_source = link_source @property - def reason(self) -> "GsaUpgradeDatabaseFailureReason": - """Gets the reason of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + def link_target(self) -> "GsaResolvedLinkTarget": + """Gets the link_target of this GsaResolvedLinkInfo. Returns ------- - GsaUpgradeDatabaseFailureReason - The reason of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + GsaResolvedLinkTarget + The link_target of this GsaResolvedLinkInfo. """ - return self._reason + return self._link_target - @reason.setter - def reason(self, reason: "GsaUpgradeDatabaseFailureReason") -> None: - """Sets the reason of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + @link_target.setter + def link_target(self, link_target: "GsaResolvedLinkTarget") -> None: + """Sets the link_target of this GsaResolvedLinkInfo. Parameters ---------- - reason: GsaUpgradeDatabaseFailureReason - The reason of this GsaErrorDetailOfUpgradeDatabaseFailureReason. + link_target: GsaResolvedLinkTarget + The link_target of this GsaResolvedLinkInfo. """ # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") + if link_target is None: + raise ValueError("Invalid value for 'link_target', must not be 'None'") # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason + if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'link_target', must not be 'Unset'") + self._link_target = link_target @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -173,7 +174,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaErrorDetailOfUpgradeDatabaseFailureReason): + if not isinstance(other, GsaResolvedLinkInfo): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link_target.py index b99d0f8d..2466f187 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link_target.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_link_target.py @@ -61,96 +61,127 @@ class GsaResolvedLinkTarget(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "link_target": "GsaLinkTarget", - "tables": "list[GsaSlimTable]", + "database_guid": "str", + "database_version_guid": "str", + "table_guid": "str", } attribute_map: dict[str, str] = { - "link_target": "linkTarget", - "tables": "tables", + "database_guid": "databaseGuid", + "database_version_guid": "databaseVersionGuid", + "table_guid": "tableGuid", } - subtype_mapping: dict[str, str] = { - "linkTarget": "GsaLinkTarget", - "tables": "GsaSlimTable", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - link_target: "GsaLinkTarget", - tables: "list[GsaSlimTable]", + database_guid: "str", + database_version_guid: "str", + table_guid: "str", ) -> None: """GsaResolvedLinkTarget - a model defined in Swagger Parameters ---------- - link_target: GsaLinkTarget - tables: list[GsaSlimTable] + database_guid: str + database_version_guid: str + table_guid: str + """ + self._database_guid: str + self._database_version_guid: str + self._table_guid: str + + self.database_guid = database_guid + self.database_version_guid = database_version_guid + self.table_guid = table_guid + + @property + def database_guid(self) -> "str": + """Gets the database_guid of this GsaResolvedLinkTarget. + + Returns + ------- + str + The database_guid of this GsaResolvedLinkTarget. """ - self._link_target: GsaLinkTarget - self._tables: list[GsaSlimTable] + return self._database_guid + + @database_guid.setter + def database_guid(self, database_guid: "str") -> None: + """Sets the database_guid of this GsaResolvedLinkTarget. - self.link_target = link_target - self.tables = tables + Parameters + ---------- + database_guid: str + The database_guid of this GsaResolvedLinkTarget. + """ + # Field is not nullable + if database_guid is None: + raise ValueError("Invalid value for 'database_guid', must not be 'None'") + # Field is required + if database_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'database_guid', must not be 'Unset'") + self._database_guid = database_guid @property - def link_target(self) -> "GsaLinkTarget": - """Gets the link_target of this GsaResolvedLinkTarget. + def database_version_guid(self) -> "str": + """Gets the database_version_guid of this GsaResolvedLinkTarget. Returns ------- - GsaLinkTarget - The link_target of this GsaResolvedLinkTarget. + str + The database_version_guid of this GsaResolvedLinkTarget. """ - return self._link_target + return self._database_version_guid - @link_target.setter - def link_target(self, link_target: "GsaLinkTarget") -> None: - """Sets the link_target of this GsaResolvedLinkTarget. + @database_version_guid.setter + def database_version_guid(self, database_version_guid: "str") -> None: + """Sets the database_version_guid of this GsaResolvedLinkTarget. Parameters ---------- - link_target: GsaLinkTarget - The link_target of this GsaResolvedLinkTarget. + database_version_guid: str + The database_version_guid of this GsaResolvedLinkTarget. """ # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") + if database_version_guid is None: + raise ValueError("Invalid value for 'database_version_guid', must not be 'None'") # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target + if database_version_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'database_version_guid', must not be 'Unset'") + self._database_version_guid = database_version_guid @property - def tables(self) -> "list[GsaSlimTable]": - """Gets the tables of this GsaResolvedLinkTarget. + def table_guid(self) -> "str": + """Gets the table_guid of this GsaResolvedLinkTarget. Returns ------- - list[GsaSlimTable] - The tables of this GsaResolvedLinkTarget. + str + The table_guid of this GsaResolvedLinkTarget. """ - return self._tables + return self._table_guid - @tables.setter - def tables(self, tables: "list[GsaSlimTable]") -> None: - """Sets the tables of this GsaResolvedLinkTarget. + @table_guid.setter + def table_guid(self, table_guid: "str") -> None: + """Sets the table_guid of this GsaResolvedLinkTarget. Parameters ---------- - tables: list[GsaSlimTable] - The tables of this GsaResolvedLinkTarget. + table_guid: str + The table_guid of this GsaResolvedLinkTarget. """ # Field is not nullable - if tables is None: - raise ValueError("Invalid value for 'tables', must not be 'None'") + if table_guid is None: + raise ValueError("Invalid value for 'table_guid', must not be 'None'") # Field is required - if tables is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'tables', must not be 'Unset'") - self._tables = tables + if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") + self._table_guid = table_guid @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_target_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_target_attribute.py deleted file mode 100644 index ec6911b3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_resolved_target_attribute.py +++ /dev/null @@ -1,266 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_target_attribute import ( # noqa: F401 - GsaTargetAttribute, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_target_attribute_type import ( - GsaTargetAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaResolvedTargetAttribute(GsaTargetAttribute): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_type": "GsaAttributeType", - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "target_type": "GsaTargetAttributeType", - "about_attribute": "GsaSlimTypedAttribute", - } - - attribute_map: dict[str, str] = { - "attribute_type": "attributeType", - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "target_type": "targetType", - "about_attribute": "aboutAttribute", - } - - subtype_mapping: dict[str, str] = { - "attributeType": "GsaAttributeType", - "aboutAttribute": "GsaSlimTypedAttribute", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_type: "GsaAttributeType", - display_names: "dict[str, str]", - guid: "str", - name: "str", - target_type: "GsaTargetAttributeType" = GsaTargetAttributeType.RESOLVED, - about_attribute: "GsaSlimTypedAttribute | Unset_Type" = Unset, - ) -> None: - """GsaResolvedTargetAttribute - a model defined in Swagger - - Parameters - ---------- - attribute_type: GsaAttributeType - display_names: dict[str, str] - guid: str - name: str - target_type: GsaTargetAttributeType - about_attribute: GsaSlimTypedAttribute, optional - """ - super().__init__(guid=guid, target_type=target_type) - self._name: str - self._display_names: dict[str, str] - self._attribute_type: GsaAttributeType - self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset - - self.name = name - self.display_names = display_names - self.attribute_type = attribute_type - if about_attribute is not Unset: - self.about_attribute = about_attribute - - @property - def name(self) -> "str": - """Gets the name of this GsaResolvedTargetAttribute. - - Returns - ------- - str - The name of this GsaResolvedTargetAttribute. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaResolvedTargetAttribute. - - Parameters - ---------- - name: str - The name of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaResolvedTargetAttribute. - - Returns - ------- - dict[str, str] - The display_names of this GsaResolvedTargetAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaResolvedTargetAttribute. - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def attribute_type(self) -> "GsaAttributeType": - """Gets the attribute_type of this GsaResolvedTargetAttribute. - - Returns - ------- - GsaAttributeType - The attribute_type of this GsaResolvedTargetAttribute. - """ - return self._attribute_type - - @attribute_type.setter - def attribute_type(self, attribute_type: "GsaAttributeType") -> None: - """Sets the attribute_type of this GsaResolvedTargetAttribute. - - Parameters - ---------- - attribute_type: GsaAttributeType - The attribute_type of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if attribute_type is None: - raise ValueError("Invalid value for 'attribute_type', must not be 'None'") - # Field is required - if attribute_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_type', must not be 'Unset'") - self._attribute_type = attribute_type - - @property - def about_attribute(self) -> "GsaSlimTypedAttribute | Unset_Type": - """Gets the about_attribute of this GsaResolvedTargetAttribute. - - Returns - ------- - GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaResolvedTargetAttribute. - """ - return self._about_attribute - - @about_attribute.setter - def about_attribute(self, about_attribute: "GsaSlimTypedAttribute | Unset_Type") -> None: - """Sets the about_attribute of this GsaResolvedTargetAttribute. - - Parameters - ---------- - about_attribute: GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if about_attribute is None: - raise ValueError("Invalid value for 'about_attribute', must not be 'None'") - self._about_attribute = about_attribute - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaResolvedTargetAttribute): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_potential_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_potential_request.py deleted file mode 100644 index ea76da18..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_potential_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetPotentialRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "target_database_keys": "list[str]", - } - - attribute_map: dict[str, str] = { - "target_database_keys": "targetDatabaseKeys", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - target_database_keys: "list[str]", - ) -> None: - """GsaRetargetPotentialRequest - a model defined in Swagger - - Parameters - ---------- - target_database_keys: list[str] - """ - self._target_database_keys: list[str] - - self.target_database_keys = target_database_keys - - @property - def target_database_keys(self) -> "list[str]": - """Gets the target_database_keys of this GsaRetargetPotentialRequest. - List of database keys to check for retargeting potential. - - Returns - ------- - list[str] - The target_database_keys of this GsaRetargetPotentialRequest. - """ - return self._target_database_keys - - @target_database_keys.setter - def target_database_keys(self, target_database_keys: "list[str]") -> None: - """Sets the target_database_keys of this GsaRetargetPotentialRequest. - List of database keys to check for retargeting potential. - - Parameters - ---------- - target_database_keys: list[str] - The target_database_keys of this GsaRetargetPotentialRequest. - """ - # Field is not nullable - if target_database_keys is None: - raise ValueError("Invalid value for 'target_database_keys', must not be 'None'") - # Field is required - if target_database_keys is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_database_keys', must not be 'Unset'") - self._target_database_keys = target_database_keys - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetPotentialRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_request.py deleted file mode 100644 index 5871f1e2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_request.py +++ /dev/null @@ -1,187 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "new_target_database_key": "str", - "previous_target_database_key": "str", - } - - attribute_map: dict[str, str] = { - "new_target_database_key": "newTargetDatabaseKey", - "previous_target_database_key": "previousTargetDatabaseKey", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - new_target_database_key: "str", - previous_target_database_key: "str", - ) -> None: - """GsaRetargetRequest - a model defined in Swagger - - Parameters - ---------- - new_target_database_key: str - previous_target_database_key: str - """ - self._previous_target_database_key: str - self._new_target_database_key: str - - self.previous_target_database_key = previous_target_database_key - self.new_target_database_key = new_target_database_key - - @property - def previous_target_database_key(self) -> "str": - """Gets the previous_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes were targeting before the operation. - - Returns - ------- - str - The previous_target_database_key of this GsaRetargetRequest. - """ - return self._previous_target_database_key - - @previous_target_database_key.setter - def previous_target_database_key(self, previous_target_database_key: "str") -> None: - """Sets the previous_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes were targeting before the operation. - - Parameters - ---------- - previous_target_database_key: str - The previous_target_database_key of this GsaRetargetRequest. - """ - # Field is not nullable - if previous_target_database_key is None: - raise ValueError("Invalid value for 'previous_target_database_key', must not be 'None'") - # Field is required - if previous_target_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'previous_target_database_key', must not be 'Unset'" - ) - self._previous_target_database_key = previous_target_database_key - - @property - def new_target_database_key(self) -> "str": - """Gets the new_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes will target after the operation. - - Returns - ------- - str - The new_target_database_key of this GsaRetargetRequest. - """ - return self._new_target_database_key - - @new_target_database_key.setter - def new_target_database_key(self, new_target_database_key: "str") -> None: - """Sets the new_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes will target after the operation. - - Parameters - ---------- - new_target_database_key: str - The new_target_database_key of this GsaRetargetRequest. - """ - # Field is not nullable - if new_target_database_key is None: - raise ValueError("Invalid value for 'new_target_database_key', must not be 'None'") - # Field is required - if new_target_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'new_target_database_key', must not be 'Unset'") - self._new_target_database_key = new_target_database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result.py deleted file mode 100644 index 56989ce0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result.py +++ /dev/null @@ -1,319 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetResult(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_name": "str", - "result": "GsaRetargetResultType", - "source_database_key": "str", - "table_name": "str", - "target_database_key": "str", - "target_table_name": "str", - } - - attribute_map: dict[str, str] = { - "attribute_name": "attributeName", - "result": "result", - "source_database_key": "sourceDatabaseKey", - "table_name": "tableName", - "target_database_key": "targetDatabaseKey", - "target_table_name": "targetTableName", - } - - subtype_mapping: dict[str, str] = { - "result": "GsaRetargetResultType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_name: "str", - result: "GsaRetargetResultType", - source_database_key: "str", - table_name: "str", - target_database_key: "str | None | Unset_Type" = Unset, - target_table_name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRetargetResult - a model defined in Swagger - - Parameters - ---------- - attribute_name: str - result: GsaRetargetResultType - source_database_key: str - table_name: str - target_database_key: str | None, optional - target_table_name: str | None, optional - """ - self._source_database_key: str - self._table_name: str - self._attribute_name: str - self._target_database_key: str | None | Unset_Type = Unset - self._target_table_name: str | None | Unset_Type = Unset - self._result: GsaRetargetResultType - - self.source_database_key = source_database_key - self.table_name = table_name - self.attribute_name = attribute_name - if target_database_key is not Unset: - self.target_database_key = target_database_key - if target_table_name is not Unset: - self.target_table_name = target_table_name - self.result = result - - @property - def source_database_key(self) -> "str": - """Gets the source_database_key of this GsaRetargetResult. - Database key of the source database - the one holding the tabular attribute that was retargeted. - - Returns - ------- - str - The source_database_key of this GsaRetargetResult. - """ - return self._source_database_key - - @source_database_key.setter - def source_database_key(self, source_database_key: "str") -> None: - """Sets the source_database_key of this GsaRetargetResult. - Database key of the source database - the one holding the tabular attribute that was retargeted. - - Parameters - ---------- - source_database_key: str - The source_database_key of this GsaRetargetResult. - """ - # Field is not nullable - if source_database_key is None: - raise ValueError("Invalid value for 'source_database_key', must not be 'None'") - # Field is required - if source_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_database_key', must not be 'Unset'") - self._source_database_key = source_database_key - - @property - def table_name(self) -> "str": - """Gets the table_name of this GsaRetargetResult. - Table name of the source table - the one holding the tabular attribute that was retargeted. - - Returns - ------- - str - The table_name of this GsaRetargetResult. - """ - return self._table_name - - @table_name.setter - def table_name(self, table_name: "str") -> None: - """Sets the table_name of this GsaRetargetResult. - Table name of the source table - the one holding the tabular attribute that was retargeted. - - Parameters - ---------- - table_name: str - The table_name of this GsaRetargetResult. - """ - # Field is not nullable - if table_name is None: - raise ValueError("Invalid value for 'table_name', must not be 'None'") - # Field is required - if table_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_name', must not be 'Unset'") - self._table_name = table_name - - @property - def attribute_name(self) -> "str": - """Gets the attribute_name of this GsaRetargetResult. - Name of the tabular attribute that was retargeted. - - Returns - ------- - str - The attribute_name of this GsaRetargetResult. - """ - return self._attribute_name - - @attribute_name.setter - def attribute_name(self, attribute_name: "str") -> None: - """Sets the attribute_name of this GsaRetargetResult. - Name of the tabular attribute that was retargeted. - - Parameters - ---------- - attribute_name: str - The attribute_name of this GsaRetargetResult. - """ - # Field is not nullable - if attribute_name is None: - raise ValueError("Invalid value for 'attribute_name', must not be 'None'") - # Field is required - if attribute_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_name', must not be 'Unset'") - self._attribute_name = attribute_name - - @property - def target_database_key(self) -> "str | None | Unset_Type": - """Gets the target_database_key of this GsaRetargetResult. - Database key of the target database of the retargeted tabular attribute if the retarget was successful. Otherwise, Null if the retarget was not successful. - - Returns - ------- - str | None | Unset_Type - The target_database_key of this GsaRetargetResult. - """ - return self._target_database_key - - @target_database_key.setter - def target_database_key(self, target_database_key: "str | None | Unset_Type") -> None: - """Sets the target_database_key of this GsaRetargetResult. - Database key of the target database of the retargeted tabular attribute if the retarget was successful. Otherwise, Null if the retarget was not successful. - - Parameters - ---------- - target_database_key: str | None | Unset_Type - The target_database_key of this GsaRetargetResult. - """ - self._target_database_key = target_database_key - - @property - def target_table_name(self) -> "str | None | Unset_Type": - """Gets the target_table_name of this GsaRetargetResult. - Table name of the target table of the retargeted tabular attribute if the retarget was successful. Otherwise, Null if the retarget was not successful. - - Returns - ------- - str | None | Unset_Type - The target_table_name of this GsaRetargetResult. - """ - return self._target_table_name - - @target_table_name.setter - def target_table_name(self, target_table_name: "str | None | Unset_Type") -> None: - """Sets the target_table_name of this GsaRetargetResult. - Table name of the target table of the retargeted tabular attribute if the retarget was successful. Otherwise, Null if the retarget was not successful. - - Parameters - ---------- - target_table_name: str | None | Unset_Type - The target_table_name of this GsaRetargetResult. - """ - self._target_table_name = target_table_name - - @property - def result(self) -> "GsaRetargetResultType": - """Gets the result of this GsaRetargetResult. - - Returns - ------- - GsaRetargetResultType - The result of this GsaRetargetResult. - """ - return self._result - - @result.setter - def result(self, result: "GsaRetargetResultType") -> None: - """Sets the result of this GsaRetargetResult. - - Parameters - ---------- - result: GsaRetargetResultType - The result of this GsaRetargetResult. - """ - # Field is not nullable - if result is None: - raise ValueError("Invalid value for 'result', must not be 'None'") - # Field is required - if result is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'result', must not be 'Unset'") - self._result = result - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result_type.py deleted file mode 100644 index 45eee238..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_result_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaRetargetResultType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - SUCCESS = "success" - TABLENOTFOUND = "tableNotFound" - LINKINGATTRIBUTENOTFOUND = "linkingAttributeNotFound" - COLUMNMISSING = "columnMissing" - MISSINGADMINPERMISSIONS = "missingAdminPermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_results_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_results_info.py deleted file mode 100644 index 8d966a5b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_retarget_results_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetResultsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "results": "list[GsaRetargetResult]", - } - - attribute_map: dict[str, str] = { - "results": "results", - } - - subtype_mapping: dict[str, str] = { - "results": "GsaRetargetResult", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - results: "list[GsaRetargetResult]", - ) -> None: - """GsaRetargetResultsInfo - a model defined in Swagger - - Parameters - ---------- - results: list[GsaRetargetResult] - """ - self._results: list[GsaRetargetResult] - - self.results = results - - @property - def results(self) -> "list[GsaRetargetResult]": - """Gets the results of this GsaRetargetResultsInfo. - - Returns - ------- - list[GsaRetargetResult] - The results of this GsaRetargetResultsInfo. - """ - return self._results - - @results.setter - def results(self, results: "list[GsaRetargetResult]") -> None: - """Sets the results of this GsaRetargetResultsInfo. - - Parameters - ---------- - results: list[GsaRetargetResult] - The results of this GsaRetargetResultsInfo. - """ - # Field is not nullable - if results is None: - raise ValueError("Invalid value for 'results', must not be 'None'") - # Field is required - if results is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'results', must not be 'Unset'") - self._results = results - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetResultsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_as_name_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_as_name_record_link_group_error_detail.py deleted file mode 100644 index 8fdfc563..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_as_name_record_link_group_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - "reverse_name": "str", - "target_table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "reverse_name": "reverseName", - "target_table_guid": "targetTableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REVERSENAMEALREADYEXISTSASNAME, - reverse_name: "str", - target_table_guid: "str", - ) -> None: - """GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - reverse_name: str - target_table_guid: str - """ - super().__init__(message=message, reason=reason) - self._reverse_name: str - self._target_table_guid: str - - self.reverse_name = reverse_name - self.target_table_guid = target_table_guid - - @property - def reverse_name(self) -> "str": - """Gets the reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Returns - ------- - str - The reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - return self._reverse_name - - @reverse_name.setter - def reverse_name(self, reverse_name: "str") -> None: - """Sets the reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Parameters - ---------- - reverse_name: str - The reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if reverse_name is None: - raise ValueError("Invalid value for 'reverse_name', must not be 'None'") - # Field is required - if reverse_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reverse_name', must not be 'Unset'") - self._reverse_name = reverse_name - - @property - def target_table_guid(self) -> "str": - """Gets the target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Returns - ------- - str - The target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - return self._target_table_guid - - @target_table_guid.setter - def target_table_guid(self, target_table_guid: "str") -> None: - """Sets the target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Parameters - ---------- - target_table_guid: str - The target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if target_table_guid is None: - raise ValueError("Invalid value for 'target_table_guid', must not be 'None'") - # Field is required - if target_table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_table_guid', must not be 'Unset'") - self._target_table_guid = target_table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_record_link_group_error_detail.py deleted file mode 100644 index 5e44ab5d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_already_exists_record_link_group_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - "reverse_name": "str", - "target_table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "reverse_name": "reverseName", - "target_table_guid": "targetTableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REVERSENAMEALREADYEXISTS, - reverse_name: "str", - target_table_guid: "str", - ) -> None: - """GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - reverse_name: str - target_table_guid: str - """ - super().__init__(message=message, reason=reason) - self._reverse_name: str - self._target_table_guid: str - - self.reverse_name = reverse_name - self.target_table_guid = target_table_guid - - @property - def reverse_name(self) -> "str": - """Gets the reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Returns - ------- - str - The reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - return self._reverse_name - - @reverse_name.setter - def reverse_name(self, reverse_name: "str") -> None: - """Sets the reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Parameters - ---------- - reverse_name: str - The reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if reverse_name is None: - raise ValueError("Invalid value for 'reverse_name', must not be 'None'") - # Field is required - if reverse_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reverse_name', must not be 'Unset'") - self._reverse_name = reverse_name - - @property - def target_table_guid(self) -> "str": - """Gets the target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Returns - ------- - str - The target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - return self._target_table_guid - - @target_table_guid.setter - def target_table_guid(self, target_table_guid: "str") -> None: - """Sets the target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Parameters - ---------- - target_table_guid: str - The target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if target_table_guid is None: - raise ValueError("Invalid value for 'target_table_guid', must not be 'None'") - # Field is required - if target_table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_table_guid', must not be 'Unset'") - self._target_table_guid = target_table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_not_provided_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_not_provided_record_link_group_error_detail.py deleted file mode 100644 index f4af2260..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_reverse_name_not_provided_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReverseNameNotProvidedRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REVERSENAMENOTPROVIDED, - ) -> None: - """GsaReverseNameNotProvidedRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReverseNameNotProvidedRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_role_not_provided_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_role_not_provided_permission_error_detail.py deleted file mode 100644 index 53128fcc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_role_not_provided_permission_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_error_detail import ( # noqa: F401 - GsaPermissionErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_error_reason import ( - GsaPermissionErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRoleNotProvidedPermissionErrorDetail(GsaPermissionErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionErrorReason" = GsaPermissionErrorReason.ROLENOTPROVIDED, - ) -> None: - """GsaRoleNotProvidedPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRoleNotProvidedPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_folder_move_error_detail.py deleted file mode 100644 index aec5bd61..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_folder_move_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRootFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.ROOT, - ) -> None: - """GsaRootFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRootFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_record_not_available_to_rename_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_record_not_available_to_rename_error_detail.py deleted file mode 100644 index 98f6b510..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_root_record_not_available_to_rename_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRootRecordNotAvailableToRenameErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - "table_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "table_name": "tableName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.ROOTRECORDNOTAVAILABLETORENAME, - table_name: "str", - ) -> None: - """GsaRootRecordNotAvailableToRenameErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - table_name: str - """ - super().__init__(message=message, reason=reason) - self._table_name: str - - self.table_name = table_name - - @property - def table_name(self) -> "str": - """Gets the table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - - Returns - ------- - str - The table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - """ - return self._table_name - - @table_name.setter - def table_name(self, table_name: "str") -> None: - """Sets the table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - - Parameters - ---------- - table_name: str - The table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - """ - # Field is not nullable - if table_name is None: - raise ValueError("Invalid value for 'table_name', must not be 'None'") - # Field is required - if table_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_name', must not be 'Unset'") - self._table_name = table_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRootRecordNotAvailableToRenameErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_rule_engine.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_rule_engine.py deleted file mode 100644 index 60051fb2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_rule_engine.py +++ /dev/null @@ -1,185 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRuleEngine(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "fully_qualified_type_name": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "fully_qualified_type_name": "fullyQualifiedTypeName", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - fully_qualified_type_name: "str", - name: "str", - ) -> None: - """GsaRuleEngine - a model defined in Swagger - - Parameters - ---------- - fully_qualified_type_name: str - name: str - """ - self._name: str - self._fully_qualified_type_name: str - - self.name = name - self.fully_qualified_type_name = fully_qualified_type_name - - @property - def name(self) -> "str": - """Gets the name of this GsaRuleEngine. - The name of the rule engine. - - Returns - ------- - str - The name of this GsaRuleEngine. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaRuleEngine. - The name of the rule engine. - - Parameters - ---------- - name: str - The name of this GsaRuleEngine. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def fully_qualified_type_name(self) -> "str": - """Gets the fully_qualified_type_name of this GsaRuleEngine. - The fully qualified name of the rule engine implementation. - - Returns - ------- - str - The fully_qualified_type_name of this GsaRuleEngine. - """ - return self._fully_qualified_type_name - - @fully_qualified_type_name.setter - def fully_qualified_type_name(self, fully_qualified_type_name: "str") -> None: - """Sets the fully_qualified_type_name of this GsaRuleEngine. - The fully qualified name of the rule engine implementation. - - Parameters - ---------- - fully_qualified_type_name: str - The fully_qualified_type_name of this GsaRuleEngine. - """ - # Field is not nullable - if fully_qualified_type_name is None: - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'None'") - # Field is required - if fully_qualified_type_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'Unset'") - self._fully_qualified_type_name = fully_qualified_type_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRuleEngine): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_file_move_error_detail.py deleted file mode 100644 index f29569d9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_file_move_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_move_error_detail import ( # noqa: F401 - GsaFileMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_file_move_error_reason import ( - GsaFileMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSameParentFileMoveErrorDetail(GsaFileMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - "new_parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "new_parent_folder_guid": "newParentFolderGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason" = GsaFileMoveErrorReason.SAMEPARENT, - new_parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaSameParentFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - new_parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._new_parent_folder_guid: str | Unset_Type = Unset - - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid - - @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - """ - return self._new_parent_folder_guid - - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - - Parameters - ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSameParentFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_folder_move_error_detail.py deleted file mode 100644 index 8a0dd831..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_same_parent_folder_move_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSameParentFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - "new_parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "new_parent_folder_guid": "newParentFolderGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.SAMEPARENT, - new_parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaSameParentFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - new_parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._new_parent_folder_guid: str | Unset_Type = Unset - - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid - - @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - """ - return self._new_parent_folder_guid - - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - - Parameters - ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSameParentFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_save_search_request.py similarity index 65% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_response.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_save_search_request.py index c2885144..ba636a0a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_error_response.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_save_search_request.py @@ -42,7 +42,7 @@ from . import * -class GsaErrorResponse(ModelBase): +class GsaSaveSearchRequest(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,17 +61,17 @@ class GsaErrorResponse(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "message": "str", + "detail": "GsaSearchDetail", + "search_config": "str", } attribute_map: dict[str, str] = { - "code": "code", - "message": "message", + "detail": "detail", + "search_config": "searchConfig", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "detail": "GsaSearchDetail", } discriminator: Optional[str] = None @@ -79,70 +79,70 @@ class GsaErrorResponse(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, + detail: "GsaSearchDetail | Unset_Type" = Unset, + search_config: "str | None | Unset_Type" = Unset, ) -> None: - """GsaErrorResponse - a model defined in Swagger + """GsaSaveSearchRequest - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional - message: str | None, optional + detail: GsaSearchDetail, optional + search_config: str | None, optional """ - self._code: GsaErrorCode | Unset_Type = Unset - self._message: str | None | Unset_Type = Unset + self._search_config: str | None | Unset_Type = Unset + self._detail: GsaSearchDetail | Unset_Type = Unset - if code is not Unset: - self.code = code - if message is not Unset: - self.message = message + if search_config is not Unset: + self.search_config = search_config + if detail is not Unset: + self.detail = detail @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaErrorResponse. + def search_config(self) -> "str | None | Unset_Type": + """Gets the search_config of this GsaSaveSearchRequest. Returns ------- - GsaErrorCode | Unset_Type - The code of this GsaErrorResponse. + str | None | Unset_Type + The search_config of this GsaSaveSearchRequest. """ - return self._code + return self._search_config - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaErrorResponse. + @search_config.setter + def search_config(self, search_config: "str | None | Unset_Type") -> None: + """Sets the search_config of this GsaSaveSearchRequest. Parameters ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaErrorResponse. + search_config: str | None | Unset_Type + The search_config of this GsaSaveSearchRequest. """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code + self._search_config = search_config @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaErrorResponse. + def detail(self) -> "GsaSearchDetail | Unset_Type": + """Gets the detail of this GsaSaveSearchRequest. Returns ------- - str | None | Unset_Type - The message of this GsaErrorResponse. + GsaSearchDetail | Unset_Type + The detail of this GsaSaveSearchRequest. """ - return self._message + return self._detail - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaErrorResponse. + @detail.setter + def detail(self, detail: "GsaSearchDetail | Unset_Type") -> None: + """Sets the detail of this GsaSaveSearchRequest. Parameters ---------- - message: str | None | Unset_Type - The message of this GsaErrorResponse. + detail: GsaSearchDetail | Unset_Type + The detail of this GsaSaveSearchRequest. """ - self._message = message + # Field is not nullable + if detail is None: + raise ValueError("Invalid value for 'detail', must not be 'None'") + self._detail = detail @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -166,7 +166,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaErrorResponse): + if not isinstance(other, GsaSaveSearchRequest): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_schema_generation_warning_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_schema_generation_warning_reason.py deleted file mode 100644 index 48111db5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_schema_generation_warning_reason.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaSchemaGenerationWarningReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNKNOWN = "unknown" - STANDARDNAMENOTFOUND = "standardNameNotFound" - HASATTRIBUTEANDLINKSOURCES = "hasAttributeAndLinkSources" - INCONSISTENTLINKTOTARGETDATABASE = "inconsistentLinkToTargetDatabase" - MISSINGTARGETDATABASE = "missingTargetDatabase" - INCONSISTENTLINKTOTARGETTABLE = "inconsistentLinkToTargetTable" - INCONSISTENTATTRIBUTETYPES = "inconsistentAttributeTypes" - INCONSISTENTDISCRETETYPES = "inconsistentDiscreteTypes" - INCONSISTENTUNITS = "inconsistentUnits" - PARAMETERSNOTFOUND = "parametersNotFound" - INCONSISTENTSOURCETABLES = "inconsistentSourceTables" - INCONSISTENTINTERPOLATIONMETHODS = "inconsistentInterpolationMethods" - INCONSISTENTSCALETYPES = "inconsistentScaleTypes" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_search_mask.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_detail.py similarity index 63% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_search_mask.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_detail.py index 337b53a3..967c94de 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_search_mask.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_detail.py @@ -42,7 +42,7 @@ from . import * -class GsaSlimSearchMask(ModelBase): +class GsaSearchDetail(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,15 +61,17 @@ class GsaSlimSearchMask(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", + "criteria": "str", "description": "str", + "name": "str", + "notes": "str", } attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", + "criteria": "criteria", "description": "description", + "name": "name", + "notes": "notes", } subtype_mapping: dict[str, str] = {} @@ -79,104 +81,121 @@ class GsaSlimSearchMask(ModelBase): def __init__( self, *, - guid: "str", - name: "str", + criteria: "str | None | Unset_Type" = Unset, description: "str | None | Unset_Type" = Unset, + name: "str | None | Unset_Type" = Unset, + notes: "str | None | Unset_Type" = Unset, ) -> None: - """GsaSlimSearchMask - a model defined in Swagger + """GsaSearchDetail - a model defined in Swagger Parameters ---------- - guid: str - name: str + criteria: str | None, optional description: str | None, optional + name: str | None, optional + notes: str | None, optional """ + self._name: str | None | Unset_Type = Unset self._description: str | None | Unset_Type = Unset - self._name: str - self._guid: str + self._notes: str | None | Unset_Type = Unset + self._criteria: str | None | Unset_Type = Unset + if name is not Unset: + self.name = name if description is not Unset: self.description = description - self.name = name - self.guid = guid + if notes is not Unset: + self.notes = notes + if criteria is not Unset: + self.criteria = criteria + + @property + def name(self) -> "str | None | Unset_Type": + """Gets the name of this GsaSearchDetail. + + Returns + ------- + str | None | Unset_Type + The name of this GsaSearchDetail. + """ + return self._name + + @name.setter + def name(self, name: "str | None | Unset_Type") -> None: + """Sets the name of this GsaSearchDetail. + + Parameters + ---------- + name: str | None | Unset_Type + The name of this GsaSearchDetail. + """ + self._name = name @property def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSlimSearchMask. + """Gets the description of this GsaSearchDetail. Returns ------- str | None | Unset_Type - The description of this GsaSlimSearchMask. + The description of this GsaSearchDetail. """ return self._description @description.setter def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSlimSearchMask. + """Sets the description of this GsaSearchDetail. Parameters ---------- description: str | None | Unset_Type - The description of this GsaSlimSearchMask. + The description of this GsaSearchDetail. """ self._description = description @property - def name(self) -> "str": - """Gets the name of this GsaSlimSearchMask. + def notes(self) -> "str | None | Unset_Type": + """Gets the notes of this GsaSearchDetail. Returns ------- - str - The name of this GsaSlimSearchMask. + str | None | Unset_Type + The notes of this GsaSearchDetail. """ - return self._name + return self._notes - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSlimSearchMask. + @notes.setter + def notes(self, notes: "str | None | Unset_Type") -> None: + """Sets the notes of this GsaSearchDetail. Parameters ---------- - name: str - The name of this GsaSlimSearchMask. + notes: str | None | Unset_Type + The notes of this GsaSearchDetail. """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name + self._notes = notes @property - def guid(self) -> "str": - """Gets the guid of this GsaSlimSearchMask. + def criteria(self) -> "str | None | Unset_Type": + """Gets the criteria of this GsaSearchDetail. Returns ------- - str - The guid of this GsaSlimSearchMask. + str | None | Unset_Type + The criteria of this GsaSearchDetail. """ - return self._guid + return self._criteria - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimSearchMask. + @criteria.setter + def criteria(self, criteria: "str | None | Unset_Type") -> None: + """Sets the criteria of this GsaSearchDetail. Parameters ---------- - guid: str - The guid of this GsaSlimSearchMask. + criteria: str | None | Unset_Type + The criteria of this GsaSearchDetail. """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid + self._criteria = criteria @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -200,7 +219,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimSearchMask): + if not isinstance(other, GsaSearchDetail): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask.py deleted file mode 100644 index ac3393db..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask.py +++ /dev/null @@ -1,273 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchMask(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "attributes": "list[GsaAttribute]", - "description": "str", - "record_properties": "list[GsaRecordProperty]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "attributes": "attributes", - "description": "description", - "record_properties": "recordProperties", - } - - subtype_mapping: dict[str, str] = { - "attributes": "GsaAttribute", - "recordProperties": "GsaRecordProperty", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - attributes: "list[GsaAttribute] | None | Unset_Type" = Unset, - description: "str | None | Unset_Type" = Unset, - record_properties: "list[GsaRecordProperty] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchMask - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - attributes: list[GsaAttribute] | None, optional - description: str | None, optional - record_properties: list[GsaRecordProperty] | None, optional - """ - self._attributes: list[GsaAttribute] | None | Unset_Type = Unset - self._record_properties: list[GsaRecordProperty] | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._name: str - self._guid: str - - if attributes is not Unset: - self.attributes = attributes - if record_properties is not Unset: - self.record_properties = record_properties - if description is not Unset: - self.description = description - self.name = name - self.guid = guid - - @property - def attributes(self) -> "list[GsaAttribute] | None | Unset_Type": - """Gets the attributes of this GsaSearchMask. - - Returns - ------- - list[GsaAttribute] | None | Unset_Type - The attributes of this GsaSearchMask. - """ - return self._attributes - - @attributes.setter - def attributes(self, attributes: "list[GsaAttribute] | None | Unset_Type") -> None: - """Sets the attributes of this GsaSearchMask. - - Parameters - ---------- - attributes: list[GsaAttribute] | None | Unset_Type - The attributes of this GsaSearchMask. - """ - self._attributes = attributes - - @property - def record_properties(self) -> "list[GsaRecordProperty] | None | Unset_Type": - """Gets the record_properties of this GsaSearchMask. - - Returns - ------- - list[GsaRecordProperty] | None | Unset_Type - The record_properties of this GsaSearchMask. - """ - return self._record_properties - - @record_properties.setter - def record_properties( - self, record_properties: "list[GsaRecordProperty] | None | Unset_Type" - ) -> None: - """Sets the record_properties of this GsaSearchMask. - - Parameters - ---------- - record_properties: list[GsaRecordProperty] | None | Unset_Type - The record_properties of this GsaSearchMask. - """ - self._record_properties = record_properties - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSearchMask. - - Returns - ------- - str | None | Unset_Type - The description of this GsaSearchMask. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSearchMask. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaSearchMask. - """ - self._description = description - - @property - def name(self) -> "str": - """Gets the name of this GsaSearchMask. - - Returns - ------- - str - The name of this GsaSearchMask. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSearchMask. - - Parameters - ---------- - name: str - The name of this GsaSearchMask. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSearchMask. - - Returns - ------- - str - The guid of this GsaSearchMask. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSearchMask. - - Parameters - ---------- - guid: str - The guid of this GsaSearchMask. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchMask): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask_info.py deleted file mode 100644 index 87f7a2cc..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_mask_info.py +++ /dev/null @@ -1,144 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchMaskInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "search_masks": "list[GsaSlimSearchMask]", - } - - attribute_map: dict[str, str] = { - "search_masks": "searchMasks", - } - - subtype_mapping: dict[str, str] = { - "searchMasks": "GsaSlimSearchMask", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - search_masks: "list[GsaSlimSearchMask] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchMaskInfo - a model defined in Swagger - - Parameters - ---------- - search_masks: list[GsaSlimSearchMask] | None, optional - """ - self._search_masks: list[GsaSlimSearchMask] | None | Unset_Type = Unset - - if search_masks is not Unset: - self.search_masks = search_masks - - @property - def search_masks(self) -> "list[GsaSlimSearchMask] | None | Unset_Type": - """Gets the search_masks of this GsaSearchMaskInfo. - - Returns - ------- - list[GsaSlimSearchMask] | None | Unset_Type - The search_masks of this GsaSearchMaskInfo. - """ - return self._search_masks - - @search_masks.setter - def search_masks(self, search_masks: "list[GsaSlimSearchMask] | None | Unset_Type") -> None: - """Sets the search_masks of this GsaSearchMaskInfo. - - Parameters - ---------- - search_masks: list[GsaSlimSearchMask] | None | Unset_Type - The search_masks of this GsaSearchMaskInfo. - """ - self._search_masks = search_masks - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchMaskInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_request.py index 27c3b2a2..494c84ca 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_request.py @@ -62,25 +62,20 @@ class GsaSearchRequest(ModelBase): """ swagger_types: dict[str, str] = { "criterion": "GsaCriterion", - "find_similar_id": "str", "paging_options": "GsaPagingOptions", "sort_criteria": "list[GsaSortCriterion]", - "table_search_behaviour": "GsaTableSearchBehaviour", } attribute_map: dict[str, str] = { "criterion": "criterion", - "find_similar_id": "findSimilarId", "paging_options": "pagingOptions", "sort_criteria": "sortCriteria", - "table_search_behaviour": "tableSearchBehaviour", } subtype_mapping: dict[str, str] = { "criterion": "GsaCriterion", "sortCriteria": "GsaSortCriterion", "pagingOptions": "GsaPagingOptions", - "tableSearchBehaviour": "GsaTableSearchBehaviour", } discriminator: Optional[str] = None @@ -89,26 +84,20 @@ def __init__( self, *, criterion: "GsaCriterion | Unset_Type" = Unset, - find_similar_id: "str | None | Unset_Type" = Unset, paging_options: "GsaPagingOptions | Unset_Type" = Unset, sort_criteria: "list[GsaSortCriterion] | None | Unset_Type" = Unset, - table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" = Unset, ) -> None: """GsaSearchRequest - a model defined in Swagger Parameters ---------- criterion: GsaCriterion, optional - find_similar_id: str | None, optional paging_options: GsaPagingOptions, optional sort_criteria: list[GsaSortCriterion] | None, optional - table_search_behaviour: GsaTableSearchBehaviour, optional """ self._criterion: GsaCriterion | Unset_Type = Unset self._sort_criteria: list[GsaSortCriterion] | None | Unset_Type = Unset self._paging_options: GsaPagingOptions | Unset_Type = Unset - self._table_search_behaviour: GsaTableSearchBehaviour | Unset_Type = Unset - self._find_similar_id: str | None | Unset_Type = Unset if criterion is not Unset: self.criterion = criterion @@ -116,10 +105,6 @@ def __init__( self.sort_criteria = sort_criteria if paging_options is not Unset: self.paging_options = paging_options - if table_search_behaviour is not Unset: - self.table_search_behaviour = table_search_behaviour - if find_similar_id is not Unset: - self.find_similar_id = find_similar_id @property def criterion(self) -> "GsaCriterion | Unset_Type": @@ -195,57 +180,6 @@ def paging_options(self, paging_options: "GsaPagingOptions | Unset_Type") -> Non raise ValueError("Invalid value for 'paging_options', must not be 'None'") self._paging_options = paging_options - @property - def table_search_behaviour(self) -> "GsaTableSearchBehaviour | Unset_Type": - """Gets the table_search_behaviour of this GsaSearchRequest. - - Returns - ------- - GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaSearchRequest. - """ - return self._table_search_behaviour - - @table_search_behaviour.setter - def table_search_behaviour( - self, table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" - ) -> None: - """Sets the table_search_behaviour of this GsaSearchRequest. - - Parameters - ---------- - table_search_behaviour: GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaSearchRequest. - """ - # Field is not nullable - if table_search_behaviour is None: - raise ValueError("Invalid value for 'table_search_behaviour', must not be 'None'") - self._table_search_behaviour = table_search_behaviour - - @property - def find_similar_id(self) -> "str | None | Unset_Type": - """Gets the find_similar_id of this GsaSearchRequest. - An optional identifier of a find similar calculation to include in this search. Results will include a similarity score. - - Returns - ------- - str | None | Unset_Type - The find_similar_id of this GsaSearchRequest. - """ - return self._find_similar_id - - @find_similar_id.setter - def find_similar_id(self, find_similar_id: "str | None | Unset_Type") -> None: - """Sets the find_similar_id of this GsaSearchRequest. - An optional identifier of a find similar calculation to include in this search. Results will include a similarity score. - - Parameters - ---------- - find_similar_id: str | None | Unset_Type - The find_similar_id of this GsaSearchRequest. - """ - self._find_similar_id = find_similar_id - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_result.py index 4473f20f..c222c560 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_result.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_result.py @@ -69,7 +69,6 @@ class GsaSearchResult(ModelBase): "record_history_guid": "str", "record_name": "str", "score": "float", - "similarity_score": "float", "sorting_value": "GsaSortingValue", "table_guid": "str", "table_identity": "int", @@ -88,7 +87,6 @@ class GsaSearchResult(ModelBase): "record_history_guid": "recordHistoryGuid", "record_name": "recordName", "score": "score", - "similarity_score": "similarityScore", "sorting_value": "sortingValue", "table_guid": "tableGuid", "table_identity": "tableIdentity", @@ -116,7 +114,6 @@ def __init__( record_history_guid: "str | Unset_Type" = Unset, record_name: "str | None | Unset_Type" = Unset, score: "float | None | Unset_Type" = Unset, - similarity_score: "float | None | Unset_Type" = Unset, sorting_value: "GsaSortingValue | Unset_Type" = Unset, table_guid: "str | Unset_Type" = Unset, table_identity: "int | Unset_Type" = Unset, @@ -137,7 +134,6 @@ def __init__( record_history_guid: str, optional record_name: str | None, optional score: float | None, optional - similarity_score: float | None, optional sorting_value: GsaSortingValue, optional table_guid: str, optional table_identity: int, optional @@ -160,7 +156,6 @@ def __init__( self._parent_guid: str | None | Unset_Type = Unset self._type: GsaRecordType | Unset_Type = Unset self._score: float | None | Unset_Type = Unset - self._similarity_score: float | None | Unset_Type = Unset self._sorting_value: GsaSortingValue | Unset_Type = Unset self.database_key = database_key @@ -190,8 +185,6 @@ def __init__( self.type = type if score is not Unset: self.score = score - if similarity_score is not Unset: - self.similarity_score = similarity_score if sorting_value is not Unset: self.sorting_value = sorting_value @@ -527,28 +520,6 @@ def score(self, score: "float | None | Unset_Type") -> None: """ self._score = score - @property - def similarity_score(self) -> "float | None | Unset_Type": - """Gets the similarity_score of this GsaSearchResult. - - Returns - ------- - float | None | Unset_Type - The similarity_score of this GsaSearchResult. - """ - return self._similarity_score - - @similarity_score.setter - def similarity_score(self, similarity_score: "float | None | Unset_Type") -> None: - """Sets the similarity_score of this GsaSearchResult. - - Parameters - ---------- - similarity_score: float | None | Unset_Type - The similarity_score of this GsaSearchResult. - """ - self._similarity_score = similarity_score - @property def sorting_value(self) -> "GsaSortingValue | Unset_Type": """Gets the sorting_value of this GsaSearchResult. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_service_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_service_status.py deleted file mode 100644 index 71743e84..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_service_status.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchServiceStatus(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "is_running": "bool", - } - - attribute_map: dict[str, str] = { - "is_running": "isRunning", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - is_running: "bool", - ) -> None: - """GsaSearchServiceStatus - a model defined in Swagger - - Parameters - ---------- - is_running: bool - """ - self._is_running: bool - - self.is_running = is_running - - @property - def is_running(self) -> "bool": - """Gets the is_running of this GsaSearchServiceStatus. - - Returns - ------- - bool - The is_running of this GsaSearchServiceStatus. - """ - return self._is_running - - @is_running.setter - def is_running(self, is_running: "bool") -> None: - """Sets the is_running of this GsaSearchServiceStatus. - - Parameters - ---------- - is_running: bool - The is_running of this GsaSearchServiceStatus. - """ - # Field is not nullable - if is_running is None: - raise ValueError("Invalid value for 'is_running', must not be 'None'") - # Field is required - if is_running is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_running', must not be 'Unset'") - self._is_running = is_running - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchServiceStatus): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template.py deleted file mode 100644 index 294b9030..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template.py +++ /dev/null @@ -1,278 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "table": "GsaSlimEntity", - "description": "str", - "search_attributes": "list[GsaSearchTemplateItem]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "table": "table", - "description": "description", - "search_attributes": "searchAttributes", - } - - subtype_mapping: dict[str, str] = { - "searchAttributes": "GsaSearchTemplateItem", - "table": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - table: "GsaSlimEntity", - description: "str | None | Unset_Type" = Unset, - search_attributes: "list[GsaSearchTemplateItem] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchTemplate - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - table: GsaSlimEntity - description: str | None, optional - search_attributes: list[GsaSearchTemplateItem] | None, optional - """ - self._search_attributes: list[GsaSearchTemplateItem] | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._table: GsaSlimEntity - self._name: str - self._guid: str - - if search_attributes is not Unset: - self.search_attributes = search_attributes - if description is not Unset: - self.description = description - self.table = table - self.name = name - self.guid = guid - - @property - def search_attributes(self) -> "list[GsaSearchTemplateItem] | None | Unset_Type": - """Gets the search_attributes of this GsaSearchTemplate. - - Returns - ------- - list[GsaSearchTemplateItem] | None | Unset_Type - The search_attributes of this GsaSearchTemplate. - """ - return self._search_attributes - - @search_attributes.setter - def search_attributes( - self, search_attributes: "list[GsaSearchTemplateItem] | None | Unset_Type" - ) -> None: - """Sets the search_attributes of this GsaSearchTemplate. - - Parameters - ---------- - search_attributes: list[GsaSearchTemplateItem] | None | Unset_Type - The search_attributes of this GsaSearchTemplate. - """ - self._search_attributes = search_attributes - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSearchTemplate. - - Returns - ------- - str | None | Unset_Type - The description of this GsaSearchTemplate. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSearchTemplate. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaSearchTemplate. - """ - self._description = description - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSearchTemplate. - - Returns - ------- - GsaSlimEntity - The table of this GsaSearchTemplate. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSearchTemplate. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaSearchTemplate. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def name(self) -> "str": - """Gets the name of this GsaSearchTemplate. - - Returns - ------- - str - The name of this GsaSearchTemplate. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSearchTemplate. - - Parameters - ---------- - name: str - The name of this GsaSearchTemplate. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSearchTemplate. - - Returns - ------- - str - The guid of this GsaSearchTemplate. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSearchTemplate. - - Parameters - ---------- - guid: str - The guid of this GsaSearchTemplate. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_attribute_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_attribute_item.py deleted file mode 100644 index 20cdcc5c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_attribute_item.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_search_template_item import ( # noqa: F401 - GsaSearchTemplateItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_search_template_item_type import ( - GsaSearchTemplateItemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateAttributeItem(GsaSearchTemplateItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "item_type": "GsaSearchTemplateItemType", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "item_type": "itemType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - item_type: "GsaSearchTemplateItemType" = GsaSearchTemplateItemType.ATTRIBUTE, - ) -> None: - """GsaSearchTemplateAttributeItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - item_type: GsaSearchTemplateItemType - """ - super().__init__(attribute=attribute, item_type=item_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateAttributeItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_info.py deleted file mode 100644 index ca0baf33..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_info.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "search_templates": "list[GsaSlimSearchTemplate]", - } - - attribute_map: dict[str, str] = { - "search_templates": "searchTemplates", - } - - subtype_mapping: dict[str, str] = { - "searchTemplates": "GsaSlimSearchTemplate", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - search_templates: "list[GsaSlimSearchTemplate] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchTemplateInfo - a model defined in Swagger - - Parameters - ---------- - search_templates: list[GsaSlimSearchTemplate] | None, optional - """ - self._search_templates: list[GsaSlimSearchTemplate] | None | Unset_Type = Unset - - if search_templates is not Unset: - self.search_templates = search_templates - - @property - def search_templates(self) -> "list[GsaSlimSearchTemplate] | None | Unset_Type": - """Gets the search_templates of this GsaSearchTemplateInfo. - - Returns - ------- - list[GsaSlimSearchTemplate] | None | Unset_Type - The search_templates of this GsaSearchTemplateInfo. - """ - return self._search_templates - - @search_templates.setter - def search_templates( - self, search_templates: "list[GsaSlimSearchTemplate] | None | Unset_Type" - ) -> None: - """Sets the search_templates of this GsaSearchTemplateInfo. - - Parameters - ---------- - search_templates: list[GsaSlimSearchTemplate] | None | Unset_Type - The search_templates of this GsaSearchTemplateInfo. - """ - self._search_templates = search_templates - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item.py deleted file mode 100644 index cbb918be..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "item_type": "GsaSearchTemplateItemType", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "item_type": "itemType", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaSearchTemplateItemType", - "attribute": "GsaSlimEntity", - } - - discriminator_value_class_map = { - "attribute".lower(): "#/components/schemas/GsaSearchTemplateAttributeItem", - "tabularColumn".lower(): "#/components/schemas/GsaSearchTemplateTabularColumnItem", - "link".lower(): "#/components/schemas/GsaSearchTemplateLinkItem", - } - - discriminator: Optional[str] = "itemType" - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - item_type: "GsaSearchTemplateItemType", - ) -> None: - """GsaSearchTemplateItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - item_type: GsaSearchTemplateItemType - """ - self._item_type: GsaSearchTemplateItemType - self._attribute: GsaSlimEntity - - self.item_type = item_type - self.attribute = attribute - - @property - def item_type(self) -> "GsaSearchTemplateItemType": - """Gets the item_type of this GsaSearchTemplateItem. - - Returns - ------- - GsaSearchTemplateItemType - The item_type of this GsaSearchTemplateItem. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaSearchTemplateItemType") -> None: - """Sets the item_type of this GsaSearchTemplateItem. - - Parameters - ---------- - item_type: GsaSearchTemplateItemType - The item_type of this GsaSearchTemplateItem. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaSearchTemplateItem. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaSearchTemplateItem. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaSearchTemplateItem. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaSearchTemplateItem. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item_type.py deleted file mode 100644 index 03cdaf40..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_item_type.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaSearchTemplateItemType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTE = "attribute" - TABULARCOLUMN = "tabularColumn" - LINK = "link" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_link_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_link_item.py deleted file mode 100644 index 2ea49954..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_link_item.py +++ /dev/null @@ -1,267 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_search_template_item import ( # noqa: F401 - GsaSearchTemplateItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_search_template_item_type import ( - GsaSearchTemplateItemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateLinkItem(GsaSearchTemplateItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "forwards": "bool", - "item_type": "GsaSearchTemplateItemType", - "link_type": "GsaRecordLinkGroupType", - "record_link_group": "GsaSlimEntity", - "target_database": "str", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "forwards": "forwards", - "item_type": "itemType", - "link_type": "linkType", - "record_link_group": "recordLinkGroup", - "target_database": "targetDatabase", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroup": "GsaSlimEntity", - "linkType": "GsaRecordLinkGroupType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - forwards: "bool", - item_type: "GsaSearchTemplateItemType" = GsaSearchTemplateItemType.LINK, - link_type: "GsaRecordLinkGroupType", - record_link_group: "GsaSlimEntity", - target_database: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchTemplateLinkItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - forwards: bool - item_type: GsaSearchTemplateItemType - link_type: GsaRecordLinkGroupType - record_link_group: GsaSlimEntity - target_database: str | None, optional - """ - super().__init__(attribute=attribute, item_type=item_type) - self._record_link_group: GsaSlimEntity - self._link_type: GsaRecordLinkGroupType - self._target_database: str | None | Unset_Type = Unset - self._forwards: bool - - self.record_link_group = record_link_group - self.link_type = link_type - if target_database is not Unset: - self.target_database = target_database - self.forwards = forwards - - @property - def record_link_group(self) -> "GsaSlimEntity": - """Gets the record_link_group of this GsaSearchTemplateLinkItem. - - Returns - ------- - GsaSlimEntity - The record_link_group of this GsaSearchTemplateLinkItem. - """ - return self._record_link_group - - @record_link_group.setter - def record_link_group(self, record_link_group: "GsaSlimEntity") -> None: - """Sets the record_link_group of this GsaSearchTemplateLinkItem. - - Parameters - ---------- - record_link_group: GsaSlimEntity - The record_link_group of this GsaSearchTemplateLinkItem. - """ - # Field is not nullable - if record_link_group is None: - raise ValueError("Invalid value for 'record_link_group', must not be 'None'") - # Field is required - if record_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group', must not be 'Unset'") - self._record_link_group = record_link_group - - @property - def link_type(self) -> "GsaRecordLinkGroupType": - """Gets the link_type of this GsaSearchTemplateLinkItem. - - Returns - ------- - GsaRecordLinkGroupType - The link_type of this GsaSearchTemplateLinkItem. - """ - return self._link_type - - @link_type.setter - def link_type(self, link_type: "GsaRecordLinkGroupType") -> None: - """Sets the link_type of this GsaSearchTemplateLinkItem. - - Parameters - ---------- - link_type: GsaRecordLinkGroupType - The link_type of this GsaSearchTemplateLinkItem. - """ - # Field is not nullable - if link_type is None: - raise ValueError("Invalid value for 'link_type', must not be 'None'") - # Field is required - if link_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_type', must not be 'Unset'") - self._link_type = link_type - - @property - def target_database(self) -> "str | None | Unset_Type": - """Gets the target_database of this GsaSearchTemplateLinkItem. - May be null for a static link group, or a cross database link group that can target multiple databases - - Returns - ------- - str | None | Unset_Type - The target_database of this GsaSearchTemplateLinkItem. - """ - return self._target_database - - @target_database.setter - def target_database(self, target_database: "str | None | Unset_Type") -> None: - """Sets the target_database of this GsaSearchTemplateLinkItem. - May be null for a static link group, or a cross database link group that can target multiple databases - - Parameters - ---------- - target_database: str | None | Unset_Type - The target_database of this GsaSearchTemplateLinkItem. - """ - self._target_database = target_database - - @property - def forwards(self) -> "bool": - """Gets the forwards of this GsaSearchTemplateLinkItem. - true if the link points from the table the template is in; or false if it points towards the table the template is in (an inbound link). - - Returns - ------- - bool - The forwards of this GsaSearchTemplateLinkItem. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool") -> None: - """Sets the forwards of this GsaSearchTemplateLinkItem. - true if the link points from the table the template is in; or false if it points towards the table the template is in (an inbound link). - - Parameters - ---------- - forwards: bool - The forwards of this GsaSearchTemplateLinkItem. - """ - # Field is not nullable - if forwards is None: - raise ValueError("Invalid value for 'forwards', must not be 'None'") - # Field is required - if forwards is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'forwards', must not be 'Unset'") - self._forwards = forwards - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateLinkItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_tabular_column_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_tabular_column_item.py deleted file mode 100644 index b39378c5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_search_template_tabular_column_item.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_search_template_item import ( # noqa: F401 - GsaSearchTemplateItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_search_template_item_type import ( - GsaSearchTemplateItemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateTabularColumnItem(GsaSearchTemplateItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "item_type": "GsaSearchTemplateItemType", - "tabular_column": "GsaTabularColumn", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "item_type": "itemType", - "tabular_column": "tabularColumn", - } - - subtype_mapping: dict[str, str] = { - "tabularColumn": "GsaTabularColumn", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - item_type: "GsaSearchTemplateItemType" = GsaSearchTemplateItemType.TABULARCOLUMN, - tabular_column: "GsaTabularColumn", - ) -> None: - """GsaSearchTemplateTabularColumnItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - item_type: GsaSearchTemplateItemType - tabular_column: GsaTabularColumn - """ - super().__init__(attribute=attribute, item_type=item_type) - self._tabular_column: GsaTabularColumn - - self.tabular_column = tabular_column - - @property - def tabular_column(self) -> "GsaTabularColumn": - """Gets the tabular_column of this GsaSearchTemplateTabularColumnItem. - - Returns - ------- - GsaTabularColumn - The tabular_column of this GsaSearchTemplateTabularColumnItem. - """ - return self._tabular_column - - @tabular_column.setter - def tabular_column(self, tabular_column: "GsaTabularColumn") -> None: - """Sets the tabular_column of this GsaSearchTemplateTabularColumnItem. - - Parameters - ---------- - tabular_column: GsaTabularColumn - The tabular_column of this GsaSearchTemplateTabularColumnItem. - """ - # Field is not nullable - if tabular_column is None: - raise ValueError("Invalid value for 'tabular_column', must not be 'None'") - # Field is required - if tabular_column is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'tabular_column', must not be 'Unset'") - self._tabular_column = tabular_column - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateTabularColumnItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_already_exists_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_security_attribute_grouping.py similarity index 58% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_already_exists_folder_move_error_detail.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_security_attribute_grouping.py index ccb813ba..d1d1410a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_folder_already_exists_folder_move_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_security_attribute_grouping.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaFolderAlreadyExistsFolderMoveErrorDetail(GsaFolderMoveErrorDetail): +class GsaSecurityAttributeGrouping(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,95 +61,119 @@ class GsaFolderAlreadyExistsFolderMoveErrorDetail(GsaFolderMoveErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", + "available_discrete_values": "list[GsaDiscreteValue]", + "identity": "int", "name": "str", - "new_parent_folder_guid": "str", } attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", + "available_discrete_values": "availableDiscreteValues", + "identity": "identity", "name": "name", - "new_parent_folder_guid": "newParentFolderGuid", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "availableDiscreteValues": "GsaDiscreteValue", + } discriminator: Optional[str] = None def __init__( self, *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.FOLDERALREADYEXISTS, + available_discrete_values: "list[GsaDiscreteValue] | None | Unset_Type" = Unset, + identity: "int | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - new_parent_folder_guid: "str | Unset_Type" = Unset, ) -> None: - """GsaFolderAlreadyExistsFolderMoveErrorDetail - a model defined in Swagger + """GsaSecurityAttributeGrouping - a model defined in Swagger Parameters ---------- - message: str - reason: GsaFolderMoveErrorReason + available_discrete_values: list[GsaDiscreteValue] | None, optional + identity: int, optional name: str | None, optional - new_parent_folder_guid: str, optional """ - super().__init__(message=message, reason=reason) + self._identity: int | Unset_Type = Unset self._name: str | None | Unset_Type = Unset - self._new_parent_folder_guid: str | Unset_Type = Unset + self._available_discrete_values: list[GsaDiscreteValue] | None | Unset_Type = Unset + if identity is not Unset: + self.identity = identity if name is not Unset: self.name = name - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid + if available_discrete_values is not Unset: + self.available_discrete_values = available_discrete_values + + @property + def identity(self) -> "int | Unset_Type": + """Gets the identity of this GsaSecurityAttributeGrouping. + + Returns + ------- + int | Unset_Type + The identity of this GsaSecurityAttributeGrouping. + """ + return self._identity + + @identity.setter + def identity(self, identity: "int | Unset_Type") -> None: + """Sets the identity of this GsaSecurityAttributeGrouping. + + Parameters + ---------- + identity: int | Unset_Type + The identity of this GsaSecurityAttributeGrouping. + """ + # Field is not nullable + if identity is None: + raise ValueError("Invalid value for 'identity', must not be 'None'") + self._identity = identity @property def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + """Gets the name of this GsaSecurityAttributeGrouping. Returns ------- str | None | Unset_Type - The name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + The name of this GsaSecurityAttributeGrouping. """ return self._name @name.setter def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + """Sets the name of this GsaSecurityAttributeGrouping. Parameters ---------- name: str | None | Unset_Type - The name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + The name of this GsaSecurityAttributeGrouping. """ self._name = name @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + def available_discrete_values(self) -> "list[GsaDiscreteValue] | None | Unset_Type": + """Gets the available_discrete_values of this GsaSecurityAttributeGrouping. Returns ------- - str | Unset_Type - The new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + list[GsaDiscreteValue] | None | Unset_Type + The available_discrete_values of this GsaSecurityAttributeGrouping. """ - return self._new_parent_folder_guid + return self._available_discrete_values - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + @available_discrete_values.setter + def available_discrete_values( + self, available_discrete_values: "list[GsaDiscreteValue] | None | Unset_Type" + ) -> None: + """Sets the available_discrete_values of this GsaSecurityAttributeGrouping. Parameters ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + available_discrete_values: list[GsaDiscreteValue] | None | Unset_Type + The available_discrete_values of this GsaSecurityAttributeGrouping. """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid + self._available_discrete_values = available_discrete_values @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -180,7 +197,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderAlreadyExistsFolderMoveErrorDetail): + if not isinstance(other, GsaSecurityAttributeGrouping): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection.py deleted file mode 100644 index 29411749..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection.py +++ /dev/null @@ -1,643 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSelection(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guids": "list[str]", - "constant_guids": "list[str]", - "cross_database_link_group_guids": "list[str]", - "discrete_type_guids": "list[str]", - "dynamic_link_group_guids": "list[str]", - "file_guids": "list[str]", - "layout_guids": "list[str]", - "parameter_guids": "list[str]", - "record_guids": "list[str]", - "record_linked_group_guids": "list[str]", - "replacement_string_guids": "list[str]", - "search_mask_guids": "list[str]", - "search_template_guids": "list[str]", - "standard_name_guids": "list[str]", - "subset_guids": "list[str]", - "table_guids": "list[str]", - "unit_guids": "list[str]", - "unit_system_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "attribute_guids": "attributeGuids", - "constant_guids": "constantGuids", - "cross_database_link_group_guids": "crossDatabaseLinkGroupGuids", - "discrete_type_guids": "discreteTypeGuids", - "dynamic_link_group_guids": "dynamicLinkGroupGuids", - "file_guids": "fileGuids", - "layout_guids": "layoutGuids", - "parameter_guids": "parameterGuids", - "record_guids": "recordGuids", - "record_linked_group_guids": "recordLinkedGroupGuids", - "replacement_string_guids": "replacementStringGuids", - "search_mask_guids": "searchMaskGuids", - "search_template_guids": "searchTemplateGuids", - "standard_name_guids": "standardNameGuids", - "subset_guids": "subsetGuids", - "table_guids": "tableGuids", - "unit_guids": "unitGuids", - "unit_system_guids": "unitSystemGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guids: "list[str] | None | Unset_Type" = Unset, - constant_guids: "list[str] | None | Unset_Type" = Unset, - cross_database_link_group_guids: "list[str] | None | Unset_Type" = Unset, - discrete_type_guids: "list[str] | None | Unset_Type" = Unset, - dynamic_link_group_guids: "list[str] | None | Unset_Type" = Unset, - file_guids: "list[str] | None | Unset_Type" = Unset, - layout_guids: "list[str] | None | Unset_Type" = Unset, - parameter_guids: "list[str] | None | Unset_Type" = Unset, - record_guids: "list[str] | None | Unset_Type" = Unset, - record_linked_group_guids: "list[str] | None | Unset_Type" = Unset, - replacement_string_guids: "list[str] | None | Unset_Type" = Unset, - search_mask_guids: "list[str] | None | Unset_Type" = Unset, - search_template_guids: "list[str] | None | Unset_Type" = Unset, - standard_name_guids: "list[str] | None | Unset_Type" = Unset, - subset_guids: "list[str] | None | Unset_Type" = Unset, - table_guids: "list[str] | None | Unset_Type" = Unset, - unit_guids: "list[str] | None | Unset_Type" = Unset, - unit_system_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaSelection - a model defined in Swagger - - Parameters - ---------- - attribute_guids: list[str] | None, optional - constant_guids: list[str] | None, optional - cross_database_link_group_guids: list[str] | None, optional - discrete_type_guids: list[str] | None, optional - dynamic_link_group_guids: list[str] | None, optional - file_guids: list[str] | None, optional - layout_guids: list[str] | None, optional - parameter_guids: list[str] | None, optional - record_guids: list[str] | None, optional - record_linked_group_guids: list[str] | None, optional - replacement_string_guids: list[str] | None, optional - search_mask_guids: list[str] | None, optional - search_template_guids: list[str] | None, optional - standard_name_guids: list[str] | None, optional - subset_guids: list[str] | None, optional - table_guids: list[str] | None, optional - unit_guids: list[str] | None, optional - unit_system_guids: list[str] | None, optional - """ - self._table_guids: list[str] | None | Unset_Type = Unset - self._attribute_guids: list[str] | None | Unset_Type = Unset - self._record_guids: list[str] | None | Unset_Type = Unset - self._discrete_type_guids: list[str] | None | Unset_Type = Unset - self._parameter_guids: list[str] | None | Unset_Type = Unset - self._layout_guids: list[str] | None | Unset_Type = Unset - self._subset_guids: list[str] | None | Unset_Type = Unset - self._standard_name_guids: list[str] | None | Unset_Type = Unset - self._record_linked_group_guids: list[str] | None | Unset_Type = Unset - self._unit_guids: list[str] | None | Unset_Type = Unset - self._replacement_string_guids: list[str] | None | Unset_Type = Unset - self._constant_guids: list[str] | None | Unset_Type = Unset - self._unit_system_guids: list[str] | None | Unset_Type = Unset - self._file_guids: list[str] | None | Unset_Type = Unset - self._search_mask_guids: list[str] | None | Unset_Type = Unset - self._search_template_guids: list[str] | None | Unset_Type = Unset - self._dynamic_link_group_guids: list[str] | None | Unset_Type = Unset - self._cross_database_link_group_guids: list[str] | None | Unset_Type = Unset - - if table_guids is not Unset: - self.table_guids = table_guids - if attribute_guids is not Unset: - self.attribute_guids = attribute_guids - if record_guids is not Unset: - self.record_guids = record_guids - if discrete_type_guids is not Unset: - self.discrete_type_guids = discrete_type_guids - if parameter_guids is not Unset: - self.parameter_guids = parameter_guids - if layout_guids is not Unset: - self.layout_guids = layout_guids - if subset_guids is not Unset: - self.subset_guids = subset_guids - if standard_name_guids is not Unset: - self.standard_name_guids = standard_name_guids - if record_linked_group_guids is not Unset: - self.record_linked_group_guids = record_linked_group_guids - if unit_guids is not Unset: - self.unit_guids = unit_guids - if replacement_string_guids is not Unset: - self.replacement_string_guids = replacement_string_guids - if constant_guids is not Unset: - self.constant_guids = constant_guids - if unit_system_guids is not Unset: - self.unit_system_guids = unit_system_guids - if file_guids is not Unset: - self.file_guids = file_guids - if search_mask_guids is not Unset: - self.search_mask_guids = search_mask_guids - if search_template_guids is not Unset: - self.search_template_guids = search_template_guids - if dynamic_link_group_guids is not Unset: - self.dynamic_link_group_guids = dynamic_link_group_guids - if cross_database_link_group_guids is not Unset: - self.cross_database_link_group_guids = cross_database_link_group_guids - - @property - def table_guids(self) -> "list[str] | None | Unset_Type": - """Gets the table_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The table_guids of this GsaSelection. - """ - return self._table_guids - - @table_guids.setter - def table_guids(self, table_guids: "list[str] | None | Unset_Type") -> None: - """Sets the table_guids of this GsaSelection. - - Parameters - ---------- - table_guids: list[str] | None | Unset_Type - The table_guids of this GsaSelection. - """ - self._table_guids = table_guids - - @property - def attribute_guids(self) -> "list[str] | None | Unset_Type": - """Gets the attribute_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The attribute_guids of this GsaSelection. - """ - return self._attribute_guids - - @attribute_guids.setter - def attribute_guids(self, attribute_guids: "list[str] | None | Unset_Type") -> None: - """Sets the attribute_guids of this GsaSelection. - - Parameters - ---------- - attribute_guids: list[str] | None | Unset_Type - The attribute_guids of this GsaSelection. - """ - self._attribute_guids = attribute_guids - - @property - def record_guids(self) -> "list[str] | None | Unset_Type": - """Gets the record_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The record_guids of this GsaSelection. - """ - return self._record_guids - - @record_guids.setter - def record_guids(self, record_guids: "list[str] | None | Unset_Type") -> None: - """Sets the record_guids of this GsaSelection. - - Parameters - ---------- - record_guids: list[str] | None | Unset_Type - The record_guids of this GsaSelection. - """ - self._record_guids = record_guids - - @property - def discrete_type_guids(self) -> "list[str] | None | Unset_Type": - """Gets the discrete_type_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The discrete_type_guids of this GsaSelection. - """ - return self._discrete_type_guids - - @discrete_type_guids.setter - def discrete_type_guids(self, discrete_type_guids: "list[str] | None | Unset_Type") -> None: - """Sets the discrete_type_guids of this GsaSelection. - - Parameters - ---------- - discrete_type_guids: list[str] | None | Unset_Type - The discrete_type_guids of this GsaSelection. - """ - self._discrete_type_guids = discrete_type_guids - - @property - def parameter_guids(self) -> "list[str] | None | Unset_Type": - """Gets the parameter_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The parameter_guids of this GsaSelection. - """ - return self._parameter_guids - - @parameter_guids.setter - def parameter_guids(self, parameter_guids: "list[str] | None | Unset_Type") -> None: - """Sets the parameter_guids of this GsaSelection. - - Parameters - ---------- - parameter_guids: list[str] | None | Unset_Type - The parameter_guids of this GsaSelection. - """ - self._parameter_guids = parameter_guids - - @property - def layout_guids(self) -> "list[str] | None | Unset_Type": - """Gets the layout_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The layout_guids of this GsaSelection. - """ - return self._layout_guids - - @layout_guids.setter - def layout_guids(self, layout_guids: "list[str] | None | Unset_Type") -> None: - """Sets the layout_guids of this GsaSelection. - - Parameters - ---------- - layout_guids: list[str] | None | Unset_Type - The layout_guids of this GsaSelection. - """ - self._layout_guids = layout_guids - - @property - def subset_guids(self) -> "list[str] | None | Unset_Type": - """Gets the subset_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The subset_guids of this GsaSelection. - """ - return self._subset_guids - - @subset_guids.setter - def subset_guids(self, subset_guids: "list[str] | None | Unset_Type") -> None: - """Sets the subset_guids of this GsaSelection. - - Parameters - ---------- - subset_guids: list[str] | None | Unset_Type - The subset_guids of this GsaSelection. - """ - self._subset_guids = subset_guids - - @property - def standard_name_guids(self) -> "list[str] | None | Unset_Type": - """Gets the standard_name_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The standard_name_guids of this GsaSelection. - """ - return self._standard_name_guids - - @standard_name_guids.setter - def standard_name_guids(self, standard_name_guids: "list[str] | None | Unset_Type") -> None: - """Sets the standard_name_guids of this GsaSelection. - - Parameters - ---------- - standard_name_guids: list[str] | None | Unset_Type - The standard_name_guids of this GsaSelection. - """ - self._standard_name_guids = standard_name_guids - - @property - def record_linked_group_guids(self) -> "list[str] | None | Unset_Type": - """Gets the record_linked_group_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The record_linked_group_guids of this GsaSelection. - """ - return self._record_linked_group_guids - - @record_linked_group_guids.setter - def record_linked_group_guids( - self, record_linked_group_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the record_linked_group_guids of this GsaSelection. - - Parameters - ---------- - record_linked_group_guids: list[str] | None | Unset_Type - The record_linked_group_guids of this GsaSelection. - """ - self._record_linked_group_guids = record_linked_group_guids - - @property - def unit_guids(self) -> "list[str] | None | Unset_Type": - """Gets the unit_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The unit_guids of this GsaSelection. - """ - return self._unit_guids - - @unit_guids.setter - def unit_guids(self, unit_guids: "list[str] | None | Unset_Type") -> None: - """Sets the unit_guids of this GsaSelection. - - Parameters - ---------- - unit_guids: list[str] | None | Unset_Type - The unit_guids of this GsaSelection. - """ - self._unit_guids = unit_guids - - @property - def replacement_string_guids(self) -> "list[str] | None | Unset_Type": - """Gets the replacement_string_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The replacement_string_guids of this GsaSelection. - """ - return self._replacement_string_guids - - @replacement_string_guids.setter - def replacement_string_guids( - self, replacement_string_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the replacement_string_guids of this GsaSelection. - - Parameters - ---------- - replacement_string_guids: list[str] | None | Unset_Type - The replacement_string_guids of this GsaSelection. - """ - self._replacement_string_guids = replacement_string_guids - - @property - def constant_guids(self) -> "list[str] | None | Unset_Type": - """Gets the constant_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The constant_guids of this GsaSelection. - """ - return self._constant_guids - - @constant_guids.setter - def constant_guids(self, constant_guids: "list[str] | None | Unset_Type") -> None: - """Sets the constant_guids of this GsaSelection. - - Parameters - ---------- - constant_guids: list[str] | None | Unset_Type - The constant_guids of this GsaSelection. - """ - self._constant_guids = constant_guids - - @property - def unit_system_guids(self) -> "list[str] | None | Unset_Type": - """Gets the unit_system_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The unit_system_guids of this GsaSelection. - """ - return self._unit_system_guids - - @unit_system_guids.setter - def unit_system_guids(self, unit_system_guids: "list[str] | None | Unset_Type") -> None: - """Sets the unit_system_guids of this GsaSelection. - - Parameters - ---------- - unit_system_guids: list[str] | None | Unset_Type - The unit_system_guids of this GsaSelection. - """ - self._unit_system_guids = unit_system_guids - - @property - def file_guids(self) -> "list[str] | None | Unset_Type": - """Gets the file_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The file_guids of this GsaSelection. - """ - return self._file_guids - - @file_guids.setter - def file_guids(self, file_guids: "list[str] | None | Unset_Type") -> None: - """Sets the file_guids of this GsaSelection. - - Parameters - ---------- - file_guids: list[str] | None | Unset_Type - The file_guids of this GsaSelection. - """ - self._file_guids = file_guids - - @property - def search_mask_guids(self) -> "list[str] | None | Unset_Type": - """Gets the search_mask_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The search_mask_guids of this GsaSelection. - """ - return self._search_mask_guids - - @search_mask_guids.setter - def search_mask_guids(self, search_mask_guids: "list[str] | None | Unset_Type") -> None: - """Sets the search_mask_guids of this GsaSelection. - - Parameters - ---------- - search_mask_guids: list[str] | None | Unset_Type - The search_mask_guids of this GsaSelection. - """ - self._search_mask_guids = search_mask_guids - - @property - def search_template_guids(self) -> "list[str] | None | Unset_Type": - """Gets the search_template_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The search_template_guids of this GsaSelection. - """ - return self._search_template_guids - - @search_template_guids.setter - def search_template_guids(self, search_template_guids: "list[str] | None | Unset_Type") -> None: - """Sets the search_template_guids of this GsaSelection. - - Parameters - ---------- - search_template_guids: list[str] | None | Unset_Type - The search_template_guids of this GsaSelection. - """ - self._search_template_guids = search_template_guids - - @property - def dynamic_link_group_guids(self) -> "list[str] | None | Unset_Type": - """Gets the dynamic_link_group_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The dynamic_link_group_guids of this GsaSelection. - """ - return self._dynamic_link_group_guids - - @dynamic_link_group_guids.setter - def dynamic_link_group_guids( - self, dynamic_link_group_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the dynamic_link_group_guids of this GsaSelection. - - Parameters - ---------- - dynamic_link_group_guids: list[str] | None | Unset_Type - The dynamic_link_group_guids of this GsaSelection. - """ - self._dynamic_link_group_guids = dynamic_link_group_guids - - @property - def cross_database_link_group_guids(self) -> "list[str] | None | Unset_Type": - """Gets the cross_database_link_group_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The cross_database_link_group_guids of this GsaSelection. - """ - return self._cross_database_link_group_guids - - @cross_database_link_group_guids.setter - def cross_database_link_group_guids( - self, cross_database_link_group_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_group_guids of this GsaSelection. - - Parameters - ---------- - cross_database_link_group_guids: list[str] | None | Unset_Type - The cross_database_link_group_guids of this GsaSelection. - """ - self._cross_database_link_group_guids = cross_database_link_group_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSelection): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection_search.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection_search.py new file mode 100644 index 00000000..e5da4ee7 --- /dev/null +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_selection_search.py @@ -0,0 +1,454 @@ +# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. +# SPDX-License-Identifier: MIT +# +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +""" +MI Server API + +No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + +OpenAPI spec version: v1 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import re # noqa: F401 +from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 + +from . import ModelBase, Unset, Unset_Type + +if TYPE_CHECKING: + from datetime import datetime + import pathlib + + from . import * + + +class GsaSelectionSearch(ModelBase): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes + ---------- + swagger_types: dict[str, str] + The key is attribute name and the value is attribute type. + attribute_map: dict[str, str] + The key is attribute name and the value is json key in definition. + subtype_mapping: dict[str, str] + The key is the unmangled property name and the value is the corresponding type. + discriminator: Optional[str] + Name of the property used as discriminator for subtypes. + """ + swagger_types: dict[str, str] = { + "created_timestamp": "datetime", + "created_user_or_group": "GsaUserOrGroup", + "criteria": "str", + "current_user_access_info": "dict(str, dict(str, bool))", + "description": "str", + "explore_config": "str", + "last_modified_timestamp": "datetime", + "last_modified_user_or_group": "GsaUserOrGroup", + "name": "str", + "notes": "str", + "search_identifier": "str", + } + + attribute_map: dict[str, str] = { + "created_timestamp": "createdTimestamp", + "created_user_or_group": "createdUserOrGroup", + "criteria": "criteria", + "current_user_access_info": "currentUserAccessInfo", + "description": "description", + "explore_config": "exploreConfig", + "last_modified_timestamp": "lastModifiedTimestamp", + "last_modified_user_or_group": "lastModifiedUserOrGroup", + "name": "name", + "notes": "notes", + "search_identifier": "searchIdentifier", + } + + subtype_mapping: dict[str, str] = { + "createdUserOrGroup": "GsaUserOrGroup", + "lastModifiedUserOrGroup": "GsaUserOrGroup", + } + + discriminator: Optional[str] = None + + def __init__( + self, + *, + created_timestamp: "datetime | Unset_Type" = Unset, + created_user_or_group: "GsaUserOrGroup | Unset_Type" = Unset, + criteria: "str | None | Unset_Type" = Unset, + current_user_access_info: "dict[str, dict[str, bool]] | None | Unset_Type" = Unset, + description: "str | None | Unset_Type" = Unset, + explore_config: "str | None | Unset_Type" = Unset, + last_modified_timestamp: "datetime | Unset_Type" = Unset, + last_modified_user_or_group: "GsaUserOrGroup | Unset_Type" = Unset, + name: "str | None | Unset_Type" = Unset, + notes: "str | None | Unset_Type" = Unset, + search_identifier: "str | Unset_Type" = Unset, + ) -> None: + """GsaSelectionSearch - a model defined in Swagger + + Parameters + ---------- + created_timestamp: datetime, optional + created_user_or_group: GsaUserOrGroup, optional + criteria: str | None, optional + current_user_access_info: dict[str, dict[str, bool]] | None, optional + description: str | None, optional + explore_config: str | None, optional + last_modified_timestamp: datetime, optional + last_modified_user_or_group: GsaUserOrGroup, optional + name: str | None, optional + notes: str | None, optional + search_identifier: str, optional + """ + self._search_identifier: str | Unset_Type = Unset + self._name: str | None | Unset_Type = Unset + self._description: str | None | Unset_Type = Unset + self._notes: str | None | Unset_Type = Unset + self._current_user_access_info: dict[str, dict[str, bool]] | None | Unset_Type = Unset + self._criteria: str | None | Unset_Type = Unset + self._explore_config: str | None | Unset_Type = Unset + self._created_timestamp: datetime | Unset_Type = Unset + self._created_user_or_group: GsaUserOrGroup | Unset_Type = Unset + self._last_modified_timestamp: datetime | Unset_Type = Unset + self._last_modified_user_or_group: GsaUserOrGroup | Unset_Type = Unset + + if search_identifier is not Unset: + self.search_identifier = search_identifier + if name is not Unset: + self.name = name + if description is not Unset: + self.description = description + if notes is not Unset: + self.notes = notes + if current_user_access_info is not Unset: + self.current_user_access_info = current_user_access_info + if criteria is not Unset: + self.criteria = criteria + if explore_config is not Unset: + self.explore_config = explore_config + if created_timestamp is not Unset: + self.created_timestamp = created_timestamp + if created_user_or_group is not Unset: + self.created_user_or_group = created_user_or_group + if last_modified_timestamp is not Unset: + self.last_modified_timestamp = last_modified_timestamp + if last_modified_user_or_group is not Unset: + self.last_modified_user_or_group = last_modified_user_or_group + + @property + def search_identifier(self) -> "str | Unset_Type": + """Gets the search_identifier of this GsaSelectionSearch. + + Returns + ------- + str | Unset_Type + The search_identifier of this GsaSelectionSearch. + """ + return self._search_identifier + + @search_identifier.setter + def search_identifier(self, search_identifier: "str | Unset_Type") -> None: + """Sets the search_identifier of this GsaSelectionSearch. + + Parameters + ---------- + search_identifier: str | Unset_Type + The search_identifier of this GsaSelectionSearch. + """ + # Field is not nullable + if search_identifier is None: + raise ValueError("Invalid value for 'search_identifier', must not be 'None'") + self._search_identifier = search_identifier + + @property + def name(self) -> "str | None | Unset_Type": + """Gets the name of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The name of this GsaSelectionSearch. + """ + return self._name + + @name.setter + def name(self, name: "str | None | Unset_Type") -> None: + """Sets the name of this GsaSelectionSearch. + + Parameters + ---------- + name: str | None | Unset_Type + The name of this GsaSelectionSearch. + """ + self._name = name + + @property + def description(self) -> "str | None | Unset_Type": + """Gets the description of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The description of this GsaSelectionSearch. + """ + return self._description + + @description.setter + def description(self, description: "str | None | Unset_Type") -> None: + """Sets the description of this GsaSelectionSearch. + + Parameters + ---------- + description: str | None | Unset_Type + The description of this GsaSelectionSearch. + """ + self._description = description + + @property + def notes(self) -> "str | None | Unset_Type": + """Gets the notes of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The notes of this GsaSelectionSearch. + """ + return self._notes + + @notes.setter + def notes(self, notes: "str | None | Unset_Type") -> None: + """Sets the notes of this GsaSelectionSearch. + + Parameters + ---------- + notes: str | None | Unset_Type + The notes of this GsaSelectionSearch. + """ + self._notes = notes + + @property + def current_user_access_info(self) -> "dict[str, dict[str, bool]] | None | Unset_Type": + """Gets the current_user_access_info of this GsaSelectionSearch. + + Returns + ------- + dict[str, dict[str, bool]] | None | Unset_Type + The current_user_access_info of this GsaSelectionSearch. + """ + return self._current_user_access_info + + @current_user_access_info.setter + def current_user_access_info( + self, current_user_access_info: "dict[str, dict[str, bool]] | None | Unset_Type" + ) -> None: + """Sets the current_user_access_info of this GsaSelectionSearch. + + Parameters + ---------- + current_user_access_info: dict[str, dict[str, bool]] | None | Unset_Type + The current_user_access_info of this GsaSelectionSearch. + """ + self._current_user_access_info = current_user_access_info + + @property + def criteria(self) -> "str | None | Unset_Type": + """Gets the criteria of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The criteria of this GsaSelectionSearch. + """ + return self._criteria + + @criteria.setter + def criteria(self, criteria: "str | None | Unset_Type") -> None: + """Sets the criteria of this GsaSelectionSearch. + + Parameters + ---------- + criteria: str | None | Unset_Type + The criteria of this GsaSelectionSearch. + """ + self._criteria = criteria + + @property + def explore_config(self) -> "str | None | Unset_Type": + """Gets the explore_config of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The explore_config of this GsaSelectionSearch. + """ + return self._explore_config + + @explore_config.setter + def explore_config(self, explore_config: "str | None | Unset_Type") -> None: + """Sets the explore_config of this GsaSelectionSearch. + + Parameters + ---------- + explore_config: str | None | Unset_Type + The explore_config of this GsaSelectionSearch. + """ + self._explore_config = explore_config + + @property + def created_timestamp(self) -> "datetime | Unset_Type": + """Gets the created_timestamp of this GsaSelectionSearch. + + Returns + ------- + datetime | Unset_Type + The created_timestamp of this GsaSelectionSearch. + """ + return self._created_timestamp + + @created_timestamp.setter + def created_timestamp(self, created_timestamp: "datetime | Unset_Type") -> None: + """Sets the created_timestamp of this GsaSelectionSearch. + + Parameters + ---------- + created_timestamp: datetime | Unset_Type + The created_timestamp of this GsaSelectionSearch. + """ + # Field is not nullable + if created_timestamp is None: + raise ValueError("Invalid value for 'created_timestamp', must not be 'None'") + self._created_timestamp = created_timestamp + + @property + def created_user_or_group(self) -> "GsaUserOrGroup | Unset_Type": + """Gets the created_user_or_group of this GsaSelectionSearch. + + Returns + ------- + GsaUserOrGroup | Unset_Type + The created_user_or_group of this GsaSelectionSearch. + """ + return self._created_user_or_group + + @created_user_or_group.setter + def created_user_or_group(self, created_user_or_group: "GsaUserOrGroup | Unset_Type") -> None: + """Sets the created_user_or_group of this GsaSelectionSearch. + + Parameters + ---------- + created_user_or_group: GsaUserOrGroup | Unset_Type + The created_user_or_group of this GsaSelectionSearch. + """ + # Field is not nullable + if created_user_or_group is None: + raise ValueError("Invalid value for 'created_user_or_group', must not be 'None'") + self._created_user_or_group = created_user_or_group + + @property + def last_modified_timestamp(self) -> "datetime | Unset_Type": + """Gets the last_modified_timestamp of this GsaSelectionSearch. + + Returns + ------- + datetime | Unset_Type + The last_modified_timestamp of this GsaSelectionSearch. + """ + return self._last_modified_timestamp + + @last_modified_timestamp.setter + def last_modified_timestamp(self, last_modified_timestamp: "datetime | Unset_Type") -> None: + """Sets the last_modified_timestamp of this GsaSelectionSearch. + + Parameters + ---------- + last_modified_timestamp: datetime | Unset_Type + The last_modified_timestamp of this GsaSelectionSearch. + """ + # Field is not nullable + if last_modified_timestamp is None: + raise ValueError("Invalid value for 'last_modified_timestamp', must not be 'None'") + self._last_modified_timestamp = last_modified_timestamp + + @property + def last_modified_user_or_group(self) -> "GsaUserOrGroup | Unset_Type": + """Gets the last_modified_user_or_group of this GsaSelectionSearch. + + Returns + ------- + GsaUserOrGroup | Unset_Type + The last_modified_user_or_group of this GsaSelectionSearch. + """ + return self._last_modified_user_or_group + + @last_modified_user_or_group.setter + def last_modified_user_or_group( + self, last_modified_user_or_group: "GsaUserOrGroup | Unset_Type" + ) -> None: + """Sets the last_modified_user_or_group of this GsaSelectionSearch. + + Parameters + ---------- + last_modified_user_or_group: GsaUserOrGroup | Unset_Type + The last_modified_user_or_group of this GsaSelectionSearch. + """ + # Field is not nullable + if last_modified_user_or_group is None: + raise ValueError("Invalid value for 'last_modified_user_or_group', must not be 'None'") + self._last_modified_user_or_group = last_modified_user_or_group + + @classmethod + def get_real_child_model(cls, data: dict[str, str]) -> str: + """Raises a NotImplementedError for a type without a discriminator defined. + + Parameters + ---------- + data: ModelBase + Object representing a subclass of this class + + Raises + ------ + NotImplementedError + This class has no discriminator, and hence no subclasses + """ + raise NotImplementedError() + + def __repr__(self) -> str: + """For 'print' and 'pprint'""" + return self.to_str() + + def __eq__(self, other: Any) -> bool: + """Returns true if both objects are equal""" + if not isinstance(other, GsaSelectionSearch): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other: Any) -> bool: + """Returns true if both objects are not equal""" + return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_range_datum.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_range_datum.py index 79c923e0..2c877d07 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_range_datum.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_range_datum.py @@ -65,22 +65,23 @@ class GsaSetRangeDatum(GsaSetDatum): """ swagger_types: dict[str, str] = { "estimated": "bool", + "high_value": "float", + "high_value_is_inclusive": "bool", + "low_value": "float", + "low_value_is_inclusive": "bool", "set_datum_type": "GsaSetDatumType", - "high_endpoint": "GsaRangeEndpoint", - "low_endpoint": "GsaRangeEndpoint", } attribute_map: dict[str, str] = { "estimated": "estimated", + "high_value": "highValue", + "high_value_is_inclusive": "highValueIsInclusive", + "low_value": "lowValue", + "low_value_is_inclusive": "lowValueIsInclusive", "set_datum_type": "setDatumType", - "high_endpoint": "highEndpoint", - "low_endpoint": "lowEndpoint", } - subtype_mapping: dict[str, str] = { - "lowEndpoint": "GsaRangeEndpoint", - "highEndpoint": "GsaRangeEndpoint", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -88,79 +89,147 @@ def __init__( self, *, estimated: "bool", + high_value: "float", + high_value_is_inclusive: "bool", + low_value: "float", + low_value_is_inclusive: "bool", set_datum_type: "GsaSetDatumType" = GsaSetDatumType.RANGE, - high_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, - low_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, ) -> None: """GsaSetRangeDatum - a model defined in Swagger Parameters ---------- estimated: bool + high_value: float + high_value_is_inclusive: bool + low_value: float + low_value_is_inclusive: bool set_datum_type: GsaSetDatumType - high_endpoint: GsaRangeEndpoint, optional - low_endpoint: GsaRangeEndpoint, optional """ super().__init__(set_datum_type=set_datum_type) - self._low_endpoint: GsaRangeEndpoint | Unset_Type = Unset - self._high_endpoint: GsaRangeEndpoint | Unset_Type = Unset + self._low_value: float + self._high_value: float + self._low_value_is_inclusive: bool + self._high_value_is_inclusive: bool self._estimated: bool - if low_endpoint is not Unset: - self.low_endpoint = low_endpoint - if high_endpoint is not Unset: - self.high_endpoint = high_endpoint + self.low_value = low_value + self.high_value = high_value + self.low_value_is_inclusive = low_value_is_inclusive + self.high_value_is_inclusive = high_value_is_inclusive self.estimated = estimated @property - def low_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the low_endpoint of this GsaSetRangeDatum. + def low_value(self) -> "float": + """Gets the low_value of this GsaSetRangeDatum. + + Returns + ------- + float + The low_value of this GsaSetRangeDatum. + """ + return self._low_value + + @low_value.setter + def low_value(self, low_value: "float") -> None: + """Sets the low_value of this GsaSetRangeDatum. + + Parameters + ---------- + low_value: float + The low_value of this GsaSetRangeDatum. + """ + # Field is not nullable + if low_value is None: + raise ValueError("Invalid value for 'low_value', must not be 'None'") + # Field is required + if low_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value', must not be 'Unset'") + self._low_value = low_value + + @property + def high_value(self) -> "float": + """Gets the high_value of this GsaSetRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaSetRangeDatum. + float + The high_value of this GsaSetRangeDatum. """ - return self._low_endpoint + return self._high_value - @low_endpoint.setter - def low_endpoint(self, low_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the low_endpoint of this GsaSetRangeDatum. + @high_value.setter + def high_value(self, high_value: "float") -> None: + """Sets the high_value of this GsaSetRangeDatum. Parameters ---------- - low_endpoint: GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaSetRangeDatum. + high_value: float + The high_value of this GsaSetRangeDatum. """ # Field is not nullable - if low_endpoint is None: - raise ValueError("Invalid value for 'low_endpoint', must not be 'None'") - self._low_endpoint = low_endpoint + if high_value is None: + raise ValueError("Invalid value for 'high_value', must not be 'None'") + # Field is required + if high_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value', must not be 'Unset'") + self._high_value = high_value @property - def high_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the high_endpoint of this GsaSetRangeDatum. + def low_value_is_inclusive(self) -> "bool": + """Gets the low_value_is_inclusive of this GsaSetRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaSetRangeDatum. + bool + The low_value_is_inclusive of this GsaSetRangeDatum. """ - return self._high_endpoint + return self._low_value_is_inclusive - @high_endpoint.setter - def high_endpoint(self, high_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the high_endpoint of this GsaSetRangeDatum. + @low_value_is_inclusive.setter + def low_value_is_inclusive(self, low_value_is_inclusive: "bool") -> None: + """Sets the low_value_is_inclusive of this GsaSetRangeDatum. Parameters ---------- - high_endpoint: GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaSetRangeDatum. + low_value_is_inclusive: bool + The low_value_is_inclusive of this GsaSetRangeDatum. """ # Field is not nullable - if high_endpoint is None: - raise ValueError("Invalid value for 'high_endpoint', must not be 'None'") - self._high_endpoint = high_endpoint + if low_value_is_inclusive is None: + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'None'") + # Field is required + if low_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'Unset'") + self._low_value_is_inclusive = low_value_is_inclusive + + @property + def high_value_is_inclusive(self) -> "bool": + """Gets the high_value_is_inclusive of this GsaSetRangeDatum. + + Returns + ------- + bool + The high_value_is_inclusive of this GsaSetRangeDatum. + """ + return self._high_value_is_inclusive + + @high_value_is_inclusive.setter + def high_value_is_inclusive(self, high_value_is_inclusive: "bool") -> None: + """Sets the high_value_is_inclusive of this GsaSetRangeDatum. + + Parameters + ---------- + high_value_is_inclusive: bool + The high_value_is_inclusive of this GsaSetRangeDatum. + """ + # Field is not nullable + if high_value_is_inclusive is None: + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'None'") + # Field is required + if high_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'Unset'") + self._high_value_is_inclusive = high_value_is_inclusive @property def estimated(self) -> "bool": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalent.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalent.py deleted file mode 100644 index 46bb7ffe..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalent.py +++ /dev/null @@ -1,215 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSetUnitEquivalent(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "equivalent_unit_guid": "str", - "unit_guid": "str", - "unit_system_guid": "str", - } - - attribute_map: dict[str, str] = { - "equivalent_unit_guid": "equivalentUnitGuid", - "unit_guid": "unitGuid", - "unit_system_guid": "unitSystemGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - equivalent_unit_guid: "str", - unit_guid: "str", - unit_system_guid: "str", - ) -> None: - """GsaSetUnitEquivalent - a model defined in Swagger - - Parameters - ---------- - equivalent_unit_guid: str - unit_guid: str - unit_system_guid: str - """ - self._unit_guid: str - self._unit_system_guid: str - self._equivalent_unit_guid: str - - self.unit_guid = unit_guid - self.unit_system_guid = unit_system_guid - self.equivalent_unit_guid = equivalent_unit_guid - - @property - def unit_guid(self) -> "str": - """Gets the unit_guid of this GsaSetUnitEquivalent. - - Returns - ------- - str - The unit_guid of this GsaSetUnitEquivalent. - """ - return self._unit_guid - - @unit_guid.setter - def unit_guid(self, unit_guid: "str") -> None: - """Sets the unit_guid of this GsaSetUnitEquivalent. - - Parameters - ---------- - unit_guid: str - The unit_guid of this GsaSetUnitEquivalent. - """ - # Field is not nullable - if unit_guid is None: - raise ValueError("Invalid value for 'unit_guid', must not be 'None'") - # Field is required - if unit_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unit_guid', must not be 'Unset'") - self._unit_guid = unit_guid - - @property - def unit_system_guid(self) -> "str": - """Gets the unit_system_guid of this GsaSetUnitEquivalent. - - Returns - ------- - str - The unit_system_guid of this GsaSetUnitEquivalent. - """ - return self._unit_system_guid - - @unit_system_guid.setter - def unit_system_guid(self, unit_system_guid: "str") -> None: - """Sets the unit_system_guid of this GsaSetUnitEquivalent. - - Parameters - ---------- - unit_system_guid: str - The unit_system_guid of this GsaSetUnitEquivalent. - """ - # Field is not nullable - if unit_system_guid is None: - raise ValueError("Invalid value for 'unit_system_guid', must not be 'None'") - # Field is required - if unit_system_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unit_system_guid', must not be 'Unset'") - self._unit_system_guid = unit_system_guid - - @property - def equivalent_unit_guid(self) -> "str": - """Gets the equivalent_unit_guid of this GsaSetUnitEquivalent. - - Returns - ------- - str - The equivalent_unit_guid of this GsaSetUnitEquivalent. - """ - return self._equivalent_unit_guid - - @equivalent_unit_guid.setter - def equivalent_unit_guid(self, equivalent_unit_guid: "str") -> None: - """Sets the equivalent_unit_guid of this GsaSetUnitEquivalent. - - Parameters - ---------- - equivalent_unit_guid: str - The equivalent_unit_guid of this GsaSetUnitEquivalent. - """ - # Field is not nullable - if equivalent_unit_guid is None: - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'None'") - # Field is required - if equivalent_unit_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'Unset'") - self._equivalent_unit_guid = equivalent_unit_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSetUnitEquivalent): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_exception.py deleted file mode 100644 index 16c7e1d1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSetUnitEquivalentsException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaUnitEquivalentErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitEquivalentErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSetUnitEquivalentsException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaUnitEquivalentErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaSetUnitEquivalentsException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaSetUnitEquivalentsException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaSetUnitEquivalentsException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaSetUnitEquivalentsException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaSetUnitEquivalentsException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaSetUnitEquivalentsException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaSetUnitEquivalentsException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaSetUnitEquivalentsException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaSetUnitEquivalentsException. - - Returns - ------- - list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaSetUnitEquivalentsException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaSetUnitEquivalentsException. - - Parameters - ---------- - errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaSetUnitEquivalentsException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSetUnitEquivalentsException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_info.py deleted file mode 100644 index b0562410..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_set_unit_equivalents_info.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSetUnitEquivalentsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "set_unit_equivalents": "list[GsaSetUnitEquivalent]", - } - - attribute_map: dict[str, str] = { - "set_unit_equivalents": "setUnitEquivalents", - } - - subtype_mapping: dict[str, str] = { - "setUnitEquivalents": "GsaSetUnitEquivalent", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - set_unit_equivalents: "list[GsaSetUnitEquivalent] | None | Unset_Type" = Unset, - ) -> None: - """GsaSetUnitEquivalentsInfo - a model defined in Swagger - - Parameters - ---------- - set_unit_equivalents: list[GsaSetUnitEquivalent] | None, optional - """ - self._set_unit_equivalents: list[GsaSetUnitEquivalent] | None | Unset_Type = Unset - - if set_unit_equivalents is not Unset: - self.set_unit_equivalents = set_unit_equivalents - - @property - def set_unit_equivalents(self) -> "list[GsaSetUnitEquivalent] | None | Unset_Type": - """Gets the set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - - Returns - ------- - list[GsaSetUnitEquivalent] | None | Unset_Type - The set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - """ - return self._set_unit_equivalents - - @set_unit_equivalents.setter - def set_unit_equivalents( - self, set_unit_equivalents: "list[GsaSetUnitEquivalent] | None | Unset_Type" - ) -> None: - """Sets the set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - - Parameters - ---------- - set_unit_equivalents: list[GsaSetUnitEquivalent] | None | Unset_Type - The set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - """ - self._set_unit_equivalents = set_unit_equivalents - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSetUnitEquivalentsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_short_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_short_text_attribute.py index 1813d809..c977fb41 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_short_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_short_text_attribute.py @@ -69,7 +69,6 @@ class GsaShortTextAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_unique": "bool", "name": "str", "table": "GsaSlimEntity", @@ -86,7 +85,6 @@ class GsaShortTextAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_unique": "isUnique", "name": "name", "table": "table", @@ -111,7 +109,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_unique: "bool", name: "str", table: "GsaSlimEntity", @@ -130,7 +127,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_unique: bool name: str table: GsaSlimEntity @@ -146,7 +142,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_setting.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_setting.py deleted file mode 100644 index ded3d08a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_setting.py +++ /dev/null @@ -1,218 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSimilaritySetting(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "weight": "float", - "weighting_type": "GsaWeightingType", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "weight": "weight", - "weighting_type": "weightingType", - } - - subtype_mapping: dict[str, str] = { - "attribute": "GsaSlimEntity", - "weightingType": "GsaWeightingType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - weight: "float", - weighting_type: "GsaWeightingType", - ) -> None: - """GsaSimilaritySetting - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - weight: float - weighting_type: GsaWeightingType - """ - self._attribute: GsaSlimEntity - self._weight: float - self._weighting_type: GsaWeightingType - - self.attribute = attribute - self.weight = weight - self.weighting_type = weighting_type - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaSimilaritySetting. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaSimilaritySetting. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaSimilaritySetting. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaSimilaritySetting. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @property - def weight(self) -> "float": - """Gets the weight of this GsaSimilaritySetting. - - Returns - ------- - float - The weight of this GsaSimilaritySetting. - """ - return self._weight - - @weight.setter - def weight(self, weight: "float") -> None: - """Sets the weight of this GsaSimilaritySetting. - - Parameters - ---------- - weight: float - The weight of this GsaSimilaritySetting. - """ - # Field is not nullable - if weight is None: - raise ValueError("Invalid value for 'weight', must not be 'None'") - # Field is required - if weight is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'weight', must not be 'Unset'") - self._weight = weight - - @property - def weighting_type(self) -> "GsaWeightingType": - """Gets the weighting_type of this GsaSimilaritySetting. - - Returns - ------- - GsaWeightingType - The weighting_type of this GsaSimilaritySetting. - """ - return self._weighting_type - - @weighting_type.setter - def weighting_type(self, weighting_type: "GsaWeightingType") -> None: - """Sets the weighting_type of this GsaSimilaritySetting. - - Parameters - ---------- - weighting_type: GsaWeightingType - The weighting_type of this GsaSimilaritySetting. - """ - # Field is not nullable - if weighting_type is None: - raise ValueError("Invalid value for 'weighting_type', must not be 'None'") - # Field is required - if weighting_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'weighting_type', must not be 'Unset'") - self._weighting_type = weighting_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSimilaritySetting): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_settings.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_settings.py deleted file mode 100644 index b4ec2107..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_settings.py +++ /dev/null @@ -1,276 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSimilaritySettings(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "settings": "list[GsaSimilaritySetting]", - "include_missing_data": "bool", - "is_default": "bool", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "settings": "settings", - "include_missing_data": "includeMissingData", - "is_default": "isDefault", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = { - "settings": "GsaSimilaritySetting", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - settings: "list[GsaSimilaritySetting]", - include_missing_data: "bool | Unset_Type" = Unset, - is_default: "bool | Unset_Type" = Unset, - table_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSimilaritySettings - a model defined in Swagger - - Parameters - ---------- - name: str - settings: list[GsaSimilaritySetting] - include_missing_data: bool, optional - is_default: bool, optional - table_guid: str | None, optional - """ - self._table_guid: str | None | Unset_Type = Unset - self._include_missing_data: bool | Unset_Type = Unset - self._is_default: bool | Unset_Type = Unset - self._name: str - self._settings: list[GsaSimilaritySetting] - - if table_guid is not Unset: - self.table_guid = table_guid - if include_missing_data is not Unset: - self.include_missing_data = include_missing_data - if is_default is not Unset: - self.is_default = is_default - self.name = name - self.settings = settings - - @property - def table_guid(self) -> "str | None | Unset_Type": - """Gets the table_guid of this GsaSimilaritySettings. - - Returns - ------- - str | None | Unset_Type - The table_guid of this GsaSimilaritySettings. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | None | Unset_Type") -> None: - """Sets the table_guid of this GsaSimilaritySettings. - - Parameters - ---------- - table_guid: str | None | Unset_Type - The table_guid of this GsaSimilaritySettings. - """ - self._table_guid = table_guid - - @property - def include_missing_data(self) -> "bool | Unset_Type": - """Gets the include_missing_data of this GsaSimilaritySettings. - - Returns - ------- - bool | Unset_Type - The include_missing_data of this GsaSimilaritySettings. - """ - return self._include_missing_data - - @include_missing_data.setter - def include_missing_data(self, include_missing_data: "bool | Unset_Type") -> None: - """Sets the include_missing_data of this GsaSimilaritySettings. - - Parameters - ---------- - include_missing_data: bool | Unset_Type - The include_missing_data of this GsaSimilaritySettings. - """ - # Field is not nullable - if include_missing_data is None: - raise ValueError("Invalid value for 'include_missing_data', must not be 'None'") - self._include_missing_data = include_missing_data - - @property - def is_default(self) -> "bool | Unset_Type": - """Gets the is_default of this GsaSimilaritySettings. - - Returns - ------- - bool | Unset_Type - The is_default of this GsaSimilaritySettings. - """ - return self._is_default - - @is_default.setter - def is_default(self, is_default: "bool | Unset_Type") -> None: - """Sets the is_default of this GsaSimilaritySettings. - - Parameters - ---------- - is_default: bool | Unset_Type - The is_default of this GsaSimilaritySettings. - """ - # Field is not nullable - if is_default is None: - raise ValueError("Invalid value for 'is_default', must not be 'None'") - self._is_default = is_default - - @property - def name(self) -> "str": - """Gets the name of this GsaSimilaritySettings. - - Returns - ------- - str - The name of this GsaSimilaritySettings. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSimilaritySettings. - - Parameters - ---------- - name: str - The name of this GsaSimilaritySettings. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def settings(self) -> "list[GsaSimilaritySetting]": - """Gets the settings of this GsaSimilaritySettings. - - Returns - ------- - list[GsaSimilaritySetting] - The settings of this GsaSimilaritySettings. - """ - return self._settings - - @settings.setter - def settings(self, settings: "list[GsaSimilaritySetting]") -> None: - """Sets the settings of this GsaSimilaritySettings. - - Parameters - ---------- - settings: list[GsaSimilaritySetting] - The settings of this GsaSimilaritySettings. - """ - # Field is not nullable - if settings is None: - raise ValueError("Invalid value for 'settings', must not be 'None'") - # Field is required - if settings is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'settings', must not be 'Unset'") - self._settings = settings - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSimilaritySettings): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_sort_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_sort_criterion.py deleted file mode 100644 index 6dc60408..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_similarity_sort_criterion.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_sort_criterion import ( # noqa: F401 - GsaSortCriterion, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_sort_criterion_type import ( - GsaSortCriterionType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSimilaritySortCriterion(GsaSortCriterion): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaSortCriterionType", - "sort_direction": "GsaSortDirection", - } - - attribute_map: dict[str, str] = { - "type": "type", - "sort_direction": "sortDirection", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaSortCriterionType" = GsaSortCriterionType.SIMILARITY, - sort_direction: "GsaSortDirection | Unset_Type" = Unset, - ) -> None: - """GsaSimilaritySortCriterion - a model defined in Swagger - - Parameters - ---------- - type: GsaSortCriterionType - sort_direction: GsaSortDirection, optional - """ - super().__init__(type=type, sort_direction=sort_direction) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSimilaritySortCriterion): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_access_control_info.py deleted file mode 100644 index 2935676f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_access_control_info.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSlimAccessControlInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - "user_capabilities": "GsaAccessControlUserCapabilities", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - "user_capabilities": "userCapabilities", - } - - subtype_mapping: dict[str, str] = { - "mode": "GsaAccessControlMode", - "userCapabilities": "GsaAccessControlUserCapabilities", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode", - user_capabilities: "GsaAccessControlUserCapabilities", - ) -> None: - """GsaSlimAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - user_capabilities: GsaAccessControlUserCapabilities - """ - self._mode: GsaAccessControlMode - self._user_capabilities: GsaAccessControlUserCapabilities - - self.mode = mode - self.user_capabilities = user_capabilities - - @property - def mode(self) -> "GsaAccessControlMode": - """Gets the mode of this GsaSlimAccessControlInfo. - - Returns - ------- - GsaAccessControlMode - The mode of this GsaSlimAccessControlInfo. - """ - return self._mode - - @mode.setter - def mode(self, mode: "GsaAccessControlMode") -> None: - """Sets the mode of this GsaSlimAccessControlInfo. - - Parameters - ---------- - mode: GsaAccessControlMode - The mode of this GsaSlimAccessControlInfo. - """ - # Field is not nullable - if mode is None: - raise ValueError("Invalid value for 'mode', must not be 'None'") - # Field is required - if mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'mode', must not be 'Unset'") - self._mode = mode - - @property - def user_capabilities(self) -> "GsaAccessControlUserCapabilities": - """Gets the user_capabilities of this GsaSlimAccessControlInfo. - - Returns - ------- - GsaAccessControlUserCapabilities - The user_capabilities of this GsaSlimAccessControlInfo. - """ - return self._user_capabilities - - @user_capabilities.setter - def user_capabilities(self, user_capabilities: "GsaAccessControlUserCapabilities") -> None: - """Sets the user_capabilities of this GsaSlimAccessControlInfo. - - Parameters - ---------- - user_capabilities: GsaAccessControlUserCapabilities - The user_capabilities of this GsaSlimAccessControlInfo. - """ - # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") - # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute.py index 713fb864..3c389fc5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute.py @@ -64,7 +64,6 @@ class GsaSlimAttribute(ModelBase): "display_names": "dict(str, str)", "guid": "str", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -75,7 +74,6 @@ class GsaSlimAttribute(ModelBase): "display_names": "displayNames", "guid": "guid", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -96,7 +94,6 @@ def __init__( display_names: "dict[str, str]", guid: "str", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType", @@ -109,7 +106,6 @@ def __init__( display_names: dict[str, str] guid: str is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -118,7 +114,6 @@ def __init__( self._type: GsaAttributeType self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset self._is_hidden_from_search_criteria: bool - self._is_protected: bool self._table: GsaSlimEntity self._display_names: dict[str, str] self._name: str @@ -128,7 +123,6 @@ def __init__( if about_attribute is not Unset: self.about_attribute = about_attribute self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - self.is_protected = is_protected self.table = table self.display_names = display_names self.name = name @@ -221,36 +215,6 @@ def is_hidden_from_search_criteria(self, is_hidden_from_search_criteria: "bool") ) self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaSlimAttribute. - If true, the attribute is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaSlimAttribute. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaSlimAttribute. - If true, the attribute is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaSlimAttribute. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def table(self) -> "GsaSlimEntity": """Gets the table of this GsaSlimAttribute. @@ -282,7 +246,6 @@ def table(self, table: "GsaSlimEntity") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -294,7 +257,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute_with_help_path.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute_with_help_path.py deleted file mode 100644 index a6328710..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_attribute_with_help_path.py +++ /dev/null @@ -1,426 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSlimAttributeWithHelpPath(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", - "name": "str", - "table": "GsaSlimEntity", - "type": "GsaAttributeType", - "about_attribute": "GsaSlimTypedAttribute", - "help_path": "str", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", - "name": "name", - "table": "table", - "type": "type", - "about_attribute": "aboutAttribute", - "help_path": "helpPath", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaAttributeType", - "aboutAttribute": "GsaSlimTypedAttribute", - "table": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - is_hidden_from_search_criteria: "bool", - is_protected: "bool", - name: "str", - table: "GsaSlimEntity", - type: "GsaAttributeType", - about_attribute: "GsaSlimTypedAttribute | Unset_Type" = Unset, - help_path: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSlimAttributeWithHelpPath - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - is_hidden_from_search_criteria: bool - is_protected: bool - name: str - table: GsaSlimEntity - type: GsaAttributeType - about_attribute: GsaSlimTypedAttribute, optional - help_path: str | None, optional - """ - self._help_path: str | None | Unset_Type = Unset - self._type: GsaAttributeType - self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset - self._is_hidden_from_search_criteria: bool - self._is_protected: bool - self._table: GsaSlimEntity - self._display_names: dict[str, str] - self._name: str - self._guid: str - - if help_path is not Unset: - self.help_path = help_path - self.type = type - if about_attribute is not Unset: - self.about_attribute = about_attribute - self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - self.is_protected = is_protected - self.table = table - self.display_names = display_names - self.name = name - self.guid = guid - - @property - def help_path(self) -> "str | None | Unset_Type": - """Gets the help_path of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - str | None | Unset_Type - The help_path of this GsaSlimAttributeWithHelpPath. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "str | None | Unset_Type") -> None: - """Sets the help_path of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - help_path: str | None | Unset_Type - The help_path of this GsaSlimAttributeWithHelpPath. - """ - self._help_path = help_path - - @property - def type(self) -> "GsaAttributeType": - """Gets the type of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - GsaAttributeType - The type of this GsaSlimAttributeWithHelpPath. - """ - return self._type - - @type.setter - def type(self, type: "GsaAttributeType") -> None: - """Sets the type of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - type: GsaAttributeType - The type of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def about_attribute(self) -> "GsaSlimTypedAttribute | Unset_Type": - """Gets the about_attribute of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaSlimAttributeWithHelpPath. - """ - return self._about_attribute - - @about_attribute.setter - def about_attribute(self, about_attribute: "GsaSlimTypedAttribute | Unset_Type") -> None: - """Sets the about_attribute of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - about_attribute: GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if about_attribute is None: - raise ValueError("Invalid value for 'about_attribute', must not be 'None'") - self._about_attribute = about_attribute - - @property - def is_hidden_from_search_criteria(self) -> "bool": - """Gets the is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - If true, the attribute should not be shown in search UIs. It will still be included in text searches. - - Returns - ------- - bool - The is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - """ - return self._is_hidden_from_search_criteria - - @is_hidden_from_search_criteria.setter - def is_hidden_from_search_criteria(self, is_hidden_from_search_criteria: "bool") -> None: - """Sets the is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - If true, the attribute should not be shown in search UIs. It will still be included in text searches. - - Parameters - ---------- - is_hidden_from_search_criteria: bool - The is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if is_hidden_from_search_criteria is None: - raise ValueError( - "Invalid value for 'is_hidden_from_search_criteria', must not be 'None'" - ) - # Field is required - if is_hidden_from_search_criteria is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'is_hidden_from_search_criteria', must not be 'Unset'" - ) - self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaSlimAttributeWithHelpPath. - If true, the attribute is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaSlimAttributeWithHelpPath. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaSlimAttributeWithHelpPath. - If true, the attribute is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - GsaSlimEntity - The table of this GsaSlimAttributeWithHelpPath. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimAttributeWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaSlimAttributeWithHelpPath. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimAttributeWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def name(self) -> "str": - """Gets the name of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - str - The name of this GsaSlimAttributeWithHelpPath. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - name: str - The name of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - str - The guid of this GsaSlimAttributeWithHelpPath. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - guid: str - The guid of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimAttributeWithHelpPath): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_quality_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_constant.py similarity index 81% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_quality_discrete_value.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_constant.py index 38bad374..22bf43ba 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_quality_discrete_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_constant.py @@ -42,7 +42,7 @@ from . import * -class GsaCreateQualityDiscreteValue(ModelBase): +class GsaSlimConstant(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,13 +61,13 @@ class GsaCreateQualityDiscreteValue(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "name": "str", "guid": "str", + "name": "str", } attribute_map: dict[str, str] = { - "name": "name", "guid": "guid", + "name": "name", } subtype_mapping: dict[str, str] = {} @@ -77,42 +77,41 @@ class GsaCreateQualityDiscreteValue(ModelBase): def __init__( self, *, + guid: "str", name: "str", - guid: "str | Unset_Type" = Unset, ) -> None: - """GsaCreateQualityDiscreteValue - a model defined in Swagger + """GsaSlimConstant - a model defined in Swagger Parameters ---------- + guid: str name: str - guid: str, optional """ self._name: str - self._guid: str | Unset_Type = Unset + self._guid: str self.name = name - if guid is not Unset: - self.guid = guid + self.guid = guid @property def name(self) -> "str": - """Gets the name of this GsaCreateQualityDiscreteValue. + """Gets the name of this GsaSlimConstant. Returns ------- str - The name of this GsaCreateQualityDiscreteValue. + The name of this GsaSlimConstant. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaCreateQualityDiscreteValue. + """Sets the name of this GsaSlimConstant. Parameters ---------- name: str - The name of this GsaCreateQualityDiscreteValue. + The name of this GsaSlimConstant. """ # Field is not nullable if name is None: @@ -123,28 +122,31 @@ def name(self, name: "str") -> None: self._name = name @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreateQualityDiscreteValue. + def guid(self) -> "str": + """Gets the guid of this GsaSlimConstant. Returns ------- - str | Unset_Type - The guid of this GsaCreateQualityDiscreteValue. + str + The guid of this GsaSlimConstant. """ return self._guid @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreateQualityDiscreteValue. + def guid(self, guid: "str") -> None: + """Sets the guid of this GsaSlimConstant. Parameters ---------- - guid: str | Unset_Type - The guid of this GsaCreateQualityDiscreteValue. + guid: str + The guid of this GsaSlimConstant. """ # Field is not nullable if guid is None: raise ValueError("Invalid value for 'guid', must not be 'None'") + # Field is required + if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'guid', must not be 'Unset'") self._guid = guid @classmethod @@ -169,7 +171,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateQualityDiscreteValue): + if not isinstance(other, GsaSlimConstant): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database.py index b88d5249..75e54985 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database.py @@ -65,13 +65,10 @@ class GsaSlimDatabase(ModelBase): "is_read_only": "bool", "key": "str", "status": "GsaDatabaseStatus", - "user_capabilities": "GsaDatabaseUserCapabilities", - "configuration_details": "GsaConfigurationDetails", "guid": "str", "index_in_sync": "bool", "index_out_of_date_duration": "str", "index_up_to_date": "bool", - "issues": "GsaDatabaseIssues", "name": "str", "schema_version": "str", "version_guid": "str", @@ -82,13 +79,10 @@ class GsaSlimDatabase(ModelBase): "is_read_only": "isReadOnly", "key": "key", "status": "status", - "user_capabilities": "userCapabilities", - "configuration_details": "configurationDetails", "guid": "guid", "index_in_sync": "indexInSync", "index_out_of_date_duration": "indexOutOfDateDuration", "index_up_to_date": "indexUpToDate", - "issues": "issues", "name": "name", "schema_version": "schemaVersion", "version_guid": "versionGuid", @@ -96,9 +90,6 @@ class GsaSlimDatabase(ModelBase): subtype_mapping: dict[str, str] = { "status": "GsaDatabaseStatus", - "userCapabilities": "GsaDatabaseUserCapabilities", - "configurationDetails": "GsaConfigurationDetails", - "issues": "GsaDatabaseIssues", } discriminator: Optional[str] = None @@ -110,13 +101,10 @@ def __init__( is_read_only: "bool", key: "str", status: "GsaDatabaseStatus", - user_capabilities: "GsaDatabaseUserCapabilities", - configuration_details: "GsaConfigurationDetails | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, index_in_sync: "bool | None | Unset_Type" = Unset, index_out_of_date_duration: "str | None | Unset_Type" = Unset, index_up_to_date: "bool | None | Unset_Type" = Unset, - issues: "GsaDatabaseIssues | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, schema_version: "str | None | Unset_Type" = Unset, version_guid: "str | None | Unset_Type" = Unset, @@ -129,13 +117,10 @@ def __init__( is_read_only: bool key: str status: GsaDatabaseStatus - user_capabilities: GsaDatabaseUserCapabilities - configuration_details: GsaConfigurationDetails, optional guid: str | None, optional index_in_sync: bool | None, optional index_out_of_date_duration: str | None, optional index_up_to_date: bool | None, optional - issues: GsaDatabaseIssues, optional name: str | None, optional schema_version: str | None, optional version_guid: str | None, optional @@ -151,9 +136,6 @@ def __init__( self._index_up_to_date: bool | None | Unset_Type = Unset self._index_out_of_date_duration: str | None | Unset_Type = Unset self._schema_version: str | None | Unset_Type = Unset - self._user_capabilities: GsaDatabaseUserCapabilities - self._configuration_details: GsaConfigurationDetails | Unset_Type = Unset - self._issues: GsaDatabaseIssues | Unset_Type = Unset self.key = key self.status = status @@ -173,11 +155,6 @@ def __init__( self.index_out_of_date_duration = index_out_of_date_duration if schema_version is not Unset: self.schema_version = schema_version - self.user_capabilities = user_capabilities - if configuration_details is not Unset: - self.configuration_details = configuration_details - if issues is not Unset: - self.issues = issues @property def key(self) -> "str": @@ -447,86 +424,6 @@ def schema_version(self, schema_version: "str | None | Unset_Type") -> None: """ self._schema_version = schema_version - @property - def user_capabilities(self) -> "GsaDatabaseUserCapabilities": - """Gets the user_capabilities of this GsaSlimDatabase. - - Returns - ------- - GsaDatabaseUserCapabilities - The user_capabilities of this GsaSlimDatabase. - """ - return self._user_capabilities - - @user_capabilities.setter - def user_capabilities(self, user_capabilities: "GsaDatabaseUserCapabilities") -> None: - """Sets the user_capabilities of this GsaSlimDatabase. - - Parameters - ---------- - user_capabilities: GsaDatabaseUserCapabilities - The user_capabilities of this GsaSlimDatabase. - """ - # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") - # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities - - @property - def configuration_details(self) -> "GsaConfigurationDetails | Unset_Type": - """Gets the configuration_details of this GsaSlimDatabase. - - Returns - ------- - GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaSlimDatabase. - """ - return self._configuration_details - - @configuration_details.setter - def configuration_details( - self, configuration_details: "GsaConfigurationDetails | Unset_Type" - ) -> None: - """Sets the configuration_details of this GsaSlimDatabase. - - Parameters - ---------- - configuration_details: GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaSlimDatabase. - """ - # Field is not nullable - if configuration_details is None: - raise ValueError("Invalid value for 'configuration_details', must not be 'None'") - self._configuration_details = configuration_details - - @property - def issues(self) -> "GsaDatabaseIssues | Unset_Type": - """Gets the issues of this GsaSlimDatabase. - - Returns - ------- - GsaDatabaseIssues | Unset_Type - The issues of this GsaSlimDatabase. - """ - return self._issues - - @issues.setter - def issues(self, issues: "GsaDatabaseIssues | Unset_Type") -> None: - """Sets the issues of this GsaSlimDatabase. - - Parameters - ---------- - issues: GsaDatabaseIssues | Unset_Type - The issues of this GsaSlimDatabase. - """ - # Field is not nullable - if issues is None: - raise ValueError("Invalid value for 'issues', must not be 'None'") - self._issues = issues - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database_access_control_info.py deleted file mode 100644 index da695569..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_database_access_control_info.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSlimDatabaseAccessControlInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "user_capabilities": "GsaAccessControlDatabaseUserCapabilities", - } - - attribute_map: dict[str, str] = { - "user_capabilities": "userCapabilities", - } - - subtype_mapping: dict[str, str] = { - "userCapabilities": "GsaAccessControlDatabaseUserCapabilities", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - user_capabilities: "GsaAccessControlDatabaseUserCapabilities", - ) -> None: - """GsaSlimDatabaseAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - user_capabilities: GsaAccessControlDatabaseUserCapabilities - """ - self._user_capabilities: GsaAccessControlDatabaseUserCapabilities - - self.user_capabilities = user_capabilities - - @property - def user_capabilities(self) -> "GsaAccessControlDatabaseUserCapabilities": - """Gets the user_capabilities of this GsaSlimDatabaseAccessControlInfo. - - Returns - ------- - GsaAccessControlDatabaseUserCapabilities - The user_capabilities of this GsaSlimDatabaseAccessControlInfo. - """ - return self._user_capabilities - - @user_capabilities.setter - def user_capabilities( - self, user_capabilities: "GsaAccessControlDatabaseUserCapabilities" - ) -> None: - """Sets the user_capabilities of this GsaSlimDatabaseAccessControlInfo. - - Parameters - ---------- - user_capabilities: GsaAccessControlDatabaseUserCapabilities - The user_capabilities of this GsaSlimDatabaseAccessControlInfo. - """ - # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") - # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimDatabaseAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_discrete_type.py index b60931f2..08ef248c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_discrete_type.py @@ -63,14 +63,12 @@ class GsaSlimDiscreteType(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "is_ordered": "bool", - "is_protected": "bool", "name": "str", } attribute_map: dict[str, str] = { "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -83,7 +81,6 @@ def __init__( *, guid: "str", is_ordered: "bool", - is_protected: "bool", name: "str", ) -> None: """GsaSlimDiscreteType - a model defined in Swagger @@ -92,16 +89,13 @@ def __init__( ---------- guid: str is_ordered: bool - is_protected: bool name: str """ self._is_ordered: bool - self._is_protected: bool self._name: str self._guid: str self.is_ordered = is_ordered - self.is_protected = is_protected self.name = name self.guid = guid @@ -133,36 +127,6 @@ def is_ordered(self, is_ordered: "bool") -> None: raise ValueError("Invalid value for 'is_ordered', must not be 'Unset'") self._is_ordered = is_ordered - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaSlimDiscreteType. - If true, the discrete type is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaSlimDiscreteType. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaSlimDiscreteType. - If true, the discrete type is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaSlimDiscreteType. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def name(self) -> "str": """Gets the name of this GsaSlimDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_expression.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_expression.py index a5842cba..81c8ef84 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_expression.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_expression.py @@ -63,18 +63,14 @@ class GsaSlimExpression(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "table": "GsaSlimEntity", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "table": "table", } - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -83,7 +79,6 @@ def __init__( *, guid: "str", name: "str", - table: "GsaSlimEntity", ) -> None: """GsaSlimExpression - a model defined in Swagger @@ -91,44 +86,13 @@ def __init__( ---------- guid: str name: str - table: GsaSlimEntity """ - self._table: GsaSlimEntity self._name: str self._guid: str - self.table = table self.name = name self.guid = guid - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSlimExpression. - - Returns - ------- - GsaSlimEntity - The table of this GsaSlimExpression. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSlimExpression. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaSlimExpression. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - @property def name(self) -> "str": """Gets the name of this GsaSlimExpression. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_layout.py index 1181f252..995f3ffb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_layout.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_layout.py @@ -102,7 +102,6 @@ def __init__( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -114,7 +113,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_search_template.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_named_unit.py similarity index 68% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_search_template.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_named_unit.py index 935d403c..e7e0c2da 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_search_template.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_named_unit.py @@ -42,7 +42,7 @@ from . import * -class GsaSlimSearchTemplate(ModelBase): +class GsaSlimNamedUnit(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -63,20 +63,18 @@ class GsaSlimSearchTemplate(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "table": "GsaSlimEntity", - "description": "str", + "symbol": "str", + "relative_symbol": "str", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "table": "table", - "description": "description", + "symbol": "symbol", + "relative_symbol": "relativeSymbol", } - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -85,126 +83,126 @@ def __init__( *, guid: "str", name: "str", - table: "GsaSlimEntity", - description: "str | None | Unset_Type" = Unset, + symbol: "str", + relative_symbol: "str | None | Unset_Type" = Unset, ) -> None: - """GsaSlimSearchTemplate - a model defined in Swagger + """GsaSlimNamedUnit - a model defined in Swagger Parameters ---------- guid: str name: str - table: GsaSlimEntity - description: str | None, optional + symbol: str + relative_symbol: str | None, optional """ - self._description: str | None | Unset_Type = Unset - self._table: GsaSlimEntity self._name: str + self._symbol: str + self._relative_symbol: str | None | Unset_Type = Unset self._guid: str - if description is not Unset: - self.description = description - self.table = table self.name = name + self.symbol = symbol + if relative_symbol is not Unset: + self.relative_symbol = relative_symbol self.guid = guid @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSlimSearchTemplate. + def name(self) -> "str": + """Gets the name of this GsaSlimNamedUnit. Returns ------- - str | None | Unset_Type - The description of this GsaSlimSearchTemplate. + str + The name of this GsaSlimNamedUnit. """ - return self._description + return self._name - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSlimSearchTemplate. + @name.setter + def name(self, name: "str") -> None: + """Sets the name of this GsaSlimNamedUnit. Parameters ---------- - description: str | None | Unset_Type - The description of this GsaSlimSearchTemplate. + name: str + The name of this GsaSlimNamedUnit. """ - self._description = description + # Field is not nullable + if name is None: + raise ValueError("Invalid value for 'name', must not be 'None'") + # Field is required + if name is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'name', must not be 'Unset'") + self._name = name @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSlimSearchTemplate. + def symbol(self) -> "str": + """Gets the symbol of this GsaSlimNamedUnit. Returns ------- - GsaSlimEntity - The table of this GsaSlimSearchTemplate. + str + The symbol of this GsaSlimNamedUnit. """ - return self._table + return self._symbol - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSlimSearchTemplate. + @symbol.setter + def symbol(self, symbol: "str") -> None: + """Sets the symbol of this GsaSlimNamedUnit. Parameters ---------- - table: GsaSlimEntity - The table of this GsaSlimSearchTemplate. + symbol: str + The symbol of this GsaSlimNamedUnit. """ # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") + if symbol is None: + raise ValueError("Invalid value for 'symbol', must not be 'None'") # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table + if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'symbol', must not be 'Unset'") + self._symbol = symbol @property - def name(self) -> "str": - """Gets the name of this GsaSlimSearchTemplate. + def relative_symbol(self) -> "str | None | Unset_Type": + """Gets the relative_symbol of this GsaSlimNamedUnit. Returns ------- - str - The name of this GsaSlimSearchTemplate. + str | None | Unset_Type + The relative_symbol of this GsaSlimNamedUnit. """ - return self._name + return self._relative_symbol - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSlimSearchTemplate. + @relative_symbol.setter + def relative_symbol(self, relative_symbol: "str | None | Unset_Type") -> None: + """Sets the relative_symbol of this GsaSlimNamedUnit. Parameters ---------- - name: str - The name of this GsaSlimSearchTemplate. + relative_symbol: str | None | Unset_Type + The relative_symbol of this GsaSlimNamedUnit. """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name + self._relative_symbol = relative_symbol @property def guid(self) -> "str": - """Gets the guid of this GsaSlimSearchTemplate. + """Gets the guid of this GsaSlimNamedUnit. Returns ------- str - The guid of this GsaSlimSearchTemplate. + The guid of this GsaSlimNamedUnit. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimSearchTemplate. + """Sets the guid of this GsaSlimNamedUnit. Parameters ---------- guid: str - The guid of this GsaSlimSearchTemplate. + The guid of this GsaSlimNamedUnit. """ # Field is not nullable if guid is None: @@ -236,7 +234,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimSearchTemplate): + if not isinstance(other, GsaSlimNamedUnit): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter.py index 5d9985c3..ad5bbdee 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter.py @@ -138,7 +138,6 @@ def type(self, type: "GsaParameterType") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -150,7 +149,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter_with_help_path.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter_with_help_path.py deleted file mode 100644 index 39b9086d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_parameter_with_help_path.py +++ /dev/null @@ -1,282 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSlimParameterWithHelpPath(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "type": "GsaParameterType", - "help_path": "str", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "type": "type", - "help_path": "helpPath", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaParameterType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - name: "str", - type: "GsaParameterType", - help_path: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSlimParameterWithHelpPath - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - name: str - type: GsaParameterType - help_path: str | None, optional - """ - self._help_path: str | None | Unset_Type = Unset - self._type: GsaParameterType - self._display_names: dict[str, str] - self._name: str - self._guid: str - - if help_path is not Unset: - self.help_path = help_path - self.type = type - self.display_names = display_names - self.name = name - self.guid = guid - - @property - def help_path(self) -> "str | None | Unset_Type": - """Gets the help_path of this GsaSlimParameterWithHelpPath. - - Returns - ------- - str | None | Unset_Type - The help_path of this GsaSlimParameterWithHelpPath. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "str | None | Unset_Type") -> None: - """Sets the help_path of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - help_path: str | None | Unset_Type - The help_path of this GsaSlimParameterWithHelpPath. - """ - self._help_path = help_path - - @property - def type(self) -> "GsaParameterType": - """Gets the type of this GsaSlimParameterWithHelpPath. - - Returns - ------- - GsaParameterType - The type of this GsaSlimParameterWithHelpPath. - """ - return self._type - - @type.setter - def type(self, type: "GsaParameterType") -> None: - """Sets the type of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - type: GsaParameterType - The type of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimParameterWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaSlimParameterWithHelpPath. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimParameterWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def name(self) -> "str": - """Gets the name of this GsaSlimParameterWithHelpPath. - - Returns - ------- - str - The name of this GsaSlimParameterWithHelpPath. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - name: str - The name of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSlimParameterWithHelpPath. - - Returns - ------- - str - The guid of this GsaSlimParameterWithHelpPath. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - guid: str - The guid of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimParameterWithHelpPath): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_permission.py similarity index 76% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_discrete_value.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_permission.py index 5c12acf9..39cd87ee 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_create_put_discrete_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_permission.py @@ -33,11 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_discrete_value import ( # noqa: F401 - GsaPutDiscreteValue, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -47,7 +42,7 @@ from . import * -class GsaCreatePutDiscreteValue(GsaPutDiscreteValue): +class GsaSlimPermission(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -66,15 +61,13 @@ class GsaCreatePutDiscreteValue(GsaPutDiscreteValue): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "name": "str", - "type": "GsaPutType", "guid": "str", + "name": "str", } attribute_map: dict[str, str] = { - "name": "name", - "type": "type", "guid": "guid", + "name": "name", } subtype_mapping: dict[str, str] = {} @@ -84,45 +77,41 @@ class GsaCreatePutDiscreteValue(GsaPutDiscreteValue): def __init__( self, *, + guid: "str", name: "str", - type: "GsaPutType" = GsaPutType.CREATE, - guid: "str | Unset_Type" = Unset, ) -> None: - """GsaCreatePutDiscreteValue - a model defined in Swagger + """GsaSlimPermission - a model defined in Swagger Parameters ---------- + guid: str name: str - type: GsaPutType - guid: str, optional """ - super().__init__(type=type) self._name: str - self._guid: str | Unset_Type = Unset + self._guid: str self.name = name - if guid is not Unset: - self.guid = guid + self.guid = guid @property def name(self) -> "str": - """Gets the name of this GsaCreatePutDiscreteValue. + """Gets the name of this GsaSlimPermission. Returns ------- str - The name of this GsaCreatePutDiscreteValue. + The name of this GsaSlimPermission. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePutDiscreteValue. + """Sets the name of this GsaSlimPermission. Parameters ---------- name: str - The name of this GsaCreatePutDiscreteValue. + The name of this GsaSlimPermission. """ # Field is not nullable if name is None: @@ -133,28 +122,31 @@ def name(self, name: "str") -> None: self._name = name @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreatePutDiscreteValue. + def guid(self) -> "str": + """Gets the guid of this GsaSlimPermission. Returns ------- - str | Unset_Type - The guid of this GsaCreatePutDiscreteValue. + str + The guid of this GsaSlimPermission. """ return self._guid @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreatePutDiscreteValue. + def guid(self, guid: "str") -> None: + """Sets the guid of this GsaSlimPermission. Parameters ---------- - guid: str | Unset_Type - The guid of this GsaCreatePutDiscreteValue. + guid: str + The guid of this GsaSlimPermission. """ # Field is not nullable if guid is None: raise ValueError("Invalid value for 'guid', must not be 'None'") + # Field is required + if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'guid', must not be 'Unset'") self._guid = guid @classmethod @@ -179,7 +171,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePutDiscreteValue): + if not isinstance(other, GsaSlimPermission): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_permission_category.py similarity index 76% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_discrete_value.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_permission_category.py index 03f7e133..f614b11d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_discrete_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_permission_category.py @@ -33,11 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_discrete_value import ( # noqa: F401 - GsaPutDiscreteValue, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -47,7 +42,7 @@ from . import * -class GsaUpdatePutDiscreteValue(GsaPutDiscreteValue): +class GsaSlimPermissionCategory(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -67,13 +62,11 @@ class GsaUpdatePutDiscreteValue(GsaPutDiscreteValue): """ swagger_types: dict[str, str] = { "guid": "str", - "type": "GsaPutType", "name": "str", } attribute_map: dict[str, str] = { "guid": "guid", - "type": "type", "name": "name", } @@ -85,77 +78,76 @@ def __init__( self, *, guid: "str", - type: "GsaPutType" = GsaPutType.UPDATE, - name: "str | Unset_Type" = Unset, + name: "str", ) -> None: - """GsaUpdatePutDiscreteValue - a model defined in Swagger + """GsaSlimPermissionCategory - a model defined in Swagger Parameters ---------- guid: str - type: GsaPutType - name: str, optional + name: str """ - super().__init__(type=type) + self._name: str self._guid: str - self._name: str | Unset_Type = Unset + self.name = name self.guid = guid - if name is not Unset: - self.name = name @property - def guid(self) -> "str": - """Gets the guid of this GsaUpdatePutDiscreteValue. + def name(self) -> "str": + """Gets the name of this GsaSlimPermissionCategory. Returns ------- str - The guid of this GsaUpdatePutDiscreteValue. + The name of this GsaSlimPermissionCategory. """ - return self._guid + return self._name - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUpdatePutDiscreteValue. + @name.setter + def name(self, name: "str") -> None: + """Sets the name of this GsaSlimPermissionCategory. Parameters ---------- - guid: str - The guid of this GsaUpdatePutDiscreteValue. + name: str + The name of this GsaSlimPermissionCategory. """ # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") + if name is None: + raise ValueError("Invalid value for 'name', must not be 'None'") # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid + if name is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'name', must not be 'Unset'") + self._name = name @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePutDiscreteValue. + def guid(self) -> "str": + """Gets the guid of this GsaSlimPermissionCategory. Returns ------- - str | Unset_Type - The name of this GsaUpdatePutDiscreteValue. + str + The guid of this GsaSlimPermissionCategory. """ - return self._name + return self._guid - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePutDiscreteValue. + @guid.setter + def guid(self, guid: "str") -> None: + """Sets the guid of this GsaSlimPermissionCategory. Parameters ---------- - name: str | Unset_Type - The name of this GsaUpdatePutDiscreteValue. + guid: str + The guid of this GsaSlimPermissionCategory. """ # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name + if guid is None: + raise ValueError("Invalid value for 'guid', must not be 'None'") + # Field is required + if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'guid', must not be 'Unset'") + self._guid = guid @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -179,7 +171,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePutDiscreteValue): + if not isinstance(other, GsaSlimPermissionCategory): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_record_link_group.py index 161dfb7c..7f4bfe06 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_record_link_group.py @@ -232,7 +232,6 @@ def reverse_display_names( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -244,7 +243,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_subset.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_subset.py index 4ec248e8..54ffb364 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_subset.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_subset.py @@ -102,7 +102,6 @@ def __init__( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -114,7 +113,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_table.py index b9bc687b..3d7a1444 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_table.py @@ -61,7 +61,6 @@ class GsaSlimTable(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "database_key": "str", "display_names": "dict(str, str)", "guid": "str", "is_hidden_from_browse": "bool", @@ -72,7 +71,6 @@ class GsaSlimTable(ModelBase): } attribute_map: dict[str, str] = { - "database_key": "databaseKey", "display_names": "displayNames", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", @@ -89,7 +87,6 @@ class GsaSlimTable(ModelBase): def __init__( self, *, - database_key: "str", display_names: "dict[str, str]", guid: "str", is_hidden_from_browse: "bool", @@ -102,7 +99,6 @@ def __init__( Parameters ---------- - database_key: str display_names: dict[str, str] guid: str is_hidden_from_browse: bool @@ -111,7 +107,6 @@ def __init__( name: str table_types: list[str] """ - self._database_key: str self._is_hidden_from_browse: bool self._is_hidden_from_search: bool self._is_versioned: bool @@ -120,7 +115,6 @@ def __init__( self._name: str self._guid: str - self.database_key = database_key self.is_hidden_from_browse = is_hidden_from_browse self.is_hidden_from_search = is_hidden_from_search self.is_versioned = is_versioned @@ -129,34 +123,6 @@ def __init__( self.name = name self.guid = guid - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaSlimTable. - - Returns - ------- - str - The database_key of this GsaSlimTable. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaSlimTable. - - Parameters - ---------- - database_key: str - The database_key of this GsaSlimTable. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - @property def is_hidden_from_browse(self) -> "bool": """Gets the is_hidden_from_browse of this GsaSlimTable. @@ -272,7 +238,6 @@ def table_types(self, table_types: "list[str]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimTable. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -284,7 +249,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimTable. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_typed_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_typed_attribute.py index ce23a029..25dedd3f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_typed_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_typed_attribute.py @@ -61,14 +61,12 @@ class GsaSlimTypedAttribute(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", "guid": "str", "name": "str", "type": "GsaAttributeType", } attribute_map: dict[str, str] = { - "display_names": "displayNames", "guid": "guid", "name": "name", "type": "type", @@ -83,7 +81,6 @@ class GsaSlimTypedAttribute(ModelBase): def __init__( self, *, - display_names: "dict[str, str]", guid: "str", name: "str", type: "GsaAttributeType", @@ -92,18 +89,15 @@ def __init__( Parameters ---------- - display_names: dict[str, str] guid: str name: str type: GsaAttributeType """ self._type: GsaAttributeType - self._display_names: dict[str, str] self._name: str self._guid: str self.type = type - self.display_names = display_names self.name = name self.guid = guid @@ -135,36 +129,6 @@ def type(self, type: "GsaAttributeType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimTypedAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaSlimTypedAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimTypedAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaSlimTypedAttribute. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - @property def name(self) -> "str": """Gets the name of this GsaSlimTypedAttribute. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_localized_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_unit_system.py similarity index 84% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_localized_entity.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_unit_system.py index 42839a87..b47c1ac3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_localized_entity.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_slim_unit_system.py @@ -42,7 +42,7 @@ from . import * -class GsaSlimLocalizedEntity(ModelBase): +class GsaSlimUnitSystem(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -83,7 +83,7 @@ def __init__( guid: "str", name: "str", ) -> None: - """GsaSlimLocalizedEntity - a model defined in Swagger + """GsaSlimUnitSystem - a model defined in Swagger Parameters ---------- @@ -101,25 +101,23 @@ def __init__( @property def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimLocalizedEntity. - A dictionary of the culture name to the name that should be used in that culture for the item + """Gets the display_names of this GsaSlimUnitSystem. Returns ------- dict[str, str] - The display_names of this GsaSlimLocalizedEntity. + The display_names of this GsaSlimUnitSystem. """ return self._display_names @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimLocalizedEntity. - A dictionary of the culture name to the name that should be used in that culture for the item + """Sets the display_names of this GsaSlimUnitSystem. Parameters ---------- display_names: dict[str, str] - The display_names of this GsaSlimLocalizedEntity. + The display_names of this GsaSlimUnitSystem. """ # Field is not nullable if display_names is None: @@ -131,23 +129,23 @@ def display_names(self, display_names: "dict[str, str]") -> None: @property def name(self) -> "str": - """Gets the name of this GsaSlimLocalizedEntity. + """Gets the name of this GsaSlimUnitSystem. Returns ------- str - The name of this GsaSlimLocalizedEntity. + The name of this GsaSlimUnitSystem. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaSlimLocalizedEntity. + """Sets the name of this GsaSlimUnitSystem. Parameters ---------- name: str - The name of this GsaSlimLocalizedEntity. + The name of this GsaSlimUnitSystem. """ # Field is not nullable if name is None: @@ -159,23 +157,23 @@ def name(self, name: "str") -> None: @property def guid(self) -> "str": - """Gets the guid of this GsaSlimLocalizedEntity. + """Gets the guid of this GsaSlimUnitSystem. Returns ------- str - The guid of this GsaSlimLocalizedEntity. + The guid of this GsaSlimUnitSystem. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimLocalizedEntity. + """Sets the guid of this GsaSlimUnitSystem. Parameters ---------- guid: str - The guid of this GsaSlimLocalizedEntity. + The guid of this GsaSlimUnitSystem. """ # Field is not nullable if guid is None: @@ -207,7 +205,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimLocalizedEntity): + if not isinstance(other, GsaSlimUnitSystem): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_detail.py deleted file mode 100644 index 69d3cdf6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_detail.py +++ /dev/null @@ -1,202 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartAttributesErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaSmartAttributesErrorReason", - } - - discriminator_value_class_map = { - "attributeAlreadySpecified".lower(): "#/components/schemas/GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "attributePairDiscreteTypeMismatch".lower(): "#/components/schemas/GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "attributePairTypeMismatch".lower(): "#/components/schemas/GsaAttributePairTypeMismatchSmartAttributesErrorDetail", - "attributeTypeNotSupported".lower(): "#/components/schemas/GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", - "noAttributePairs".lower(): "#/components/schemas/GsaNoAttributePairsSmartAttributesErrorDetail", - "noSuchAttribute".lower(): "#/components/schemas/GsaNoSuchAttributeSmartAttributesErrorDetail", - "sourceCannotBeTarget".lower(): "#/components/schemas/GsaSourceCannotBeTargetSmartAttributesErrorDetail", - "tooManyAttributePairs".lower(): "#/components/schemas/GsaTooManyAttributePairsSmartAttributesErrorDetail", - "multiValued".lower(): "#/components/schemas/GsaMultiValuedSmartAttributesErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason", - ) -> None: - """GsaSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - """ - self._message: str - self._reason: GsaSmartAttributesErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaSmartAttributesErrorDetail. - - Returns - ------- - str - The message of this GsaSmartAttributesErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaSmartAttributesErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaSmartAttributesErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaSmartAttributesErrorReason": - """Gets the reason of this GsaSmartAttributesErrorDetail. - - Returns - ------- - GsaSmartAttributesErrorReason - The reason of this GsaSmartAttributesErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaSmartAttributesErrorReason") -> None: - """Sets the reason of this GsaSmartAttributesErrorDetail. - - Parameters - ---------- - reason: GsaSmartAttributesErrorReason - The reason of this GsaSmartAttributesErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_reason.py deleted file mode 100644 index b902d4ee..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_error_reason.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaSmartAttributesErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTEALREADYSPECIFIED = "attributeAlreadySpecified" - ATTRIBUTEPAIRDISCRETETYPEMISMATCH = "attributePairDiscreteTypeMismatch" - ATTRIBUTEPAIRTYPEMISMATCH = "attributePairTypeMismatch" - ATTRIBUTETYPENOTSUPPORTED = "attributeTypeNotSupported" - NOATTRIBUTEPAIRS = "noAttributePairs" - NOSUCHATTRIBUTE = "noSuchAttribute" - SOURCECANNOTBETARGET = "sourceCannotBeTarget" - TOOMANYATTRIBUTEPAIRS = "tooManyAttributePairs" - MULTIVALUED = "multiValued" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_record_link_group_error_detail.py deleted file mode 100644 index c044054e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_attributes_record_link_group_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartAttributesRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaSmartAttributesErrorDetail]", - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaSmartAttributesErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaSmartAttributesErrorDetail]", - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.SMARTATTRIBUTES, - ) -> None: - """GsaSmartAttributesRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaSmartAttributesErrorDetail] - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaSmartAttributesErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaSmartAttributesErrorDetail]": - """Gets the errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - - Returns - ------- - list[GsaSmartAttributesErrorDetail] - The errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaSmartAttributesErrorDetail]") -> None: - """Sets the errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - - Parameters - ---------- - errors: list[GsaSmartAttributesErrorDetail] - The errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartAttributesRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link.py deleted file mode 100644 index e162a41b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link.py +++ /dev/null @@ -1,262 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_pairs": "list[GsaAttributeLinkPair]", - "display_names": "dict(str, str)", - "forbid_orphans": "bool", - "guid": "str", - "link_info": "GsaLinkInfo", - "name": "str", - "referential_integrity_model": "GsaReferentialIntegrityModel", - "reverse_name": "str", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "attribute_pairs": "attributePairs", - "display_names": "displayNames", - "forbid_orphans": "forbidOrphans", - "guid": "guid", - "link_info": "linkInfo", - "name": "name", - "referential_integrity_model": "referentialIntegrityModel", - "reverse_name": "reverseName", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = { - "referentialIntegrityModel": "GsaReferentialIntegrityModel", - "attributePairs": "GsaAttributeLinkPair", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_pairs: "list[GsaAttributeLinkPair]", - display_names: "dict[str, str]", - forbid_orphans: "bool", - guid: "str", - link_info: "GsaLinkInfo", - name: "str", - referential_integrity_model: "GsaReferentialIntegrityModel", - reverse_name: "str", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.SMARTLINK, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaSmartLink - a model defined in Swagger - - Parameters - ---------- - attribute_pairs: list[GsaAttributeLinkPair] - display_names: dict[str, str] - forbid_orphans: bool - guid: str - link_info: GsaLinkInfo - name: str - referential_integrity_model: GsaReferentialIntegrityModel - reverse_name: str - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._forbid_orphans: bool - self._referential_integrity_model: GsaReferentialIntegrityModel - self._attribute_pairs: list[GsaAttributeLinkPair] - - self.forbid_orphans = forbid_orphans - self.referential_integrity_model = referential_integrity_model - self.attribute_pairs = attribute_pairs - - @property - def forbid_orphans(self) -> "bool": - """Gets the forbid_orphans of this GsaSmartLink. - - Returns - ------- - bool - The forbid_orphans of this GsaSmartLink. - """ - return self._forbid_orphans - - @forbid_orphans.setter - def forbid_orphans(self, forbid_orphans: "bool") -> None: - """Sets the forbid_orphans of this GsaSmartLink. - - Parameters - ---------- - forbid_orphans: bool - The forbid_orphans of this GsaSmartLink. - """ - # Field is not nullable - if forbid_orphans is None: - raise ValueError("Invalid value for 'forbid_orphans', must not be 'None'") - # Field is required - if forbid_orphans is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'forbid_orphans', must not be 'Unset'") - self._forbid_orphans = forbid_orphans - - @property - def referential_integrity_model(self) -> "GsaReferentialIntegrityModel": - """Gets the referential_integrity_model of this GsaSmartLink. - - Returns - ------- - GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartLink. - """ - return self._referential_integrity_model - - @referential_integrity_model.setter - def referential_integrity_model( - self, referential_integrity_model: "GsaReferentialIntegrityModel" - ) -> None: - """Sets the referential_integrity_model of this GsaSmartLink. - - Parameters - ---------- - referential_integrity_model: GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartLink. - """ - # Field is not nullable - if referential_integrity_model is None: - raise ValueError("Invalid value for 'referential_integrity_model', must not be 'None'") - # Field is required - if referential_integrity_model is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'referential_integrity_model', must not be 'Unset'") - self._referential_integrity_model = referential_integrity_model - - @property - def attribute_pairs(self) -> "list[GsaAttributeLinkPair]": - """Gets the attribute_pairs of this GsaSmartLink. - - Returns - ------- - list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartLink. - """ - return self._attribute_pairs - - @attribute_pairs.setter - def attribute_pairs(self, attribute_pairs: "list[GsaAttributeLinkPair]") -> None: - """Sets the attribute_pairs of this GsaSmartLink. - - Parameters - ---------- - attribute_pairs: list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartLink. - """ - # Field is not nullable - if attribute_pairs is None: - raise ValueError("Invalid value for 'attribute_pairs', must not be 'None'") - # Field is required - if attribute_pairs is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_pairs', must not be 'Unset'") - self._attribute_pairs = attribute_pairs - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_create_put_layout_item.py deleted file mode 100644 index 66db797f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_create_put_layout_item.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartLinkCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "link_group_guid": "str", - "type": "GsaPutType", - "forwards": "bool", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "link_group_guid": "linkGroupGuid", - "type": "type", - "forwards": "forwards", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.SMARTLINK, - link_group_guid: "str", - type: "GsaPutType" = GsaPutType.CREATE, - forwards: "bool | Unset_Type" = Unset, - ) -> None: - """GsaSmartLinkCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - link_group_guid: str - type: GsaPutType - forwards: bool, optional - """ - super().__init__(item_type=item_type, type=type) - self._forwards: bool | Unset_Type = Unset - self._link_group_guid: str - - if forwards is not Unset: - self.forwards = forwards - self.link_group_guid = link_group_guid - - @property - def forwards(self) -> "bool | Unset_Type": - """Gets the forwards of this GsaSmartLinkCreatePutLayoutItem. - - Returns - ------- - bool | Unset_Type - The forwards of this GsaSmartLinkCreatePutLayoutItem. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool | Unset_Type") -> None: - """Sets the forwards of this GsaSmartLinkCreatePutLayoutItem. - - Parameters - ---------- - forwards: bool | Unset_Type - The forwards of this GsaSmartLinkCreatePutLayoutItem. - """ - # Field is not nullable - if forwards is None: - raise ValueError("Invalid value for 'forwards', must not be 'None'") - self._forwards = forwards - - @property - def link_group_guid(self) -> "str": - """Gets the link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - - Returns - ------- - str - The link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - """ - return self._link_group_guid - - @link_group_guid.setter - def link_group_guid(self, link_group_guid: "str") -> None: - """Sets the link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - - Parameters - ---------- - link_group_guid: str - The link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - """ - # Field is not nullable - if link_group_guid is None: - raise ValueError("Invalid value for 'link_group_guid', must not be 'None'") - # Field is required - if link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_group_guid', must not be 'Unset'") - self._link_group_guid = link_group_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartLinkCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_group_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_group_usage_data_modification_error_detail.py deleted file mode 100644 index 63c40c50..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_link_group_usage_data_modification_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartLinkGroupUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimNamedEntity]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.SMARTLINKGROUP, - referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaSmartLinkGroupUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimNamedEntity] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartLinkGroupUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_record_link_result.py deleted file mode 100644 index 4cd570d3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smart_record_link_result.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_result import ( # noqa: F401 - GsaRecordLinkResult, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartRecordLinkResult(GsaRecordLinkResult): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "is_link_to_target": "bool", - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - } - - attribute_map: dict[str, str] = { - "is_link_to_target": "isLinkToTarget", - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - is_link_to_target: "bool", - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, - ) -> None: - """GsaSmartRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - is_link_to_target: bool - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - """ - super().__init__(linked_record=linked_record, record_link_group_type=record_link_group_type) - self._is_link_to_target: bool - - self.is_link_to_target = is_link_to_target - - @property - def is_link_to_target(self) -> "bool": - """Gets the is_link_to_target of this GsaSmartRecordLinkResult. - Smart links have a 'source' and a 'target' determined by the attribute pairs on the link group. If this property is 'true' then the linked record is on the 'target' side of the link, if 'false' the linked record is on the 'source' side.. - - Returns - ------- - bool - The is_link_to_target of this GsaSmartRecordLinkResult. - """ - return self._is_link_to_target - - @is_link_to_target.setter - def is_link_to_target(self, is_link_to_target: "bool") -> None: - """Sets the is_link_to_target of this GsaSmartRecordLinkResult. - Smart links have a 'source' and a 'target' determined by the attribute pairs on the link group. If this property is 'true' then the linked record is on the 'target' side of the link, if 'false' the linked record is on the 'source' side.. - - Parameters - ---------- - is_link_to_target: bool - The is_link_to_target of this GsaSmartRecordLinkResult. - """ - # Field is not nullable - if is_link_to_target is None: - raise ValueError("Invalid value for 'is_link_to_target', must not be 'None'") - # Field is required - if is_link_to_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_link_to_target', must not be 'Unset'") - self._is_link_to_target = is_link_to_target - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smtp_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smtp_properties.py new file mode 100644 index 00000000..ca5dda21 --- /dev/null +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_smtp_properties.py @@ -0,0 +1,308 @@ +# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. +# SPDX-License-Identifier: MIT +# +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +""" +MI Server API + +No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + +OpenAPI spec version: v1 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import re # noqa: F401 +from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 + +from . import ModelBase, Unset, Unset_Type + +if TYPE_CHECKING: + from datetime import datetime + import pathlib + + from . import * + + +class GsaSmtpProperties(ModelBase): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes + ---------- + swagger_types: dict[str, str] + The key is attribute name and the value is attribute type. + attribute_map: dict[str, str] + The key is attribute name and the value is json key in definition. + subtype_mapping: dict[str, str] + The key is the unmangled property name and the value is the corresponding type. + discriminator: Optional[str] + Name of the property used as discriminator for subtypes. + """ + swagger_types: dict[str, str] = { + "authentication_password": "str", + "authentication_username": "str", + "host_name": "str", + "port": "int", + "use_authentication": "bool", + "use_ssl": "bool", + } + + attribute_map: dict[str, str] = { + "authentication_password": "authenticationPassword", + "authentication_username": "authenticationUsername", + "host_name": "hostName", + "port": "port", + "use_authentication": "useAuthentication", + "use_ssl": "useSsl", + } + + subtype_mapping: dict[str, str] = {} + + discriminator: Optional[str] = None + + def __init__( + self, + *, + authentication_password: "str | None | Unset_Type" = Unset, + authentication_username: "str | None | Unset_Type" = Unset, + host_name: "str | None | Unset_Type" = Unset, + port: "int | Unset_Type" = 25, + use_authentication: "bool | Unset_Type" = Unset, + use_ssl: "bool | Unset_Type" = Unset, + ) -> None: + """GsaSmtpProperties - a model defined in Swagger + + Parameters + ---------- + authentication_password: str | None, optional + authentication_username: str | None, optional + host_name: str | None, optional + port: int, optional + use_authentication: bool, optional + use_ssl: bool, optional + """ + self._host_name: str | None | Unset_Type = Unset + self._port: int | Unset_Type = Unset + self._use_ssl: bool | Unset_Type = Unset + self._use_authentication: bool | Unset_Type = Unset + self._authentication_username: str | None | Unset_Type = Unset + self._authentication_password: str | None | Unset_Type = Unset + + if host_name is not Unset: + self.host_name = host_name + if port is not Unset: + self.port = port + if use_ssl is not Unset: + self.use_ssl = use_ssl + if use_authentication is not Unset: + self.use_authentication = use_authentication + if authentication_username is not Unset: + self.authentication_username = authentication_username + if authentication_password is not Unset: + self.authentication_password = authentication_password + + @property + def host_name(self) -> "str | None | Unset_Type": + """Gets the host_name of this GsaSmtpProperties. + Gets or sets the name of the host used for SMTP transactions + + Returns + ------- + str | None | Unset_Type + The host_name of this GsaSmtpProperties. + """ + return self._host_name + + @host_name.setter + def host_name(self, host_name: "str | None | Unset_Type") -> None: + """Sets the host_name of this GsaSmtpProperties. + Gets or sets the name of the host used for SMTP transactions + + Parameters + ---------- + host_name: str | None | Unset_Type + The host_name of this GsaSmtpProperties. + """ + self._host_name = host_name + + @property + def port(self) -> "int | Unset_Type": + """Gets the port of this GsaSmtpProperties. + Gets or sets the port used for SMTP transactions. If no value set then it will default to 25 + + Returns + ------- + int | Unset_Type + The port of this GsaSmtpProperties. + """ + return self._port + + @port.setter + def port(self, port: "int | Unset_Type") -> None: + """Sets the port of this GsaSmtpProperties. + Gets or sets the port used for SMTP transactions. If no value set then it will default to 25 + + Parameters + ---------- + port: int | Unset_Type + The port of this GsaSmtpProperties. + """ + # Field is not nullable + if port is None: + raise ValueError("Invalid value for 'port', must not be 'None'") + self._port = port + + @property + def use_ssl(self) -> "bool | Unset_Type": + """Gets the use_ssl of this GsaSmtpProperties. + Indicates whether the SMTP server uses SSL. Defaults to False + + Returns + ------- + bool | Unset_Type + The use_ssl of this GsaSmtpProperties. + """ + return self._use_ssl + + @use_ssl.setter + def use_ssl(self, use_ssl: "bool | Unset_Type") -> None: + """Sets the use_ssl of this GsaSmtpProperties. + Indicates whether the SMTP server uses SSL. Defaults to False + + Parameters + ---------- + use_ssl: bool | Unset_Type + The use_ssl of this GsaSmtpProperties. + """ + # Field is not nullable + if use_ssl is None: + raise ValueError("Invalid value for 'use_ssl', must not be 'None'") + self._use_ssl = use_ssl + + @property + def use_authentication(self) -> "bool | Unset_Type": + """Gets the use_authentication of this GsaSmtpProperties. + Indicates whether authentication is required. If this is set to True then Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationUsername and Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationPassword are required. Defaults to False + + Returns + ------- + bool | Unset_Type + The use_authentication of this GsaSmtpProperties. + """ + return self._use_authentication + + @use_authentication.setter + def use_authentication(self, use_authentication: "bool | Unset_Type") -> None: + """Sets the use_authentication of this GsaSmtpProperties. + Indicates whether authentication is required. If this is set to True then Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationUsername and Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationPassword are required. Defaults to False + + Parameters + ---------- + use_authentication: bool | Unset_Type + The use_authentication of this GsaSmtpProperties. + """ + # Field is not nullable + if use_authentication is None: + raise ValueError("Invalid value for 'use_authentication', must not be 'None'") + self._use_authentication = use_authentication + + @property + def authentication_username(self) -> "str | None | Unset_Type": + """Gets the authentication_username of this GsaSmtpProperties. + Gets or sets the username to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Returns + ------- + str | None | Unset_Type + The authentication_username of this GsaSmtpProperties. + """ + return self._authentication_username + + @authentication_username.setter + def authentication_username(self, authentication_username: "str | None | Unset_Type") -> None: + """Sets the authentication_username of this GsaSmtpProperties. + Gets or sets the username to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Parameters + ---------- + authentication_username: str | None | Unset_Type + The authentication_username of this GsaSmtpProperties. + """ + self._authentication_username = authentication_username + + @property + def authentication_password(self) -> "str | None | Unset_Type": + """Gets the authentication_password of this GsaSmtpProperties. + Gets or sets the password to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Returns + ------- + str | None | Unset_Type + The authentication_password of this GsaSmtpProperties. + """ + return self._authentication_password + + @authentication_password.setter + def authentication_password(self, authentication_password: "str | None | Unset_Type") -> None: + """Sets the authentication_password of this GsaSmtpProperties. + Gets or sets the password to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Parameters + ---------- + authentication_password: str | None | Unset_Type + The authentication_password of this GsaSmtpProperties. + """ + self._authentication_password = authentication_password + + @classmethod + def get_real_child_model(cls, data: dict[str, str]) -> str: + """Raises a NotImplementedError for a type without a discriminator defined. + + Parameters + ---------- + data: ModelBase + Object representing a subclass of this class + + Raises + ------ + NotImplementedError + This class has no discriminator, and hence no subclasses + """ + raise NotImplementedError() + + def __repr__(self) -> str: + """For 'print' and 'pprint'""" + return self.to_str() + + def __eq__(self, other: Any) -> bool: + """Returns true if both objects are equal""" + if not isinstance(other, GsaSmtpProperties): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other: Any) -> bool: + """Returns true if both objects are not equal""" + return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion.py index 3b4ceab7..0c87eb49 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion.py @@ -81,7 +81,6 @@ class GsaSortCriterion(ModelBase): "attribute".lower(): "#/components/schemas/GsaAttributeSortCriterion", "recordProperty".lower(): "#/components/schemas/GsaRecordPropertySortCriterion", "relevance".lower(): "#/components/schemas/GsaRelevanceSortCriterion", - "similarity".lower(): "#/components/schemas/GsaSimilaritySortCriterion", } discriminator: Optional[str] = "type" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion_type.py index e39ad727..e2bc866a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sort_criterion_type.py @@ -45,4 +45,3 @@ class GsaSortCriterionType(Enum): ATTRIBUTE = "attribute" RECORDPROPERTY = "recordProperty" RELEVANCE = "relevance" - SIMILARITY = "similarity" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_source_cannot_be_target_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_source_cannot_be_target_smart_attributes_error_detail.py deleted file mode 100644 index a963f574..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_source_cannot_be_target_smart_attributes_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSourceCannotBeTargetSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.SOURCECANNOTBETARGET, - ) -> None: - """GsaSourceCannotBeTargetSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSourceCannotBeTargetSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sql_credentials.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sql_credentials.py deleted file mode 100644 index bf0be01a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_sql_credentials.py +++ /dev/null @@ -1,185 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSqlCredentials(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "password": "str", - "username": "str", - } - - attribute_map: dict[str, str] = { - "password": "password", - "username": "username", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - password: "str", - username: "str", - ) -> None: - """GsaSqlCredentials - a model defined in Swagger - - Parameters - ---------- - password: str - username: str - """ - self._username: str - self._password: str - - self.username = username - self.password = password - - @property - def username(self) -> "str": - """Gets the username of this GsaSqlCredentials. - The username for the SQL authentication. The password must also be provided. - - Returns - ------- - str - The username of this GsaSqlCredentials. - """ - return self._username - - @username.setter - def username(self, username: "str") -> None: - """Sets the username of this GsaSqlCredentials. - The username for the SQL authentication. The password must also be provided. - - Parameters - ---------- - username: str - The username of this GsaSqlCredentials. - """ - # Field is not nullable - if username is None: - raise ValueError("Invalid value for 'username', must not be 'None'") - # Field is required - if username is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'username', must not be 'Unset'") - self._username = username - - @property - def password(self) -> "str": - """Gets the password of this GsaSqlCredentials. - The password for the SQL authentication. The username must also be provided. - - Returns - ------- - str - The password of this GsaSqlCredentials. - """ - return self._password - - @password.setter - def password(self, password: "str") -> None: - """Sets the password of this GsaSqlCredentials. - The password for the SQL authentication. The username must also be provided. - - Parameters - ---------- - password: str - The password of this GsaSqlCredentials. - """ - # Field is not nullable - if password is None: - raise ValueError("Invalid value for 'password', must not be 'None'") - # Field is required - if password is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'password', must not be 'Unset'") - self._password = password - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSqlCredentials): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name.py index 11d24922..e72caf79 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name.py @@ -65,11 +65,10 @@ class GsaStandardName(ModelBase): "database_key": "str", "database_version_guid": "str", "guid": "str", - "is_custom": "bool", "mapped_attributes": "list[GsaSlimAttribute]", "mapped_cross_database_record_link_groups": "list[GsaSlimNamedEntity]", "mapped_parameters": "list[GsaSlimNamedEntity]", - "mapped_static_record_link_groups": "list[GsaStaticRecordLinkGroupMapping]", + "mapped_record_link_groups": "list[GsaSlimNamedEntity]", "name": "str", } @@ -78,18 +77,17 @@ class GsaStandardName(ModelBase): "database_key": "databaseKey", "database_version_guid": "databaseVersionGuid", "guid": "guid", - "is_custom": "isCustom", "mapped_attributes": "mappedAttributes", "mapped_cross_database_record_link_groups": "mappedCrossDatabaseRecordLinkGroups", "mapped_parameters": "mappedParameters", - "mapped_static_record_link_groups": "mappedStaticRecordLinkGroups", + "mapped_record_link_groups": "mappedRecordLinkGroups", "name": "name", } subtype_mapping: dict[str, str] = { "mappedAttributes": "GsaSlimAttribute", "mappedParameters": "GsaSlimNamedEntity", - "mappedStaticRecordLinkGroups": "GsaStaticRecordLinkGroupMapping", + "mappedRecordLinkGroups": "GsaSlimNamedEntity", "mappedCrossDatabaseRecordLinkGroups": "GsaSlimNamedEntity", } @@ -102,11 +100,10 @@ def __init__( database_key: "str", database_version_guid: "str", guid: "str", - is_custom: "bool", mapped_attributes: "list[GsaSlimAttribute]", mapped_cross_database_record_link_groups: "list[GsaSlimNamedEntity]", mapped_parameters: "list[GsaSlimNamedEntity]", - mapped_static_record_link_groups: "list[GsaStaticRecordLinkGroupMapping]", + mapped_record_link_groups: "list[GsaSlimNamedEntity]", name: "str", ) -> None: """GsaStandardName - a model defined in Swagger @@ -117,32 +114,29 @@ def __init__( database_key: str database_version_guid: str guid: str - is_custom: bool mapped_attributes: list[GsaSlimAttribute] mapped_cross_database_record_link_groups: list[GsaSlimNamedEntity] mapped_parameters: list[GsaSlimNamedEntity] - mapped_static_record_link_groups: list[GsaStaticRecordLinkGroupMapping] + mapped_record_link_groups: list[GsaSlimNamedEntity] name: str """ self._mapped_attributes: list[GsaSlimAttribute] self._mapped_parameters: list[GsaSlimNamedEntity] - self._mapped_static_record_link_groups: list[GsaStaticRecordLinkGroupMapping] + self._mapped_record_link_groups: list[GsaSlimNamedEntity] self._mapped_cross_database_record_link_groups: list[GsaSlimNamedEntity] self._database_key: str self._database_guid: str self._database_version_guid: str - self._is_custom: bool self._name: str self._guid: str self.mapped_attributes = mapped_attributes self.mapped_parameters = mapped_parameters - self.mapped_static_record_link_groups = mapped_static_record_link_groups + self.mapped_record_link_groups = mapped_record_link_groups self.mapped_cross_database_record_link_groups = mapped_cross_database_record_link_groups self.database_key = database_key self.database_guid = database_guid self.database_version_guid = database_version_guid - self.is_custom = is_custom self.name = name self.guid = guid @@ -203,38 +197,34 @@ def mapped_parameters(self, mapped_parameters: "list[GsaSlimNamedEntity]") -> No self._mapped_parameters = mapped_parameters @property - def mapped_static_record_link_groups(self) -> "list[GsaStaticRecordLinkGroupMapping]": - """Gets the mapped_static_record_link_groups of this GsaStandardName. + def mapped_record_link_groups(self) -> "list[GsaSlimNamedEntity]": + """Gets the mapped_record_link_groups of this GsaStandardName. Returns ------- - list[GsaStaticRecordLinkGroupMapping] - The mapped_static_record_link_groups of this GsaStandardName. + list[GsaSlimNamedEntity] + The mapped_record_link_groups of this GsaStandardName. """ - return self._mapped_static_record_link_groups + return self._mapped_record_link_groups - @mapped_static_record_link_groups.setter - def mapped_static_record_link_groups( - self, mapped_static_record_link_groups: "list[GsaStaticRecordLinkGroupMapping]" + @mapped_record_link_groups.setter + def mapped_record_link_groups( + self, mapped_record_link_groups: "list[GsaSlimNamedEntity]" ) -> None: - """Sets the mapped_static_record_link_groups of this GsaStandardName. + """Sets the mapped_record_link_groups of this GsaStandardName. Parameters ---------- - mapped_static_record_link_groups: list[GsaStaticRecordLinkGroupMapping] - The mapped_static_record_link_groups of this GsaStandardName. + mapped_record_link_groups: list[GsaSlimNamedEntity] + The mapped_record_link_groups of this GsaStandardName. """ # Field is not nullable - if mapped_static_record_link_groups is None: - raise ValueError( - "Invalid value for 'mapped_static_record_link_groups', must not be 'None'" - ) + if mapped_record_link_groups is None: + raise ValueError("Invalid value for 'mapped_record_link_groups', must not be 'None'") # Field is required - if mapped_static_record_link_groups is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'mapped_static_record_link_groups', must not be 'Unset'" - ) - self._mapped_static_record_link_groups = mapped_static_record_link_groups + if mapped_record_link_groups is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'mapped_record_link_groups', must not be 'Unset'") + self._mapped_record_link_groups = mapped_record_link_groups @property def mapped_cross_database_record_link_groups(self) -> "list[GsaSlimNamedEntity]": @@ -354,34 +344,6 @@ def database_version_guid(self, database_version_guid: "str") -> None: raise ValueError("Invalid value for 'database_version_guid', must not be 'Unset'") self._database_version_guid = database_version_guid - @property - def is_custom(self) -> "bool": - """Gets the is_custom of this GsaStandardName. - - Returns - ------- - bool - The is_custom of this GsaStandardName. - """ - return self._is_custom - - @is_custom.setter - def is_custom(self, is_custom: "bool") -> None: - """Sets the is_custom of this GsaStandardName. - - Parameters - ---------- - is_custom: bool - The is_custom of this GsaStandardName. - """ - # Field is not nullable - if is_custom is None: - raise ValueError("Invalid value for 'is_custom', must not be 'None'") - # Field is required - if is_custom is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_custom', must not be 'Unset'") - self._is_custom = is_custom - @property def name(self) -> "str": """Gets the name of this GsaStandardName. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_already_exists_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_already_exists_error_detail.py deleted file mode 100644 index b8235403..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_already_exists_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameAlreadyExistsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "standard_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "standard_name": "standardName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.STANDARDNAMEALREADYEXISTS, - standard_name: "str", - ) -> None: - """GsaStandardNameAlreadyExistsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - standard_name: str - """ - super().__init__(message=message, reason=reason) - self._standard_name: str - - self.standard_name = standard_name - - @property - def standard_name(self) -> "str": - """Gets the standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - - Returns - ------- - str - The standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - """ - return self._standard_name - - @standard_name.setter - def standard_name(self, standard_name: "str") -> None: - """Sets the standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - - Parameters - ---------- - standard_name: str - The standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - """ - # Field is not nullable - if standard_name is None: - raise ValueError("Invalid value for 'standard_name', must not be 'None'") - # Field is required - if standard_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'standard_name', must not be 'Unset'") - self._standard_name = standard_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameAlreadyExistsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_creation_exception.py deleted file mode 100644 index 99024449..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_creation_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaStandardNameErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaStandardNameErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaStandardNameErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaStandardNameErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaStandardNameCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaStandardNameCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaStandardNameCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaStandardNameCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaStandardNameCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaStandardNameCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaStandardNameCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaStandardNameCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaStandardNameCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaStandardNameCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaStandardNameCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaStandardNameCreationException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaStandardNameErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaStandardNameCreationException. - - Returns - ------- - list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaStandardNameCreationException. - - Parameters - ---------- - errors: list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_detail.py deleted file mode 100644 index 6f200a3e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_detail.py +++ /dev/null @@ -1,212 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameDeletionErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameDeletionErrorReason", - "standard_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "standard_name": "standardName", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaStandardNameDeletionErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameDeletionErrorReason", - standard_name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameDeletionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameDeletionErrorReason - standard_name: str | None, optional - """ - self._message: str - self._reason: GsaStandardNameDeletionErrorReason - self._standard_name: str | None | Unset_Type = Unset - - self.message = message - self.reason = reason - if standard_name is not Unset: - self.standard_name = standard_name - - @property - def message(self) -> "str": - """Gets the message of this GsaStandardNameDeletionErrorDetail. - - Returns - ------- - str - The message of this GsaStandardNameDeletionErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaStandardNameDeletionErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaStandardNameDeletionErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaStandardNameDeletionErrorReason": - """Gets the reason of this GsaStandardNameDeletionErrorDetail. - - Returns - ------- - GsaStandardNameDeletionErrorReason - The reason of this GsaStandardNameDeletionErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaStandardNameDeletionErrorReason") -> None: - """Sets the reason of this GsaStandardNameDeletionErrorDetail. - - Parameters - ---------- - reason: GsaStandardNameDeletionErrorReason - The reason of this GsaStandardNameDeletionErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @property - def standard_name(self) -> "str | None | Unset_Type": - """Gets the standard_name of this GsaStandardNameDeletionErrorDetail. - - Returns - ------- - str | None | Unset_Type - The standard_name of this GsaStandardNameDeletionErrorDetail. - """ - return self._standard_name - - @standard_name.setter - def standard_name(self, standard_name: "str | None | Unset_Type") -> None: - """Sets the standard_name of this GsaStandardNameDeletionErrorDetail. - - Parameters - ---------- - standard_name: str | None | Unset_Type - The standard_name of this GsaStandardNameDeletionErrorDetail. - """ - self._standard_name = standard_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameDeletionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_reason.py deleted file mode 100644 index d9d88a86..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaStandardNameDeletionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NONCUSTOMSTANDARDNAMECANNOTBEDELETED = "nonCustomStandardNameCannotBeDeleted" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_exception.py deleted file mode 100644 index e0eed7d0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_deletion_exception.py +++ /dev/null @@ -1,237 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaStandardNameDeletionErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaStandardNameDeletionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameDeletionException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaStandardNameDeletionErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaStandardNameDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaStandardNameDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaStandardNameDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaStandardNameDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaStandardNameDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaStandardNameDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaStandardNameDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaStandardNameDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaStandardNameDeletionException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaStandardNameDeletionException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaStandardNameDeletionException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaStandardNameDeletionException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaStandardNameDeletionException. - - Returns - ------- - list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameDeletionException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaStandardNameDeletionException. - - Parameters - ---------- - errors: list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_detail.py deleted file mode 100644 index 548fd3d1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_detail.py +++ /dev/null @@ -1,204 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaStandardNameErrorReason", - } - - discriminator_value_class_map = { - "standardNameAlreadyExists".lower(): "#/components/schemas/GsaStandardNameAlreadyExistsErrorDetail", - "duplicateMappedAttributeGuids".lower(): "#/components/schemas/GsaDuplicateMappedAttributeGuidsErrorDetail", - "duplicateMappedParameterGuids".lower(): "#/components/schemas/GsaDuplicateMappedParameterGuidsErrorDetail", - "duplicateMappedRecordLinkGroupGuids".lower(): "#/components/schemas/GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "duplicateMappedCrossDatabaseRecordLinkGroupGuids".lower(): "#/components/schemas/GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "unresolvedAttributeGuids".lower(): "#/components/schemas/GsaUnresolvedAttributeGuidsErrorDetail", - "unresolvedParameterGuids".lower(): "#/components/schemas/GsaUnresolvedParameterGuidsErrorDetail", - "unresolvedRecordLinkGroupGuids".lower(): "#/components/schemas/GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "unresolvedCrossDatabaseRecordLinkGroupGuids".lower(): "#/components/schemas/GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "nonCustomStandardNameCannotBeChanged".lower(): "#/components/schemas/GsaNonCustomStandardNameCannotBeChangedErrorDetail", - "unresolvedReverseRecordLinkGroups".lower(): "#/components/schemas/GsaUnresolvedReverseRecordLinkGroupsErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason", - ) -> None: - """GsaStandardNameErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - self._message: str - self._reason: GsaStandardNameErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaStandardNameErrorDetail. - - Returns - ------- - str - The message of this GsaStandardNameErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaStandardNameErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaStandardNameErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaStandardNameErrorReason": - """Gets the reason of this GsaStandardNameErrorDetail. - - Returns - ------- - GsaStandardNameErrorReason - The reason of this GsaStandardNameErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaStandardNameErrorReason") -> None: - """Sets the reason of this GsaStandardNameErrorDetail. - - Parameters - ---------- - reason: GsaStandardNameErrorReason - The reason of this GsaStandardNameErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_reason.py deleted file mode 100644 index b5311008..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_error_reason.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaStandardNameErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - STANDARDNAMEALREADYEXISTS = "standardNameAlreadyExists" - DUPLICATEMAPPEDATTRIBUTEGUIDS = "duplicateMappedAttributeGuids" - DUPLICATEMAPPEDPARAMETERGUIDS = "duplicateMappedParameterGuids" - DUPLICATEMAPPEDRECORDLINKGROUPGUIDS = "duplicateMappedRecordLinkGroupGuids" - DUPLICATEMAPPEDCROSSDATABASERECORDLINKGROUPGUIDS = ( - "duplicateMappedCrossDatabaseRecordLinkGroupGuids" - ) - UNRESOLVEDATTRIBUTEGUIDS = "unresolvedAttributeGuids" - UNRESOLVEDPARAMETERGUIDS = "unresolvedParameterGuids" - UNRESOLVEDRECORDLINKGROUPGUIDS = "unresolvedRecordLinkGroupGuids" - UNRESOLVEDCROSSDATABASERECORDLINKGROUPGUIDS = "unresolvedCrossDatabaseRecordLinkGroupGuids" - NONCUSTOMSTANDARDNAMECANNOTBECHANGED = "nonCustomStandardNameCannotBeChanged" - UNRESOLVEDREVERSERECORDLINKGROUPS = "unresolvedReverseRecordLinkGroups" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_update_exception.py deleted file mode 100644 index b4f22468..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_standard_name_update_exception.py +++ /dev/null @@ -1,238 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaStandardNameErrorDetail]", - "message": "str", - "standard_name_guid": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "standard_name_guid": "standardNameGuid", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaStandardNameErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - standard_name_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaStandardNameErrorDetail] | None, optional - message: str | None, optional - standard_name_guid: str, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._standard_name_guid: str | Unset_Type = Unset - self._errors: list[GsaStandardNameErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if standard_name_guid is not Unset: - self.standard_name_guid = standard_name_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaStandardNameUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaStandardNameUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaStandardNameUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaStandardNameUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaStandardNameUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaStandardNameUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaStandardNameUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaStandardNameUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def standard_name_guid(self) -> "str | Unset_Type": - """Gets the standard_name_guid of this GsaStandardNameUpdateException. - - Returns - ------- - str | Unset_Type - The standard_name_guid of this GsaStandardNameUpdateException. - """ - return self._standard_name_guid - - @standard_name_guid.setter - def standard_name_guid(self, standard_name_guid: "str | Unset_Type") -> None: - """Sets the standard_name_guid of this GsaStandardNameUpdateException. - - Parameters - ---------- - standard_name_guid: str | Unset_Type - The standard_name_guid of this GsaStandardNameUpdateException. - """ - # Field is not nullable - if standard_name_guid is None: - raise ValueError("Invalid value for 'standard_name_guid', must not be 'None'") - self._standard_name_guid = standard_name_guid - - @property - def errors(self) -> "list[GsaStandardNameErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaStandardNameUpdateException. - - Returns - ------- - list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaStandardNameUpdateException. - - Parameters - ---------- - errors: list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link.py deleted file mode 100644 index be9c8029..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_base import ( # noqa: F401 - GsaRecordLinkBase, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStaticRecordLink(GsaRecordLinkBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "record_link_group_type": "GsaRecordLinkGroupType", - "source_record_history_guid": "str", - "target_record_history_guid": "str", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "record_link_group_type": "recordLinkGroupType", - "source_record_history_guid": "sourceRecordHistoryGuid", - "target_record_history_guid": "targetRecordHistoryGuid", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.STATIC, - source_record_history_guid: "str", - target_record_history_guid: "str", - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStaticRecordLink - a model defined in Swagger - - Parameters - ---------- - guid: str - record_link_group_type: GsaRecordLinkGroupType - source_record_history_guid: str - target_record_history_guid: str - notes: str | None, optional - """ - super().__init__( - guid=guid, - record_link_group_type=record_link_group_type, - source_record_history_guid=source_record_history_guid, - target_record_history_guid=target_record_history_guid, - notes=notes, - ) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStaticRecordLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_group_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_group_mapping.py deleted file mode 100644 index 86c4d8cb..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_group_mapping.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStaticRecordLinkGroupMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "is_reverse": "bool", - "static_record_link_group": "GsaSlimRecordLinkGroup", - } - - attribute_map: dict[str, str] = { - "is_reverse": "isReverse", - "static_record_link_group": "staticRecordLinkGroup", - } - - subtype_mapping: dict[str, str] = { - "staticRecordLinkGroup": "GsaSlimRecordLinkGroup", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - is_reverse: "bool", - static_record_link_group: "GsaSlimRecordLinkGroup", - ) -> None: - """GsaStaticRecordLinkGroupMapping - a model defined in Swagger - - Parameters - ---------- - is_reverse: bool - static_record_link_group: GsaSlimRecordLinkGroup - """ - self._static_record_link_group: GsaSlimRecordLinkGroup - self._is_reverse: bool - - self.static_record_link_group = static_record_link_group - self.is_reverse = is_reverse - - @property - def static_record_link_group(self) -> "GsaSlimRecordLinkGroup": - """Gets the static_record_link_group of this GsaStaticRecordLinkGroupMapping. - - Returns - ------- - GsaSlimRecordLinkGroup - The static_record_link_group of this GsaStaticRecordLinkGroupMapping. - """ - return self._static_record_link_group - - @static_record_link_group.setter - def static_record_link_group(self, static_record_link_group: "GsaSlimRecordLinkGroup") -> None: - """Sets the static_record_link_group of this GsaStaticRecordLinkGroupMapping. - - Parameters - ---------- - static_record_link_group: GsaSlimRecordLinkGroup - The static_record_link_group of this GsaStaticRecordLinkGroupMapping. - """ - # Field is not nullable - if static_record_link_group is None: - raise ValueError("Invalid value for 'static_record_link_group', must not be 'None'") - # Field is required - if static_record_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'static_record_link_group', must not be 'Unset'") - self._static_record_link_group = static_record_link_group - - @property - def is_reverse(self) -> "bool": - """Gets the is_reverse of this GsaStaticRecordLinkGroupMapping. - - Returns - ------- - bool - The is_reverse of this GsaStaticRecordLinkGroupMapping. - """ - return self._is_reverse - - @is_reverse.setter - def is_reverse(self, is_reverse: "bool") -> None: - """Sets the is_reverse of this GsaStaticRecordLinkGroupMapping. - - Parameters - ---------- - is_reverse: bool - The is_reverse of this GsaStaticRecordLinkGroupMapping. - """ - # Field is not nullable - if is_reverse is None: - raise ValueError("Invalid value for 'is_reverse', must not be 'None'") - # Field is required - if is_reverse is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_reverse', must not be 'Unset'") - self._is_reverse = is_reverse - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStaticRecordLinkGroupMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_result.py deleted file mode 100644 index 781f6ddf..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_static_record_link_result.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_result import ( # noqa: F401 - GsaRecordLinkResult, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStaticRecordLinkResult(GsaRecordLinkResult): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.STATIC, - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStaticRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - notes: str | None, optional - """ - super().__init__(linked_record=linked_record, record_link_group_type=record_link_group_type) - self._notes: str | None | Unset_Type = Unset - - if notes is not Unset: - self.notes = notes - - @property - def notes(self) -> "str | None | Unset_Type": - """Gets the notes of this GsaStaticRecordLinkResult. - - Returns - ------- - str | None | Unset_Type - The notes of this GsaStaticRecordLinkResult. - """ - return self._notes - - @notes.setter - def notes(self, notes: "str | None | Unset_Type") -> None: - """Sets the notes of this GsaStaticRecordLinkResult. - - Parameters - ---------- - notes: str | None | Unset_Type - The notes of this GsaStaticRecordLinkResult. - """ - self._notes = notes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStaticRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subset.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subset.py index 69edfb52..487a6006 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subset.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subset.py @@ -136,7 +136,6 @@ def associated_layout(self, associated_layout: "GsaSlimLayout | Unset_Type") -> @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -148,7 +147,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subsets_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subsets_info.py index 84370a3e..871eafe5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subsets_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_subsets_info.py @@ -61,7 +61,7 @@ class GsaSubsetsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "subsets": "list[GsaSubset]", + "subsets": "list[GsaSlimSubset]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaSubsetsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "subsets": "GsaSubset", + "subsets": "GsaSlimSubset", } discriminator: Optional[str] = None @@ -77,37 +77,37 @@ class GsaSubsetsInfo(ModelBase): def __init__( self, *, - subsets: "list[GsaSubset] | None | Unset_Type" = Unset, + subsets: "list[GsaSlimSubset] | None | Unset_Type" = Unset, ) -> None: """GsaSubsetsInfo - a model defined in Swagger Parameters ---------- - subsets: list[GsaSubset] | None, optional + subsets: list[GsaSlimSubset] | None, optional """ - self._subsets: list[GsaSubset] | None | Unset_Type = Unset + self._subsets: list[GsaSlimSubset] | None | Unset_Type = Unset if subsets is not Unset: self.subsets = subsets @property - def subsets(self) -> "list[GsaSubset] | None | Unset_Type": + def subsets(self) -> "list[GsaSlimSubset] | None | Unset_Type": """Gets the subsets of this GsaSubsetsInfo. Returns ------- - list[GsaSubset] | None | Unset_Type + list[GsaSlimSubset] | None | Unset_Type The subsets of this GsaSubsetsInfo. """ return self._subsets @subsets.setter - def subsets(self, subsets: "list[GsaSubset] | None | Unset_Type") -> None: + def subsets(self, subsets: "list[GsaSlimSubset] | None | Unset_Type") -> None: """Sets the subsets of this GsaSubsetsInfo. Parameters ---------- - subsets: list[GsaSubset] | None | Unset_Type + subsets: list[GsaSlimSubset] | None | Unset_Type The subsets of this GsaSubsetsInfo. """ self._subsets = subsets diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail.py deleted file mode 100644 index 03e95fb0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.SWAPNAMEANDREVERSENAMECIRCULAR, - ) -> None: - """GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_symbol_cannot_contain_comma_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_symbol_cannot_contain_comma_unit_error_detail.py deleted file mode 100644 index 57686b25..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_symbol_cannot_contain_comma_unit_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSymbolCannotContainCommaUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "symbol": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "symbol": "symbol", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.SYMBOLCANNOTCONTAINCOMMA, - symbol: "str", - ) -> None: - """GsaSymbolCannotContainCommaUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - symbol: str - """ - super().__init__(message=message, reason=reason) - self._symbol: str - - self.symbol = symbol - - @property - def symbol(self) -> "str": - """Gets the symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - - Returns - ------- - str - The symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - """ - return self._symbol - - @symbol.setter - def symbol(self, symbol: "str") -> None: - """Sets the symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - - Parameters - ---------- - symbol: str - The symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - """ - # Field is not nullable - if symbol is None: - raise ValueError("Invalid value for 'symbol', must not be 'None'") - # Field is required - if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'symbol', must not be 'Unset'") - self._symbol = symbol - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSymbolCannotContainCommaUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_t_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_t_item.py deleted file mode 100644 index bdac2105..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_t_item.py +++ /dev/null @@ -1,105 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = {} - - attribute_map: dict[str, str] = {} - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - ) -> None: - """GsaTItem - a model defined in Swagger""" - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table.py index e03b3af6..c900138e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table.py @@ -61,7 +61,6 @@ class GsaTable(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "database_key": "str", "display_names": "dict(str, str)", "guid": "str", "is_hidden_from_browse": "bool", @@ -69,21 +68,14 @@ class GsaTable(ModelBase): "is_versioned": "bool", "layouts": "list[GsaSlimLayout]", "name": "str", - "order": "int", "subsets": "list[GsaSlimSubset]", "table_types": "list[str]", "version_state": "GsaVersionState", - "datasheet_footer": "str", - "datasheet_header": "str", "default_layout": "GsaSlimLayout", "default_subset": "GsaSlimSubset", - "legal_disclaimer": "str", - "quality_system": "GsaSlimNamedEntity", - "should_show_version_control_signatures": "bool", } attribute_map: dict[str, str] = { - "database_key": "databaseKey", "display_names": "displayNames", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", @@ -91,17 +83,11 @@ class GsaTable(ModelBase): "is_versioned": "isVersioned", "layouts": "layouts", "name": "name", - "order": "order", "subsets": "subsets", "table_types": "tableTypes", "version_state": "versionState", - "datasheet_footer": "datasheetFooter", - "datasheet_header": "datasheetHeader", "default_layout": "defaultLayout", "default_subset": "defaultSubset", - "legal_disclaimer": "legalDisclaimer", - "quality_system": "qualitySystem", - "should_show_version_control_signatures": "shouldShowVersionControlSignatures", } subtype_mapping: dict[str, str] = { @@ -110,7 +96,6 @@ class GsaTable(ModelBase): "defaultLayout": "GsaSlimLayout", "layouts": "GsaSlimLayout", "versionState": "GsaVersionState", - "qualitySystem": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -118,7 +103,6 @@ class GsaTable(ModelBase): def __init__( self, *, - database_key: "str", display_names: "dict[str, str]", guid: "str", is_hidden_from_browse: "bool", @@ -126,23 +110,16 @@ def __init__( is_versioned: "bool", layouts: "list[GsaSlimLayout]", name: "str", - order: "int", subsets: "list[GsaSlimSubset]", table_types: "list[str]", version_state: "GsaVersionState", - datasheet_footer: "str | None | Unset_Type" = Unset, - datasheet_header: "str | None | Unset_Type" = Unset, default_layout: "GsaSlimLayout | Unset_Type" = Unset, default_subset: "GsaSlimSubset | Unset_Type" = Unset, - legal_disclaimer: "str | None | Unset_Type" = Unset, - quality_system: "GsaSlimNamedEntity | Unset_Type" = Unset, - should_show_version_control_signatures: "bool | Unset_Type" = Unset, ) -> None: """GsaTable - a model defined in Swagger Parameters ---------- - database_key: str display_names: dict[str, str] guid: str is_hidden_from_browse: bool @@ -150,30 +127,17 @@ def __init__( is_versioned: bool layouts: list[GsaSlimLayout] name: str - order: int subsets: list[GsaSlimSubset] table_types: list[str] version_state: GsaVersionState - datasheet_footer: str | None, optional - datasheet_header: str | None, optional default_layout: GsaSlimLayout, optional default_subset: GsaSlimSubset, optional - legal_disclaimer: str | None, optional - quality_system: GsaSlimNamedEntity, optional - should_show_version_control_signatures: bool, optional """ self._default_subset: GsaSlimSubset | Unset_Type = Unset self._subsets: list[GsaSlimSubset] self._default_layout: GsaSlimLayout | Unset_Type = Unset self._layouts: list[GsaSlimLayout] self._version_state: GsaVersionState - self._order: int - self._quality_system: GsaSlimNamedEntity | Unset_Type = Unset - self._legal_disclaimer: str | None | Unset_Type = Unset - self._datasheet_header: str | None | Unset_Type = Unset - self._datasheet_footer: str | None | Unset_Type = Unset - self._should_show_version_control_signatures: bool | Unset_Type = Unset - self._database_key: str self._is_hidden_from_browse: bool self._is_hidden_from_search: bool self._is_versioned: bool @@ -189,18 +153,6 @@ def __init__( self.default_layout = default_layout self.layouts = layouts self.version_state = version_state - self.order = order - if quality_system is not Unset: - self.quality_system = quality_system - if legal_disclaimer is not Unset: - self.legal_disclaimer = legal_disclaimer - if datasheet_header is not Unset: - self.datasheet_header = datasheet_header - if datasheet_footer is not Unset: - self.datasheet_footer = datasheet_footer - if should_show_version_control_signatures is not Unset: - self.should_show_version_control_signatures = should_show_version_control_signatures - self.database_key = database_key self.is_hidden_from_browse = is_hidden_from_browse self.is_hidden_from_search = is_hidden_from_search self.is_versioned = is_versioned @@ -343,184 +295,6 @@ def version_state(self, version_state: "GsaVersionState") -> None: raise ValueError("Invalid value for 'version_state', must not be 'Unset'") self._version_state = version_state - @property - def order(self) -> "int": - """Gets the order of this GsaTable. - - Returns - ------- - int - The order of this GsaTable. - """ - return self._order - - @order.setter - def order(self, order: "int") -> None: - """Sets the order of this GsaTable. - - Parameters - ---------- - order: int - The order of this GsaTable. - """ - # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - # Field is required - if order is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'order', must not be 'Unset'") - self._order = order - - @property - def quality_system(self) -> "GsaSlimNamedEntity | Unset_Type": - """Gets the quality_system of this GsaTable. - - Returns - ------- - GsaSlimNamedEntity | Unset_Type - The quality_system of this GsaTable. - """ - return self._quality_system - - @quality_system.setter - def quality_system(self, quality_system: "GsaSlimNamedEntity | Unset_Type") -> None: - """Sets the quality_system of this GsaTable. - - Parameters - ---------- - quality_system: GsaSlimNamedEntity | Unset_Type - The quality_system of this GsaTable. - """ - # Field is not nullable - if quality_system is None: - raise ValueError("Invalid value for 'quality_system', must not be 'None'") - self._quality_system = quality_system - - @property - def legal_disclaimer(self) -> "str | None | Unset_Type": - """Gets the legal_disclaimer of this GsaTable. - - Returns - ------- - str | None | Unset_Type - The legal_disclaimer of this GsaTable. - """ - return self._legal_disclaimer - - @legal_disclaimer.setter - def legal_disclaimer(self, legal_disclaimer: "str | None | Unset_Type") -> None: - """Sets the legal_disclaimer of this GsaTable. - - Parameters - ---------- - legal_disclaimer: str | None | Unset_Type - The legal_disclaimer of this GsaTable. - """ - self._legal_disclaimer = legal_disclaimer - - @property - def datasheet_header(self) -> "str | None | Unset_Type": - """Gets the datasheet_header of this GsaTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_header of this GsaTable. - """ - return self._datasheet_header - - @datasheet_header.setter - def datasheet_header(self, datasheet_header: "str | None | Unset_Type") -> None: - """Sets the datasheet_header of this GsaTable. - - Parameters - ---------- - datasheet_header: str | None | Unset_Type - The datasheet_header of this GsaTable. - """ - self._datasheet_header = datasheet_header - - @property - def datasheet_footer(self) -> "str | None | Unset_Type": - """Gets the datasheet_footer of this GsaTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_footer of this GsaTable. - """ - return self._datasheet_footer - - @datasheet_footer.setter - def datasheet_footer(self, datasheet_footer: "str | None | Unset_Type") -> None: - """Sets the datasheet_footer of this GsaTable. - - Parameters - ---------- - datasheet_footer: str | None | Unset_Type - The datasheet_footer of this GsaTable. - """ - self._datasheet_footer = datasheet_footer - - @property - def should_show_version_control_signatures(self) -> "bool | Unset_Type": - """Gets the should_show_version_control_signatures of this GsaTable. - Gets or sets whether version control signatures should be shown when data is shown to a user. 'Version control signatures' show when a record was released, who released it and on which revision. - - Returns - ------- - bool | Unset_Type - The should_show_version_control_signatures of this GsaTable. - """ - return self._should_show_version_control_signatures - - @should_show_version_control_signatures.setter - def should_show_version_control_signatures( - self, should_show_version_control_signatures: "bool | Unset_Type" - ) -> None: - """Sets the should_show_version_control_signatures of this GsaTable. - Gets or sets whether version control signatures should be shown when data is shown to a user. 'Version control signatures' show when a record was released, who released it and on which revision. - - Parameters - ---------- - should_show_version_control_signatures: bool | Unset_Type - The should_show_version_control_signatures of this GsaTable. - """ - # Field is not nullable - if should_show_version_control_signatures is None: - raise ValueError( - "Invalid value for 'should_show_version_control_signatures', must not be 'None'" - ) - self._should_show_version_control_signatures = should_show_version_control_signatures - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaTable. - - Returns - ------- - str - The database_key of this GsaTable. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaTable. - - Parameters - ---------- - database_key: str - The database_key of this GsaTable. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - @property def is_hidden_from_browse(self) -> "bool": """Gets the is_hidden_from_browse of this GsaTable. @@ -636,7 +410,6 @@ def table_types(self, table_types: "list[str]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaTable. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -648,7 +421,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaTable. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_access_control_entity.py deleted file mode 100644 index 004b0a93..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_access_control_entity.py +++ /dev/null @@ -1,194 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity import ( # noqa: F401 - GsaAccessControlEntity, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity_type import ( - GsaAccessControlEntityType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableAccessControlEntity(GsaAccessControlEntity): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlEntityType", - "table_guid": "str", - "latest_version_filter": "list[GsaVersionControlMode]", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "table_guid": "tableGuid", - "latest_version_filter": "latestVersionFilter", - } - - subtype_mapping: dict[str, str] = { - "latestVersionFilter": "GsaVersionControlMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlEntityType" = GsaAccessControlEntityType.TABLE, - table_guid: "str", - latest_version_filter: "list[GsaVersionControlMode] | None | Unset_Type" = Unset, - ) -> None: - """GsaTableAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - table_guid: str - latest_version_filter: list[GsaVersionControlMode] | None, optional - """ - super().__init__(entity_type=entity_type) - self._table_guid: str - self._latest_version_filter: list[GsaVersionControlMode] | None | Unset_Type = Unset - - self.table_guid = table_guid - if latest_version_filter is not Unset: - self.latest_version_filter = latest_version_filter - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaTableAccessControlEntity. - - Returns - ------- - str - The table_guid of this GsaTableAccessControlEntity. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaTableAccessControlEntity. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaTableAccessControlEntity. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def latest_version_filter(self) -> "list[GsaVersionControlMode] | None | Unset_Type": - """Gets the latest_version_filter of this GsaTableAccessControlEntity. - Optional. If set, only include versions of the table that match this filter: - read: include only the latest version in read mode - write: include only the latest version in write mode - read and write: include the latest versions in read or write mode - empty: include versions that are not the latest in read or write mode If not set, include all versions - - Returns - ------- - list[GsaVersionControlMode] | None | Unset_Type - The latest_version_filter of this GsaTableAccessControlEntity. - """ - return self._latest_version_filter - - @latest_version_filter.setter - def latest_version_filter( - self, latest_version_filter: "list[GsaVersionControlMode] | None | Unset_Type" - ) -> None: - """Sets the latest_version_filter of this GsaTableAccessControlEntity. - Optional. If set, only include versions of the table that match this filter: - read: include only the latest version in read mode - write: include only the latest version in write mode - read and write: include the latest versions in read or write mode - empty: include versions that are not the latest in read or write mode If not set, include all versions - - Parameters - ---------- - latest_version_filter: list[GsaVersionControlMode] | None | Unset_Type - The latest_version_filter of this GsaTableAccessControlEntity. - """ - self._latest_version_filter = latest_version_filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_creation_exception.py deleted file mode 100644 index 0251a4a8..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaTableErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaTableErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaTableErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaTableCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaTableErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaTableErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaTableCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaTableCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaTableCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaTableCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaTableCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaTableCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaTableCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaTableCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaTableCreationException. - - Returns - ------- - str - The name of this GsaTableCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaTableCreationException. - - Parameters - ---------- - name: str - The name of this GsaTableCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaTableErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaTableCreationException. - - Returns - ------- - list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaTableErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaTableCreationException. - - Parameters - ---------- - errors: list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_deletion_exception.py index 28464088..7c408146 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_deletion_exception.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaTableDeletionException(GsaDeletionException): +class GsaTableDeletionException(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,31 +61,28 @@ class GsaTableDeletionException(GsaDeletionException): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", "code": "code", "errors": "errors", "message": "message", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "code": "SystemNetHttpStatusCode", + "errors": "GsaDataModificationErrorDetail", + } discriminator: Optional[str] = None def __init__( self, *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.TABLE, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -100,19 +90,89 @@ def __init__( Parameters ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) + self._message: str | None | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset + self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset + + if message is not Unset: + self.message = message + if code is not Unset: + self.code = code + if errors is not Unset: + self.errors = errors + + @property + def message(self) -> "str | None | Unset_Type": + """Gets the message of this GsaTableDeletionException. + + Returns + ------- + str | None | Unset_Type + The message of this GsaTableDeletionException. + """ + return self._message + + @message.setter + def message(self, message: "str | None | Unset_Type") -> None: + """Sets the message of this GsaTableDeletionException. + + Parameters + ---------- + message: str | None | Unset_Type + The message of this GsaTableDeletionException. + """ + self._message = message + + @property + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": + """Gets the code of this GsaTableDeletionException. + + Returns + ------- + SystemNetHttpStatusCode | Unset_Type + The code of this GsaTableDeletionException. + """ + return self._code + + @code.setter + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: + """Sets the code of this GsaTableDeletionException. + + Parameters + ---------- + code: SystemNetHttpStatusCode | Unset_Type + The code of this GsaTableDeletionException. + """ + # Field is not nullable + if code is None: + raise ValueError("Invalid value for 'code', must not be 'None'") + self._code = code + + @property + def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": + """Gets the errors of this GsaTableDeletionException. + + Returns + ------- + list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaTableDeletionException. + """ + return self._errors + + @errors.setter + def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: + """Sets the errors of this GsaTableDeletionException. + + Parameters + ---------- + errors: list[GsaDataModificationErrorDetail] | None | Unset_Type + The errors of this GsaTableDeletionException. + """ + self._errors = errors @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_descendants_access_control_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_descendants_access_control_entity.py deleted file mode 100644 index 67868865..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_descendants_access_control_entity.py +++ /dev/null @@ -1,225 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity import ( # noqa: F401 - GsaAccessControlEntity, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_entity_type import ( - GsaAccessControlEntityType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableDescendantsAccessControlEntity(GsaAccessControlEntity): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlEntityType", - "table_guid": "str", - "latest_version_filter": "list[GsaVersionControlMode]", - "subset_guid": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "table_guid": "tableGuid", - "latest_version_filter": "latestVersionFilter", - "subset_guid": "subsetGuid", - } - - subtype_mapping: dict[str, str] = { - "latestVersionFilter": "GsaVersionControlMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlEntityType" = GsaAccessControlEntityType.TABLEDESCENDANTS, - table_guid: "str", - latest_version_filter: "list[GsaVersionControlMode] | None | Unset_Type" = Unset, - subset_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaTableDescendantsAccessControlEntity - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlEntityType - table_guid: str - latest_version_filter: list[GsaVersionControlMode] | None, optional - subset_guid: str | None, optional - """ - super().__init__(entity_type=entity_type) - self._table_guid: str - self._subset_guid: str | None | Unset_Type = Unset - self._latest_version_filter: list[GsaVersionControlMode] | None | Unset_Type = Unset - - self.table_guid = table_guid - if subset_guid is not Unset: - self.subset_guid = subset_guid - if latest_version_filter is not Unset: - self.latest_version_filter = latest_version_filter - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaTableDescendantsAccessControlEntity. - - Returns - ------- - str - The table_guid of this GsaTableDescendantsAccessControlEntity. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaTableDescendantsAccessControlEntity. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaTableDescendantsAccessControlEntity. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def subset_guid(self) -> "str | None | Unset_Type": - """Gets the subset_guid of this GsaTableDescendantsAccessControlEntity. - Optional. If set, only include descendants in this subset - - Returns - ------- - str | None | Unset_Type - The subset_guid of this GsaTableDescendantsAccessControlEntity. - """ - return self._subset_guid - - @subset_guid.setter - def subset_guid(self, subset_guid: "str | None | Unset_Type") -> None: - """Sets the subset_guid of this GsaTableDescendantsAccessControlEntity. - Optional. If set, only include descendants in this subset - - Parameters - ---------- - subset_guid: str | None | Unset_Type - The subset_guid of this GsaTableDescendantsAccessControlEntity. - """ - self._subset_guid = subset_guid - - @property - def latest_version_filter(self) -> "list[GsaVersionControlMode] | None | Unset_Type": - """Gets the latest_version_filter of this GsaTableDescendantsAccessControlEntity. - Optional. If set, only include descendants that match this filter. For each descendant record history: - read: include only the record version that is the latest version in read mode. - write: include only the record version that is the latest version in write mode. - read and write: include the record versions that are the latest versions in read or write mode. - empty: include record versions that are not the latest version in read or write mode. If not set, include all versions of all descendant record histories. - - Returns - ------- - list[GsaVersionControlMode] | None | Unset_Type - The latest_version_filter of this GsaTableDescendantsAccessControlEntity. - """ - return self._latest_version_filter - - @latest_version_filter.setter - def latest_version_filter( - self, latest_version_filter: "list[GsaVersionControlMode] | None | Unset_Type" - ) -> None: - """Sets the latest_version_filter of this GsaTableDescendantsAccessControlEntity. - Optional. If set, only include descendants that match this filter. For each descendant record history: - read: include only the record version that is the latest version in read mode. - write: include only the record version that is the latest version in write mode. - read and write: include the record versions that are the latest versions in read or write mode. - empty: include record versions that are not the latest version in read or write mode. If not set, include all versions of all descendant record histories. - - Parameters - ---------- - latest_version_filter: list[GsaVersionControlMode] | None | Unset_Type - The latest_version_filter of this GsaTableDescendantsAccessControlEntity. - """ - self._latest_version_filter = latest_version_filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableDescendantsAccessControlEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_detail.py deleted file mode 100644 index 756282de..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaTableErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityTableErrorDetail", - "tableTypes".lower(): "#/components/schemas/GsaTableTypesErrorDetail", - "rootRecordNotAvailableToRename".lower(): "#/components/schemas/GsaRootRecordNotAvailableToRenameErrorDetail", - "defaultSubsetGuid".lower(): "#/components/schemas/GsaDefaultSubsetGuidErrorDetail", - "defaultLayoutGuid".lower(): "#/components/schemas/GsaDefaultLayoutGuidErrorDetail", - "qualitySystemGuid".lower(): "#/components/schemas/GsaQualitySystemGuidErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason", - ) -> None: - """GsaTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - """ - self._message: str - self._reason: GsaTableErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaTableErrorDetail. - - Returns - ------- - str - The message of this GsaTableErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaTableErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaTableErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaTableErrorReason": - """Gets the reason of this GsaTableErrorDetail. - - Returns - ------- - GsaTableErrorReason - The reason of this GsaTableErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaTableErrorReason") -> None: - """Sets the reason of this GsaTableErrorDetail. - - Parameters - ---------- - reason: GsaTableErrorReason - The reason of this GsaTableErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_reason.py deleted file mode 100644 index a80073aa..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_error_reason.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTableErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - TABLETYPES = "tableTypes" - ROOTRECORDNOTAVAILABLETORENAME = "rootRecordNotAvailableToRename" - DEFAULTSUBSETGUID = "defaultSubsetGuid" - DEFAULTLAYOUTGUID = "defaultLayoutGuid" - QUALITYSYSTEMGUID = "qualitySystemGuid" - TABLEGUIDS = "tableGuids" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_search_behaviour.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_search_behaviour.py deleted file mode 100644 index 35a64e18..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_search_behaviour.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTableSearchBehaviour(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ONLYINCLUDERECORDSFROMSEARCHABLETABLES = "OnlyIncludeRecordsFromSearchableTables" - ONLYINCLUDERECORDSFROMHIDDENFROMSEARCHTABLES = "OnlyIncludeRecordsFromHiddenFromSearchTables" - INCLUDERECORDSFROMALLTABLES = "IncludeRecordsFromAllTables" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_contains_comma_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_contains_comma_error_detail.py deleted file mode 100644 index cf055a24..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_contains_comma_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_type_error_detail import ( # noqa: F401 - GsaTableTypeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_type_error_reason import ( - GsaTableTypeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypeContainsCommaErrorDetail(GsaTableTypeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableTypeErrorReason", - "table_type": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "table_type": "tableType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableTypeErrorReason" = GsaTableTypeErrorReason.TABLETYPECONTAINSCOMMA, - table_type: "str", - ) -> None: - """GsaTableTypeContainsCommaErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableTypeErrorReason - table_type: str - """ - super().__init__(message=message, reason=reason) - self._table_type: str - - self.table_type = table_type - - @property - def table_type(self) -> "str": - """Gets the table_type of this GsaTableTypeContainsCommaErrorDetail. - - Returns - ------- - str - The table_type of this GsaTableTypeContainsCommaErrorDetail. - """ - return self._table_type - - @table_type.setter - def table_type(self, table_type: "str") -> None: - """Sets the table_type of this GsaTableTypeContainsCommaErrorDetail. - - Parameters - ---------- - table_type: str - The table_type of this GsaTableTypeContainsCommaErrorDetail. - """ - # Field is not nullable - if table_type is None: - raise ValueError("Invalid value for 'table_type', must not be 'None'") - # Field is required - if table_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_type', must not be 'Unset'") - self._table_type = table_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypeContainsCommaErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_detail.py deleted file mode 100644 index cde4389e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypeErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableTypeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaTableTypeErrorReason", - } - - discriminator_value_class_map = { - "emptyTableType".lower(): "#/components/schemas/GsaEmptyTableTypeErrorDetail", - "tableTypeContainsComma".lower(): "#/components/schemas/GsaTableTypeContainsCommaErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaTableTypeErrorReason", - ) -> None: - """GsaTableTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableTypeErrorReason - """ - self._message: str - self._reason: GsaTableTypeErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaTableTypeErrorDetail. - - Returns - ------- - str - The message of this GsaTableTypeErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaTableTypeErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaTableTypeErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaTableTypeErrorReason": - """Gets the reason of this GsaTableTypeErrorDetail. - - Returns - ------- - GsaTableTypeErrorReason - The reason of this GsaTableTypeErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaTableTypeErrorReason") -> None: - """Sets the reason of this GsaTableTypeErrorDetail. - - Parameters - ---------- - reason: GsaTableTypeErrorReason - The reason of this GsaTableTypeErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_reason.py deleted file mode 100644 index f452b84f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_type_error_reason.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTableTypeErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - EMPTYTABLETYPE = "emptyTableType" - TABLETYPECONTAINSCOMMA = "tableTypeContainsComma" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_error_detail.py deleted file mode 100644 index c9fd20a1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypesErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaTableTypeErrorDetail]", - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaTableTypeErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaTableTypeErrorDetail]", - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.TABLETYPES, - ) -> None: - """GsaTableTypesErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaTableTypeErrorDetail] - message: str - reason: GsaTableErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaTableTypeErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaTableTypeErrorDetail]": - """Gets the errors of this GsaTableTypesErrorDetail. - - Returns - ------- - list[GsaTableTypeErrorDetail] - The errors of this GsaTableTypesErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaTableTypeErrorDetail]") -> None: - """Sets the errors of this GsaTableTypesErrorDetail. - - Parameters - ---------- - errors: list[GsaTableTypeErrorDetail] - The errors of this GsaTableTypesErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_info.py deleted file mode 100644 index c8472451..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_types_info.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_types": "list[str]", - } - - attribute_map: dict[str, str] = { - "table_types": "tableTypes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_types: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaTableTypesInfo - a model defined in Swagger - - Parameters - ---------- - table_types: list[str] | None, optional - """ - self._table_types: list[str] | None | Unset_Type = Unset - - if table_types is not Unset: - self.table_types = table_types - - @property - def table_types(self) -> "list[str] | None | Unset_Type": - """Gets the table_types of this GsaTableTypesInfo. - - Returns - ------- - list[str] | None | Unset_Type - The table_types of this GsaTableTypesInfo. - """ - return self._table_types - - @table_types.setter - def table_types(self, table_types: "list[str] | None | Unset_Type") -> None: - """Sets the table_types of this GsaTableTypesInfo. - - Parameters - ---------- - table_types: list[str] | None | Unset_Type - The table_types of this GsaTableTypesInfo. - """ - self._table_types = table_types - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_update_exception.py deleted file mode 100644 index bf21bdd3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaTableErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaTableErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaTableErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaTableUpdateException - a model defined in Swagger - - Parameters - ---------- - table_guid: str - code: GsaErrorCode, optional - errors: list[GsaTableErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._table_guid: str - self._errors: list[GsaTableErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.table_guid = table_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaTableUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaTableUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaTableUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaTableUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaTableUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaTableUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaTableUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaTableUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaTableUpdateException. - - Returns - ------- - str - The table_guid of this GsaTableUpdateException. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaTableUpdateException. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaTableUpdateException. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def errors(self) -> "list[GsaTableErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaTableUpdateException. - - Returns - ------- - list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaTableErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaTableUpdateException. - - Parameters - ---------- - errors: list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_usage_data_modification_error_detail.py deleted file mode 100644 index 7f860fa6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_usage_data_modification_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimNamedEntity]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.TABLE, - referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaTableUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimNamedEntity] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaTableUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaTableUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaTableUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaTableUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_version_state_access_control_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_version_state_access_control_category_error_detail.py deleted file mode 100644 index df19ac7c..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_table_version_state_access_control_category_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableVersionStateAccessControlCategoryErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.TABLEVERSIONSTATE, - ) -> None: - """GsaTableVersionStateAccessControlCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableVersionStateAccessControlCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tables_missing_reorder_tables_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tables_missing_reorder_tables_error_detail.py deleted file mode 100644 index 1adb6027..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tables_missing_reorder_tables_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_reorder_tables_error_detail import ( # noqa: F401 - GsaReorderTablesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_reorder_tables_error_reason import ( - GsaReorderTablesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTablesMissingReorderTablesErrorDetail(GsaReorderTablesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaReorderTablesErrorReason", - "missing_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "missing_guids": "missingGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaReorderTablesErrorReason" = GsaReorderTablesErrorReason.TABLESMISSING, - missing_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaTablesMissingReorderTablesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaReorderTablesErrorReason - missing_guids: list[str] | None, optional - """ - super().__init__(message=message, reason=reason) - self._missing_guids: list[str] | None | Unset_Type = Unset - - if missing_guids is not Unset: - self.missing_guids = missing_guids - - @property - def missing_guids(self) -> "list[str] | None | Unset_Type": - """Gets the missing_guids of this GsaTablesMissingReorderTablesErrorDetail. - - Returns - ------- - list[str] | None | Unset_Type - The missing_guids of this GsaTablesMissingReorderTablesErrorDetail. - """ - return self._missing_guids - - @missing_guids.setter - def missing_guids(self, missing_guids: "list[str] | None | Unset_Type") -> None: - """Sets the missing_guids of this GsaTablesMissingReorderTablesErrorDetail. - - Parameters - ---------- - missing_guids: list[str] | None | Unset_Type - The missing_guids of this GsaTablesMissingReorderTablesErrorDetail. - """ - self._missing_guids = missing_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTablesMissingReorderTablesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute.py index ccf7dcd3..8cb18476 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute.py @@ -72,7 +72,6 @@ class GsaTabularAttribute(GsaAttribute): "hide_unlinked_rows": "bool", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "tabular_columns": "list[GsaTabularColumn]", @@ -92,7 +91,6 @@ class GsaTabularAttribute(GsaAttribute): "hide_unlinked_rows": "hideUnlinkedRows", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "tabular_columns": "tabularColumns", @@ -121,7 +119,6 @@ def __init__( hide_unlinked_rows: "bool", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", tabular_columns: "list[GsaTabularColumn]", @@ -143,7 +140,6 @@ def __init__( hide_unlinked_rows: bool info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity tabular_columns: list[GsaTabularColumn] @@ -159,7 +155,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute_link.py deleted file mode 100644 index daba7213..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_attribute_link.py +++ /dev/null @@ -1,191 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTabularAttributeLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "link_info": "GsaLinkInfo", - "name": "str", - "reverse_name": "str", - "target_attribute": "GsaSlimEntity", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "link_info": "linkInfo", - "name": "name", - "reverse_name": "reverseName", - "target_attribute": "targetAttribute", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = { - "targetAttribute": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - link_info: "GsaLinkInfo", - name: "str", - reverse_name: "str", - target_attribute: "GsaSlimEntity", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.TABULARATTRIBUTE, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaTabularAttributeLink - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - link_info: GsaLinkInfo - name: str - reverse_name: str - target_attribute: GsaSlimEntity - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._target_attribute: GsaSlimEntity - - self.target_attribute = target_attribute - - @property - def target_attribute(self) -> "GsaSlimEntity": - """Gets the target_attribute of this GsaTabularAttributeLink. - - Returns - ------- - GsaSlimEntity - The target_attribute of this GsaTabularAttributeLink. - """ - return self._target_attribute - - @target_attribute.setter - def target_attribute(self, target_attribute: "GsaSlimEntity") -> None: - """Sets the target_attribute of this GsaTabularAttributeLink. - - Parameters - ---------- - target_attribute: GsaSlimEntity - The target_attribute of this GsaTabularAttributeLink. - """ - # Field is not nullable - if target_attribute is None: - raise ValueError("Invalid value for 'target_attribute', must not be 'None'") - # Field is required - if target_attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_attribute', must not be 'Unset'") - self._target_attribute = target_attribute - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTabularAttributeLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column.py index 8a4a706a..54d97685 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column.py @@ -67,13 +67,11 @@ class GsaTabularColumn(ModelBase): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -81,13 +79,11 @@ class GsaTabularColumn(ModelBase): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -123,13 +119,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaTabularColumn - a model defined in Swagger @@ -139,20 +133,16 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ self._column_type: GsaTabularColumnDtoType self._show_as_link: bool self._summary_row_enabled: bool self._summary_row_text: str - self._summary_row_translations: dict[str, str] - self._order: int self._roll_up_type: GsaTabularColumnRollUpType self._summary_row_roll_up_type: GsaTabularColumnRollUpType self._display_names: dict[str, str] @@ -163,8 +153,6 @@ def __init__( self.show_as_link = show_as_link self.summary_row_enabled = summary_row_enabled self.summary_row_text = summary_row_text - self.summary_row_translations = summary_row_translations - self.order = order self.roll_up_type = roll_up_type self.summary_row_roll_up_type = summary_row_roll_up_type self.display_names = display_names @@ -283,66 +271,6 @@ def summary_row_text(self, summary_row_text: "str") -> None: raise ValueError("Invalid value for 'summary_row_text', must not be 'Unset'") self._summary_row_text = summary_row_text - @property - def summary_row_translations(self) -> "dict[str, str]": - """Gets the summary_row_translations of this GsaTabularColumn. - A dictionary of the culture name to the row text that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The summary_row_translations of this GsaTabularColumn. - """ - return self._summary_row_translations - - @summary_row_translations.setter - def summary_row_translations(self, summary_row_translations: "dict[str, str]") -> None: - """Sets the summary_row_translations of this GsaTabularColumn. - A dictionary of the culture name to the row text that should be used in that culture for the item - - Parameters - ---------- - summary_row_translations: dict[str, str] - The summary_row_translations of this GsaTabularColumn. - """ - # Field is not nullable - if summary_row_translations is None: - raise ValueError("Invalid value for 'summary_row_translations', must not be 'None'") - # Field is required - if summary_row_translations is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'summary_row_translations', must not be 'Unset'") - self._summary_row_translations = summary_row_translations - - @property - def order(self) -> "int": - """Gets the order of this GsaTabularColumn. - The order that this column appears in the tabular attribute. Columns on an attribute object are returned from the API in the correct sorted order. - - Returns - ------- - int - The order of this GsaTabularColumn. - """ - return self._order - - @order.setter - def order(self, order: "int") -> None: - """Sets the order of this GsaTabularColumn. - The order that this column appears in the tabular attribute. Columns on an attribute object are returned from the API in the correct sorted order. - - Parameters - ---------- - order: int - The order of this GsaTabularColumn. - """ - # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - # Field is required - if order is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'order', must not be 'Unset'") - self._order = order - @property def roll_up_type(self) -> "GsaTabularColumnRollUpType": """Gets the roll_up_type of this GsaTabularColumn. @@ -404,7 +332,6 @@ def summary_row_roll_up_type( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaTabularColumn. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -416,7 +343,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaTabularColumn. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column_usage_data_modification_error_detail.py deleted file mode 100644 index 9b4ab315..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_tabular_column_usage_data_modification_error_detail.py +++ /dev/null @@ -1,169 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTabularColumnUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaTabularAttributeWithColumns]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaTabularAttributeWithColumns", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.TABULARCOLUMN, - referenced_by: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" = Unset, - ) -> None: - """GsaTabularColumnUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaTabularAttributeWithColumns] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaTabularAttributeWithColumns] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaTabularAttributeWithColumns] | None | Unset_Type": - """Gets the referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaTabularAttributeWithColumns] | None | Unset_Type - The referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by( - self, referenced_by: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" - ) -> None: - """Sets the referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaTabularAttributeWithColumns] | None | Unset_Type - The referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTabularColumnUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute.py deleted file mode 100644 index 4112e299..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTargetAttribute(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "target_type": "GsaTargetAttributeType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "target_type": "targetType", - } - - subtype_mapping: dict[str, str] = { - "targetType": "GsaTargetAttributeType", - } - - discriminator_value_class_map = { - "resolved".lower(): "#/components/schemas/GsaResolvedTargetAttribute", - "unresolved".lower(): "#/components/schemas/GsaUnresolvedTargetAttribute", - } - - discriminator: Optional[str] = "targetType" - - def __init__( - self, - *, - guid: "str", - target_type: "GsaTargetAttributeType", - ) -> None: - """GsaTargetAttribute - a model defined in Swagger - - Parameters - ---------- - guid: str - target_type: GsaTargetAttributeType - """ - self._target_type: GsaTargetAttributeType - self._guid: str - - self.target_type = target_type - self.guid = guid - - @property - def target_type(self) -> "GsaTargetAttributeType": - """Gets the target_type of this GsaTargetAttribute. - - Returns - ------- - GsaTargetAttributeType - The target_type of this GsaTargetAttribute. - """ - return self._target_type - - @target_type.setter - def target_type(self, target_type: "GsaTargetAttributeType") -> None: - """Sets the target_type of this GsaTargetAttribute. - - Parameters - ---------- - target_type: GsaTargetAttributeType - The target_type of this GsaTargetAttribute. - """ - # Field is not nullable - if target_type is None: - raise ValueError("Invalid value for 'target_type', must not be 'None'") - # Field is required - if target_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_type', must not be 'Unset'") - self._target_type = target_type - - @property - def guid(self) -> "str": - """Gets the guid of this GsaTargetAttribute. - - Returns - ------- - str - The guid of this GsaTargetAttribute. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaTargetAttribute. - - Parameters - ---------- - guid: str - The guid of this GsaTargetAttribute. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTargetAttribute): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute_type.py deleted file mode 100644 index 9c00e227..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_attribute_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTargetAttributeType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - RESOLVED = "resolved" - UNRESOLVED = "unresolved" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_not_fully_specified_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_not_fully_specified_attribute_error_detail.py deleted file mode 100644 index 6b8a3e2d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_target_not_fully_specified_attribute_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTargetNotFullySpecifiedAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "missing_properties": "list[str]", - "reason": "GsaAttributeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "missing_properties": "missingProperties", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - missing_properties: "list[str]", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.TARGETNOTFULLYSPECIFIED, - ) -> None: - """GsaTargetNotFullySpecifiedAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - missing_properties: list[str] - reason: GsaAttributeErrorReason - """ - super().__init__(message=message, reason=reason) - self._missing_properties: list[str] - - self.missing_properties = missing_properties - - @property - def missing_properties(self) -> "list[str]": - """Gets the missing_properties of this GsaTargetNotFullySpecifiedAttributeErrorDetail. - - Returns - ------- - list[str] - The missing_properties of this GsaTargetNotFullySpecifiedAttributeErrorDetail. - """ - return self._missing_properties - - @missing_properties.setter - def missing_properties(self, missing_properties: "list[str]") -> None: - """Sets the missing_properties of this GsaTargetNotFullySpecifiedAttributeErrorDetail. - - Parameters - ---------- - missing_properties: list[str] - The missing_properties of this GsaTargetNotFullySpecifiedAttributeErrorDetail. - """ - # Field is not nullable - if missing_properties is None: - raise ValueError("Invalid value for 'missing_properties', must not be 'None'") - # Field is required - if missing_properties is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'missing_properties', must not be 'Unset'") - self._missing_properties = missing_properties - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTargetNotFullySpecifiedAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_empty_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_empty_error_detail.py deleted file mode 100644 index 50d76ca2..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_empty_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_detail import ( # noqa: F401 - GsaQualitySystemErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_reason import ( - GsaQualitySystemErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaThresholdValueNameEmptyErrorDetail(GsaQualitySystemErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaQualitySystemErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaQualitySystemErrorReason" = GsaQualitySystemErrorReason.THRESHOLDVALUENAMEEMPTY, - ) -> None: - """GsaThresholdValueNameEmptyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaQualitySystemErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaThresholdValueNameEmptyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_invalid_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_invalid_error_detail.py deleted file mode 100644 index 6810e105..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_threshold_value_name_invalid_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_detail import ( # noqa: F401 - GsaQualitySystemErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_quality_system_error_reason import ( - GsaQualitySystemErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaThresholdValueNameInvalidErrorDetail(GsaQualitySystemErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaQualitySystemErrorReason", - "threshold_value_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "threshold_value_name": "thresholdValueName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaQualitySystemErrorReason" = GsaQualitySystemErrorReason.THRESHOLDVALUENAMEINVALID, - threshold_value_name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaThresholdValueNameInvalidErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaQualitySystemErrorReason - threshold_value_name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._threshold_value_name: str | None | Unset_Type = Unset - - if threshold_value_name is not Unset: - self.threshold_value_name = threshold_value_name - - @property - def threshold_value_name(self) -> "str | None | Unset_Type": - """Gets the threshold_value_name of this GsaThresholdValueNameInvalidErrorDetail. - - Returns - ------- - str | None | Unset_Type - The threshold_value_name of this GsaThresholdValueNameInvalidErrorDetail. - """ - return self._threshold_value_name - - @threshold_value_name.setter - def threshold_value_name(self, threshold_value_name: "str | None | Unset_Type") -> None: - """Sets the threshold_value_name of this GsaThresholdValueNameInvalidErrorDetail. - - Parameters - ---------- - threshold_value_name: str | None | Unset_Type - The threshold_value_name of this GsaThresholdValueNameInvalidErrorDetail. - """ - self._threshold_value_name = threshold_value_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaThresholdValueNameInvalidErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_long_code_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_long_code_currency_error_detail.py deleted file mode 100644 index 4247fd86..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_long_code_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooLongCodeCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.TOOLONGCODE, - ) -> None: - """GsaTooLongCodeCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooLongCodeCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_attribute_pairs_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_attribute_pairs_smart_attributes_error_detail.py deleted file mode 100644 index 1af35585..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_attribute_pairs_smart_attributes_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooManyAttributePairsSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "number_of_attribute_pairs": "int", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "number_of_attribute_pairs": "numberOfAttributePairs", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - number_of_attribute_pairs: "int", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.TOOMANYATTRIBUTEPAIRS, - ) -> None: - """GsaTooManyAttributePairsSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - number_of_attribute_pairs: int - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - self._number_of_attribute_pairs: int - - self.number_of_attribute_pairs = number_of_attribute_pairs - - @property - def number_of_attribute_pairs(self) -> "int": - """Gets the number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - - Returns - ------- - int - The number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - """ - return self._number_of_attribute_pairs - - @number_of_attribute_pairs.setter - def number_of_attribute_pairs(self, number_of_attribute_pairs: "int") -> None: - """Sets the number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - - Parameters - ---------- - number_of_attribute_pairs: int - The number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - """ - # Field is not nullable - if number_of_attribute_pairs is None: - raise ValueError("Invalid value for 'number_of_attribute_pairs', must not be 'None'") - # Field is required - if number_of_attribute_pairs is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_of_attribute_pairs', must not be 'Unset'") - self._number_of_attribute_pairs = number_of_attribute_pairs - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooManyAttributePairsSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_permission_category_error_detail.py deleted file mode 100644 index 5d6679ee..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooManyPermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "max_number_of_permissions": "int", - "message": "str", - "number_of_new_permissions": "int", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "max_number_of_permissions": "maxNumberOfPermissions", - "message": "message", - "number_of_new_permissions": "numberOfNewPermissions", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - max_number_of_permissions: "int", - message: "str", - number_of_new_permissions: "int", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.TOOMANYPERMISSIONS, - ) -> None: - """GsaTooManyPermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - max_number_of_permissions: int - message: str - number_of_new_permissions: int - reason: GsaPermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._number_of_new_permissions: int - self._max_number_of_permissions: int - - self.number_of_new_permissions = number_of_new_permissions - self.max_number_of_permissions = max_number_of_permissions - - @property - def number_of_new_permissions(self) -> "int": - """Gets the number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Returns - ------- - int - The number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - return self._number_of_new_permissions - - @number_of_new_permissions.setter - def number_of_new_permissions(self, number_of_new_permissions: "int") -> None: - """Sets the number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - number_of_new_permissions: int - The number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if number_of_new_permissions is None: - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'None'") - # Field is required - if number_of_new_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'Unset'") - self._number_of_new_permissions = number_of_new_permissions - - @property - def max_number_of_permissions(self) -> "int": - """Gets the max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Returns - ------- - int - The max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - return self._max_number_of_permissions - - @max_number_of_permissions.setter - def max_number_of_permissions(self, max_number_of_permissions: "int") -> None: - """Sets the max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - max_number_of_permissions: int - The max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if max_number_of_permissions is None: - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'None'") - # Field is required - if max_number_of_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'Unset'") - self._max_number_of_permissions = max_number_of_permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooManyPermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_replace_permission_category_error_detail.py deleted file mode 100644 index ae1b798b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_too_many_permissions_replace_permission_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooManyPermissionsReplacePermissionCategoryErrorDetail( - GsaReplacePermissionCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "max_number_of_permissions": "int", - "message": "str", - "number_of_new_permissions": "int", - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "max_number_of_permissions": "maxNumberOfPermissions", - "message": "message", - "number_of_new_permissions": "numberOfNewPermissions", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - max_number_of_permissions: "int", - message: "str", - number_of_new_permissions: "int", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.TOOMANYPERMISSIONS, - ) -> None: - """GsaTooManyPermissionsReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - max_number_of_permissions: int - message: str - number_of_new_permissions: int - reason: GsaReplacePermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._number_of_new_permissions: int - self._max_number_of_permissions: int - - self.number_of_new_permissions = number_of_new_permissions - self.max_number_of_permissions = max_number_of_permissions - - @property - def number_of_new_permissions(self) -> "int": - """Gets the number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Returns - ------- - int - The number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - return self._number_of_new_permissions - - @number_of_new_permissions.setter - def number_of_new_permissions(self, number_of_new_permissions: "int") -> None: - """Sets the number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - number_of_new_permissions: int - The number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if number_of_new_permissions is None: - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'None'") - # Field is required - if number_of_new_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'Unset'") - self._number_of_new_permissions = number_of_new_permissions - - @property - def max_number_of_permissions(self) -> "int": - """Gets the max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Returns - ------- - int - The max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - return self._max_number_of_permissions - - @max_number_of_permissions.setter - def max_number_of_permissions(self, max_number_of_permissions: "int") -> None: - """Sets the max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - max_number_of_permissions: int - The max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if max_number_of_permissions is None: - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'None'") - # Field is required - if max_number_of_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'Unset'") - self._max_number_of_permissions = max_number_of_permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooManyPermissionsReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_guids_to_identities_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_guids_to_identities_request.py index d92f6613..2d0ea8b5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_guids_to_identities_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_guids_to_identities_request.py @@ -64,7 +64,6 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "database_key": "str", "attributes": "list[GsaSlimEntity]", "constants": "list[GsaSlimEntity]", - "cross_database_link_groups": "list[GsaSlimEntity]", "data": "list[GsaSlimEntity]", "discrete_types": "list[GsaSlimEntity]", "discrete_values": "list[GsaSlimEntity]", @@ -74,12 +73,9 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "record_link_groups": "list[GsaSlimEntity]", "record_versions": "list[GsaSlimEntity]", "replacement_strings": "list[GsaSlimEntity]", - "search_masks": "list[GsaSlimEntity]", - "search_templates": "list[GsaSlimEntity]", "standard_names": "list[GsaSlimEntity]", "subsets": "list[GsaSlimEntity]", "tables": "list[GsaSlimEntity]", - "tabular_columns": "list[GsaSlimEntity]", "unit_systems": "list[GsaSlimEntity]", "units": "list[GsaSlimEntity]", } @@ -88,7 +84,6 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "database_key": "databaseKey", "attributes": "attributes", "constants": "constants", - "cross_database_link_groups": "crossDatabaseLinkGroups", "data": "data", "discrete_types": "discreteTypes", "discrete_values": "discreteValues", @@ -98,12 +93,9 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "record_link_groups": "recordLinkGroups", "record_versions": "recordVersions", "replacement_strings": "replacementStrings", - "search_masks": "searchMasks", - "search_templates": "searchTemplates", "standard_names": "standardNames", "subsets": "subsets", "tables": "tables", - "tabular_columns": "tabularColumns", "unit_systems": "unitSystems", "units": "units", } @@ -124,11 +116,7 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "standardNames": "GsaSlimEntity", "constants": "GsaSlimEntity", "recordLinkGroups": "GsaSlimEntity", - "crossDatabaseLinkGroups": "GsaSlimEntity", - "tabularColumns": "GsaSlimEntity", "data": "GsaSlimEntity", - "searchMasks": "GsaSlimEntity", - "searchTemplates": "GsaSlimEntity", } discriminator: Optional[str] = None @@ -139,7 +127,6 @@ def __init__( database_key: "str", attributes: "list[GsaSlimEntity] | None | Unset_Type" = Unset, constants: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - cross_database_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, data: "list[GsaSlimEntity] | None | Unset_Type" = Unset, discrete_types: "list[GsaSlimEntity] | None | Unset_Type" = Unset, discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, @@ -149,12 +136,9 @@ def __init__( record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, record_versions: "list[GsaSlimEntity] | None | Unset_Type" = Unset, replacement_strings: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - search_masks: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - search_templates: "list[GsaSlimEntity] | None | Unset_Type" = Unset, standard_names: "list[GsaSlimEntity] | None | Unset_Type" = Unset, subsets: "list[GsaSlimEntity] | None | Unset_Type" = Unset, tables: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - tabular_columns: "list[GsaSlimEntity] | None | Unset_Type" = Unset, unit_systems: "list[GsaSlimEntity] | None | Unset_Type" = Unset, units: "list[GsaSlimEntity] | None | Unset_Type" = Unset, ) -> None: @@ -165,7 +149,6 @@ def __init__( database_key: str attributes: list[GsaSlimEntity] | None, optional constants: list[GsaSlimEntity] | None, optional - cross_database_link_groups: list[GsaSlimEntity] | None, optional data: list[GsaSlimEntity] | None, optional discrete_types: list[GsaSlimEntity] | None, optional discrete_values: list[GsaSlimEntity] | None, optional @@ -175,12 +158,9 @@ def __init__( record_link_groups: list[GsaSlimEntity] | None, optional record_versions: list[GsaSlimEntity] | None, optional replacement_strings: list[GsaSlimEntity] | None, optional - search_masks: list[GsaSlimEntity] | None, optional - search_templates: list[GsaSlimEntity] | None, optional standard_names: list[GsaSlimEntity] | None, optional subsets: list[GsaSlimEntity] | None, optional tables: list[GsaSlimEntity] | None, optional - tabular_columns: list[GsaSlimEntity] | None, optional unit_systems: list[GsaSlimEntity] | None, optional units: list[GsaSlimEntity] | None, optional """ @@ -200,11 +180,7 @@ def __init__( self._standard_names: list[GsaSlimEntity] | None | Unset_Type = Unset self._constants: list[GsaSlimEntity] | None | Unset_Type = Unset self._record_link_groups: list[GsaSlimEntity] | None | Unset_Type = Unset - self._cross_database_link_groups: list[GsaSlimEntity] | None | Unset_Type = Unset - self._tabular_columns: list[GsaSlimEntity] | None | Unset_Type = Unset self._data: list[GsaSlimEntity] | None | Unset_Type = Unset - self._search_masks: list[GsaSlimEntity] | None | Unset_Type = Unset - self._search_templates: list[GsaSlimEntity] | None | Unset_Type = Unset self.database_key = database_key if attributes is not Unset: @@ -237,16 +213,8 @@ def __init__( self.constants = constants if record_link_groups is not Unset: self.record_link_groups = record_link_groups - if cross_database_link_groups is not Unset: - self.cross_database_link_groups = cross_database_link_groups - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns if data is not Unset: self.data = data - if search_masks is not Unset: - self.search_masks = search_masks - if search_templates is not Unset: - self.search_templates = search_templates @property def database_key(self) -> "str": @@ -610,52 +578,6 @@ def record_link_groups( """ self._record_link_groups = record_link_groups - @property - def cross_database_link_groups(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._cross_database_link_groups - - @cross_database_link_groups.setter - def cross_database_link_groups( - self, cross_database_link_groups: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - cross_database_link_groups: list[GsaSlimEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._cross_database_link_groups = cross_database_link_groups - - @property - def tabular_columns(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._tabular_columns - - @tabular_columns.setter - def tabular_columns(self, tabular_columns: "list[GsaSlimEntity] | None | Unset_Type") -> None: - """Sets the tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - tabular_columns: list[GsaSlimEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._tabular_columns = tabular_columns - @property def data(self) -> "list[GsaSlimEntity] | None | Unset_Type": """Gets the data of this GsaTranslateGuidsToIdentitiesRequest. @@ -678,50 +600,6 @@ def data(self, data: "list[GsaSlimEntity] | None | Unset_Type") -> None: """ self._data = data - @property - def search_masks(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the search_masks of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The search_masks of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._search_masks - - @search_masks.setter - def search_masks(self, search_masks: "list[GsaSlimEntity] | None | Unset_Type") -> None: - """Sets the search_masks of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - search_masks: list[GsaSlimEntity] | None | Unset_Type - The search_masks of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._search_masks = search_masks - - @property - def search_templates(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the search_templates of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The search_templates of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._search_templates - - @search_templates.setter - def search_templates(self, search_templates: "list[GsaSlimEntity] | None | Unset_Type") -> None: - """Sets the search_templates of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - search_templates: list[GsaSlimEntity] | None | Unset_Type - The search_templates of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._search_templates = search_templates - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_between_guids_and_identities_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_guids_to_identities_response.py similarity index 64% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_between_guids_and_identities_response.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_guids_to_identities_response.py index eb6ebe57..9b34a564 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_between_guids_and_identities_response.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_guids_to_identities_response.py @@ -42,7 +42,7 @@ from . import * -class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): +class GsaTranslateGuidsToIdentitiesResponse(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -64,7 +64,6 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "database_key": "str", "attributes": "list[GsaSlimIdentifiedEntity]", "constants": "list[GsaSlimIdentifiedEntity]", - "cross_database_link_groups": "list[GsaSlimIdentifiedEntity]", "data": "list[GsaSlimIdentifiedEntity]", "discrete_types": "list[GsaSlimIdentifiedEntity]", "discrete_values": "list[GsaSlimIdentifiedEntity]", @@ -74,12 +73,9 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "record_link_groups": "list[GsaSlimIdentifiedEntity]", "record_versions": "list[GsaSlimIdentifiedEntity]", "replacement_strings": "list[GsaSlimIdentifiedEntity]", - "search_masks": "list[GsaSlimIdentifiedEntity]", - "search_templates": "list[GsaSlimIdentifiedEntity]", "standard_names": "list[GsaSlimIdentifiedEntity]", "subsets": "list[GsaSlimIdentifiedEntity]", "tables": "list[GsaSlimIdentifiedEntity]", - "tabular_columns": "list[GsaSlimIdentifiedEntity]", "unit_systems": "list[GsaSlimIdentifiedEntity]", "units": "list[GsaSlimIdentifiedEntity]", } @@ -88,7 +84,6 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "database_key": "databaseKey", "attributes": "attributes", "constants": "constants", - "cross_database_link_groups": "crossDatabaseLinkGroups", "data": "data", "discrete_types": "discreteTypes", "discrete_values": "discreteValues", @@ -98,12 +93,9 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "record_link_groups": "recordLinkGroups", "record_versions": "recordVersions", "replacement_strings": "replacementStrings", - "search_masks": "searchMasks", - "search_templates": "searchTemplates", "standard_names": "standardNames", "subsets": "subsets", "tables": "tables", - "tabular_columns": "tabularColumns", "unit_systems": "unitSystems", "units": "units", } @@ -124,11 +116,7 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "standardNames": "GsaSlimIdentifiedEntity", "constants": "GsaSlimIdentifiedEntity", "recordLinkGroups": "GsaSlimIdentifiedEntity", - "crossDatabaseLinkGroups": "GsaSlimIdentifiedEntity", - "tabularColumns": "GsaSlimIdentifiedEntity", "data": "GsaSlimIdentifiedEntity", - "searchMasks": "GsaSlimIdentifiedEntity", - "searchTemplates": "GsaSlimIdentifiedEntity", } discriminator: Optional[str] = None @@ -139,7 +127,6 @@ def __init__( database_key: "str", attributes: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, constants: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - cross_database_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, data: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, discrete_types: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, discrete_values: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, @@ -149,23 +136,19 @@ def __init__( record_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, record_versions: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, replacement_strings: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - search_masks: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - search_templates: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, standard_names: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, subsets: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, tables: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - tabular_columns: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, unit_systems: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, units: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, ) -> None: - """GsaTranslateBetweenGuidsAndIdentitiesResponse - a model defined in Swagger + """GsaTranslateGuidsToIdentitiesResponse - a model defined in Swagger Parameters ---------- database_key: str attributes: list[GsaSlimIdentifiedEntity] | None, optional constants: list[GsaSlimIdentifiedEntity] | None, optional - cross_database_link_groups: list[GsaSlimIdentifiedEntity] | None, optional data: list[GsaSlimIdentifiedEntity] | None, optional discrete_types: list[GsaSlimIdentifiedEntity] | None, optional discrete_values: list[GsaSlimIdentifiedEntity] | None, optional @@ -175,12 +158,9 @@ def __init__( record_link_groups: list[GsaSlimIdentifiedEntity] | None, optional record_versions: list[GsaSlimIdentifiedEntity] | None, optional replacement_strings: list[GsaSlimIdentifiedEntity] | None, optional - search_masks: list[GsaSlimIdentifiedEntity] | None, optional - search_templates: list[GsaSlimIdentifiedEntity] | None, optional standard_names: list[GsaSlimIdentifiedEntity] | None, optional subsets: list[GsaSlimIdentifiedEntity] | None, optional tables: list[GsaSlimIdentifiedEntity] | None, optional - tabular_columns: list[GsaSlimIdentifiedEntity] | None, optional unit_systems: list[GsaSlimIdentifiedEntity] | None, optional units: list[GsaSlimIdentifiedEntity] | None, optional """ @@ -200,11 +180,7 @@ def __init__( self._standard_names: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self._constants: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self._record_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._cross_database_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._tabular_columns: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self._data: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._search_masks: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._search_templates: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self.database_key = database_key if attributes is not Unset: @@ -237,36 +213,28 @@ def __init__( self.constants = constants if record_link_groups is not Unset: self.record_link_groups = record_link_groups - if cross_database_link_groups is not Unset: - self.cross_database_link_groups = cross_database_link_groups - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns if data is not Unset: self.data = data - if search_masks is not Unset: - self.search_masks = search_masks - if search_templates is not Unset: - self.search_templates = search_templates @property def database_key(self) -> "str": - """Gets the database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the database_key of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- str - The database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The database_key of this GsaTranslateGuidsToIdentitiesResponse. """ return self._database_key @database_key.setter def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the database_key of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- database_key: str - The database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The database_key of this GsaTranslateGuidsToIdentitiesResponse. """ # Field is not nullable if database_key is None: @@ -278,56 +246,56 @@ def database_key(self, database_key: "str") -> None: @property def attributes(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the attributes of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The attributes of this GsaTranslateGuidsToIdentitiesResponse. """ return self._attributes @attributes.setter def attributes(self, attributes: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the attributes of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- attributes: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The attributes of this GsaTranslateGuidsToIdentitiesResponse. """ self._attributes = attributes @property def layouts(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the layouts of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The layouts of this GsaTranslateGuidsToIdentitiesResponse. """ return self._layouts @layouts.setter def layouts(self, layouts: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the layouts of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- layouts: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The layouts of this GsaTranslateGuidsToIdentitiesResponse. """ self._layouts = layouts @property def record_versions(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the record_versions of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_versions of this GsaTranslateGuidsToIdentitiesResponse. """ return self._record_versions @@ -335,23 +303,23 @@ def record_versions(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type" def record_versions( self, record_versions: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the record_versions of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- record_versions: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_versions of this GsaTranslateGuidsToIdentitiesResponse. """ self._record_versions = record_versions @property def record_histories(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the record_histories of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_histories of this GsaTranslateGuidsToIdentitiesResponse. """ return self._record_histories @@ -359,45 +327,45 @@ def record_histories(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type def record_histories( self, record_histories: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the record_histories of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- record_histories: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_histories of this GsaTranslateGuidsToIdentitiesResponse. """ self._record_histories = record_histories @property def units(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the units of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The units of this GsaTranslateGuidsToIdentitiesResponse. """ return self._units @units.setter def units(self, units: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the units of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- units: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The units of this GsaTranslateGuidsToIdentitiesResponse. """ self._units = units @property def unit_systems(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the unit_systems of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The unit_systems of this GsaTranslateGuidsToIdentitiesResponse. """ return self._unit_systems @@ -405,89 +373,89 @@ def unit_systems(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": def unit_systems( self, unit_systems: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the unit_systems of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- unit_systems: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The unit_systems of this GsaTranslateGuidsToIdentitiesResponse. """ self._unit_systems = unit_systems @property def parameters(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the parameters of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The parameters of this GsaTranslateGuidsToIdentitiesResponse. """ return self._parameters @parameters.setter def parameters(self, parameters: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the parameters of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- parameters: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The parameters of this GsaTranslateGuidsToIdentitiesResponse. """ self._parameters = parameters @property def subsets(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the subsets of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The subsets of this GsaTranslateGuidsToIdentitiesResponse. """ return self._subsets @subsets.setter def subsets(self, subsets: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the subsets of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- subsets: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The subsets of this GsaTranslateGuidsToIdentitiesResponse. """ self._subsets = subsets @property def tables(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the tables of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The tables of this GsaTranslateGuidsToIdentitiesResponse. """ return self._tables @tables.setter def tables(self, tables: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the tables of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- tables: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The tables of this GsaTranslateGuidsToIdentitiesResponse. """ self._tables = tables @property def discrete_types(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the discrete_types of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_types of this GsaTranslateGuidsToIdentitiesResponse. """ return self._discrete_types @@ -495,23 +463,23 @@ def discrete_types(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": def discrete_types( self, discrete_types: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the discrete_types of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- discrete_types: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_types of this GsaTranslateGuidsToIdentitiesResponse. """ self._discrete_types = discrete_types @property def discrete_values(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the discrete_values of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_values of this GsaTranslateGuidsToIdentitiesResponse. """ return self._discrete_values @@ -519,23 +487,23 @@ def discrete_values(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type" def discrete_values( self, discrete_values: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the discrete_values of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- discrete_values: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_values of this GsaTranslateGuidsToIdentitiesResponse. """ self._discrete_values = discrete_values @property def replacement_strings(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. """ return self._replacement_strings @@ -543,23 +511,23 @@ def replacement_strings(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_T def replacement_strings( self, replacement_strings: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- replacement_strings: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. """ self._replacement_strings = replacement_strings @property def standard_names(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the standard_names of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The standard_names of this GsaTranslateGuidsToIdentitiesResponse. """ return self._standard_names @@ -567,45 +535,45 @@ def standard_names(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": def standard_names( self, standard_names: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the standard_names of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- standard_names: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The standard_names of this GsaTranslateGuidsToIdentitiesResponse. """ self._standard_names = standard_names @property def constants(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the constants of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The constants of this GsaTranslateGuidsToIdentitiesResponse. """ return self._constants @constants.setter def constants(self, constants: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the constants of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- constants: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The constants of this GsaTranslateGuidsToIdentitiesResponse. """ self._constants = constants @property def record_link_groups(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. """ return self._record_link_groups @@ -613,133 +581,37 @@ def record_link_groups(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Ty def record_link_groups( self, record_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- record_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. """ self._record_link_groups = record_link_groups - @property - def cross_database_link_groups(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._cross_database_link_groups - - @cross_database_link_groups.setter - def cross_database_link_groups( - self, cross_database_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - cross_database_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._cross_database_link_groups = cross_database_link_groups - - @property - def tabular_columns(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._tabular_columns - - @tabular_columns.setter - def tabular_columns( - self, tabular_columns: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - tabular_columns: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._tabular_columns = tabular_columns - @property def data(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the data of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The data of this GsaTranslateGuidsToIdentitiesResponse. """ return self._data @data.setter def data(self, data: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the data of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- data: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The data of this GsaTranslateGuidsToIdentitiesResponse. """ self._data = data - @property - def search_masks(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._search_masks - - @search_masks.setter - def search_masks( - self, search_masks: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - search_masks: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._search_masks = search_masks - - @property - def search_templates(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._search_templates - - @search_templates.setter - def search_templates( - self, search_templates: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - search_templates: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._search_templates = search_templates - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. @@ -762,7 +634,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaTranslateBetweenGuidsAndIdentitiesResponse): + if not isinstance(other, GsaTranslateGuidsToIdentitiesResponse): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_identities_to_guids_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_identities_to_guids_request.py deleted file mode 100644 index 8121ad07..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_translate_identities_to_guids_request.py +++ /dev/null @@ -1,729 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTranslateIdentitiesToGuidsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key": "str", - "attributes": "list[int]", - "constants": "list[int]", - "cross_database_link_groups": "list[int]", - "data": "list[int]", - "discrete_types": "list[int]", - "discrete_values": "list[int]", - "layouts": "list[int]", - "parameters": "list[int]", - "record_histories": "list[int]", - "record_link_groups": "list[int]", - "record_versions": "list[int]", - "replacement_strings": "list[int]", - "search_masks": "list[int]", - "search_templates": "list[int]", - "standard_names": "list[int]", - "subsets": "list[int]", - "tables": "list[int]", - "tabular_columns": "list[int]", - "unit_systems": "list[int]", - "units": "list[int]", - } - - attribute_map: dict[str, str] = { - "database_key": "databaseKey", - "attributes": "attributes", - "constants": "constants", - "cross_database_link_groups": "crossDatabaseLinkGroups", - "data": "data", - "discrete_types": "discreteTypes", - "discrete_values": "discreteValues", - "layouts": "layouts", - "parameters": "parameters", - "record_histories": "recordHistories", - "record_link_groups": "recordLinkGroups", - "record_versions": "recordVersions", - "replacement_strings": "replacementStrings", - "search_masks": "searchMasks", - "search_templates": "searchTemplates", - "standard_names": "standardNames", - "subsets": "subsets", - "tables": "tables", - "tabular_columns": "tabularColumns", - "unit_systems": "unitSystems", - "units": "units", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key: "str", - attributes: "list[int] | None | Unset_Type" = Unset, - constants: "list[int] | None | Unset_Type" = Unset, - cross_database_link_groups: "list[int] | None | Unset_Type" = Unset, - data: "list[int] | None | Unset_Type" = Unset, - discrete_types: "list[int] | None | Unset_Type" = Unset, - discrete_values: "list[int] | None | Unset_Type" = Unset, - layouts: "list[int] | None | Unset_Type" = Unset, - parameters: "list[int] | None | Unset_Type" = Unset, - record_histories: "list[int] | None | Unset_Type" = Unset, - record_link_groups: "list[int] | None | Unset_Type" = Unset, - record_versions: "list[int] | None | Unset_Type" = Unset, - replacement_strings: "list[int] | None | Unset_Type" = Unset, - search_masks: "list[int] | None | Unset_Type" = Unset, - search_templates: "list[int] | None | Unset_Type" = Unset, - standard_names: "list[int] | None | Unset_Type" = Unset, - subsets: "list[int] | None | Unset_Type" = Unset, - tables: "list[int] | None | Unset_Type" = Unset, - tabular_columns: "list[int] | None | Unset_Type" = Unset, - unit_systems: "list[int] | None | Unset_Type" = Unset, - units: "list[int] | None | Unset_Type" = Unset, - ) -> None: - """GsaTranslateIdentitiesToGuidsRequest - a model defined in Swagger - - Parameters - ---------- - database_key: str - attributes: list[int] | None, optional - constants: list[int] | None, optional - cross_database_link_groups: list[int] | None, optional - data: list[int] | None, optional - discrete_types: list[int] | None, optional - discrete_values: list[int] | None, optional - layouts: list[int] | None, optional - parameters: list[int] | None, optional - record_histories: list[int] | None, optional - record_link_groups: list[int] | None, optional - record_versions: list[int] | None, optional - replacement_strings: list[int] | None, optional - search_masks: list[int] | None, optional - search_templates: list[int] | None, optional - standard_names: list[int] | None, optional - subsets: list[int] | None, optional - tables: list[int] | None, optional - tabular_columns: list[int] | None, optional - unit_systems: list[int] | None, optional - units: list[int] | None, optional - """ - self._database_key: str - self._attributes: list[int] | None | Unset_Type = Unset - self._layouts: list[int] | None | Unset_Type = Unset - self._record_versions: list[int] | None | Unset_Type = Unset - self._record_histories: list[int] | None | Unset_Type = Unset - self._units: list[int] | None | Unset_Type = Unset - self._unit_systems: list[int] | None | Unset_Type = Unset - self._parameters: list[int] | None | Unset_Type = Unset - self._subsets: list[int] | None | Unset_Type = Unset - self._tables: list[int] | None | Unset_Type = Unset - self._discrete_types: list[int] | None | Unset_Type = Unset - self._discrete_values: list[int] | None | Unset_Type = Unset - self._replacement_strings: list[int] | None | Unset_Type = Unset - self._standard_names: list[int] | None | Unset_Type = Unset - self._constants: list[int] | None | Unset_Type = Unset - self._record_link_groups: list[int] | None | Unset_Type = Unset - self._cross_database_link_groups: list[int] | None | Unset_Type = Unset - self._tabular_columns: list[int] | None | Unset_Type = Unset - self._data: list[int] | None | Unset_Type = Unset - self._search_masks: list[int] | None | Unset_Type = Unset - self._search_templates: list[int] | None | Unset_Type = Unset - - self.database_key = database_key - if attributes is not Unset: - self.attributes = attributes - if layouts is not Unset: - self.layouts = layouts - if record_versions is not Unset: - self.record_versions = record_versions - if record_histories is not Unset: - self.record_histories = record_histories - if units is not Unset: - self.units = units - if unit_systems is not Unset: - self.unit_systems = unit_systems - if parameters is not Unset: - self.parameters = parameters - if subsets is not Unset: - self.subsets = subsets - if tables is not Unset: - self.tables = tables - if discrete_types is not Unset: - self.discrete_types = discrete_types - if discrete_values is not Unset: - self.discrete_values = discrete_values - if replacement_strings is not Unset: - self.replacement_strings = replacement_strings - if standard_names is not Unset: - self.standard_names = standard_names - if constants is not Unset: - self.constants = constants - if record_link_groups is not Unset: - self.record_link_groups = record_link_groups - if cross_database_link_groups is not Unset: - self.cross_database_link_groups = cross_database_link_groups - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns - if data is not Unset: - self.data = data - if search_masks is not Unset: - self.search_masks = search_masks - if search_templates is not Unset: - self.search_templates = search_templates - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - str - The database_key of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - database_key: str - The database_key of this GsaTranslateIdentitiesToGuidsRequest. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def attributes(self) -> "list[int] | None | Unset_Type": - """Gets the attributes of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The attributes of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._attributes - - @attributes.setter - def attributes(self, attributes: "list[int] | None | Unset_Type") -> None: - """Sets the attributes of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - attributes: list[int] | None | Unset_Type - The attributes of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._attributes = attributes - - @property - def layouts(self) -> "list[int] | None | Unset_Type": - """Gets the layouts of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The layouts of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._layouts - - @layouts.setter - def layouts(self, layouts: "list[int] | None | Unset_Type") -> None: - """Sets the layouts of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - layouts: list[int] | None | Unset_Type - The layouts of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._layouts = layouts - - @property - def record_versions(self) -> "list[int] | None | Unset_Type": - """Gets the record_versions of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The record_versions of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._record_versions - - @record_versions.setter - def record_versions(self, record_versions: "list[int] | None | Unset_Type") -> None: - """Sets the record_versions of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - record_versions: list[int] | None | Unset_Type - The record_versions of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._record_versions = record_versions - - @property - def record_histories(self) -> "list[int] | None | Unset_Type": - """Gets the record_histories of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The record_histories of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._record_histories - - @record_histories.setter - def record_histories(self, record_histories: "list[int] | None | Unset_Type") -> None: - """Sets the record_histories of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - record_histories: list[int] | None | Unset_Type - The record_histories of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._record_histories = record_histories - - @property - def units(self) -> "list[int] | None | Unset_Type": - """Gets the units of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The units of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._units - - @units.setter - def units(self, units: "list[int] | None | Unset_Type") -> None: - """Sets the units of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - units: list[int] | None | Unset_Type - The units of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._units = units - - @property - def unit_systems(self) -> "list[int] | None | Unset_Type": - """Gets the unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._unit_systems - - @unit_systems.setter - def unit_systems(self, unit_systems: "list[int] | None | Unset_Type") -> None: - """Sets the unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - unit_systems: list[int] | None | Unset_Type - The unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._unit_systems = unit_systems - - @property - def parameters(self) -> "list[int] | None | Unset_Type": - """Gets the parameters of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The parameters of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._parameters - - @parameters.setter - def parameters(self, parameters: "list[int] | None | Unset_Type") -> None: - """Sets the parameters of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - parameters: list[int] | None | Unset_Type - The parameters of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._parameters = parameters - - @property - def subsets(self) -> "list[int] | None | Unset_Type": - """Gets the subsets of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The subsets of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._subsets - - @subsets.setter - def subsets(self, subsets: "list[int] | None | Unset_Type") -> None: - """Sets the subsets of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - subsets: list[int] | None | Unset_Type - The subsets of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._subsets = subsets - - @property - def tables(self) -> "list[int] | None | Unset_Type": - """Gets the tables of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The tables of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._tables - - @tables.setter - def tables(self, tables: "list[int] | None | Unset_Type") -> None: - """Sets the tables of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - tables: list[int] | None | Unset_Type - The tables of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._tables = tables - - @property - def discrete_types(self) -> "list[int] | None | Unset_Type": - """Gets the discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._discrete_types - - @discrete_types.setter - def discrete_types(self, discrete_types: "list[int] | None | Unset_Type") -> None: - """Sets the discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - discrete_types: list[int] | None | Unset_Type - The discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._discrete_types = discrete_types - - @property - def discrete_values(self) -> "list[int] | None | Unset_Type": - """Gets the discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._discrete_values - - @discrete_values.setter - def discrete_values(self, discrete_values: "list[int] | None | Unset_Type") -> None: - """Sets the discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - discrete_values: list[int] | None | Unset_Type - The discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._discrete_values = discrete_values - - @property - def replacement_strings(self) -> "list[int] | None | Unset_Type": - """Gets the replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._replacement_strings - - @replacement_strings.setter - def replacement_strings(self, replacement_strings: "list[int] | None | Unset_Type") -> None: - """Sets the replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - replacement_strings: list[int] | None | Unset_Type - The replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._replacement_strings = replacement_strings - - @property - def standard_names(self) -> "list[int] | None | Unset_Type": - """Gets the standard_names of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The standard_names of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._standard_names - - @standard_names.setter - def standard_names(self, standard_names: "list[int] | None | Unset_Type") -> None: - """Sets the standard_names of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - standard_names: list[int] | None | Unset_Type - The standard_names of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._standard_names = standard_names - - @property - def constants(self) -> "list[int] | None | Unset_Type": - """Gets the constants of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The constants of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._constants - - @constants.setter - def constants(self, constants: "list[int] | None | Unset_Type") -> None: - """Sets the constants of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - constants: list[int] | None | Unset_Type - The constants of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._constants = constants - - @property - def record_link_groups(self) -> "list[int] | None | Unset_Type": - """Gets the record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._record_link_groups - - @record_link_groups.setter - def record_link_groups(self, record_link_groups: "list[int] | None | Unset_Type") -> None: - """Sets the record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - record_link_groups: list[int] | None | Unset_Type - The record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._record_link_groups = record_link_groups - - @property - def cross_database_link_groups(self) -> "list[int] | None | Unset_Type": - """Gets the cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._cross_database_link_groups - - @cross_database_link_groups.setter - def cross_database_link_groups( - self, cross_database_link_groups: "list[int] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - cross_database_link_groups: list[int] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._cross_database_link_groups = cross_database_link_groups - - @property - def tabular_columns(self) -> "list[int] | None | Unset_Type": - """Gets the tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._tabular_columns - - @tabular_columns.setter - def tabular_columns(self, tabular_columns: "list[int] | None | Unset_Type") -> None: - """Sets the tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - tabular_columns: list[int] | None | Unset_Type - The tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._tabular_columns = tabular_columns - - @property - def data(self) -> "list[int] | None | Unset_Type": - """Gets the data of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The data of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._data - - @data.setter - def data(self, data: "list[int] | None | Unset_Type") -> None: - """Sets the data of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - data: list[int] | None | Unset_Type - The data of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._data = data - - @property - def search_masks(self) -> "list[int] | None | Unset_Type": - """Gets the search_masks of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The search_masks of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._search_masks - - @search_masks.setter - def search_masks(self, search_masks: "list[int] | None | Unset_Type") -> None: - """Sets the search_masks of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - search_masks: list[int] | None | Unset_Type - The search_masks of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._search_masks = search_masks - - @property - def search_templates(self) -> "list[int] | None | Unset_Type": - """Gets the search_templates of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The search_templates of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._search_templates - - @search_templates.setter - def search_templates(self, search_templates: "list[int] | None | Unset_Type") -> None: - """Sets the search_templates of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - search_templates: list[int] | None | Unset_Type - The search_templates of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._search_templates = search_templates - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTranslateIdentitiesToGuidsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unavailable_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unavailable_tabular_column.py index 21c47fbe..a3b24109 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unavailable_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unavailable_tabular_column.py @@ -72,13 +72,11 @@ class GsaUnavailableTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -86,13 +84,11 @@ class GsaUnavailableTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = {} @@ -106,13 +102,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaUnavailableTabularColumn - a model defined in Swagger @@ -122,26 +116,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_as_exponent_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_as_exponent_unit_equation_error_detail.py deleted file mode 100644 index d2e430a7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_as_exponent_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitAsExponentUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.UNITASEXPONENT, - ) -> None: - """GsaUnitAsExponentUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitAsExponentUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_conversion_set_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_conversion_set_request.py index d50e77af..c265493c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_conversion_set_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_conversion_set_request.py @@ -96,7 +96,6 @@ def __init__( @property def source_unit_symbol(self) -> "str": """Gets the source_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Returns ------- @@ -108,7 +107,6 @@ def source_unit_symbol(self) -> "str": @source_unit_symbol.setter def source_unit_symbol(self, source_unit_symbol: "str") -> None: """Sets the source_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Parameters ---------- @@ -126,7 +124,6 @@ def source_unit_symbol(self, source_unit_symbol: "str") -> None: @property def target_unit_symbol(self) -> "str": """Gets the target_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Returns ------- @@ -138,7 +135,6 @@ def target_unit_symbol(self) -> "str": @target_unit_symbol.setter def target_unit_symbol(self, target_unit_symbol: "str") -> None: """Sets the target_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_creation_exception.py deleted file mode 100644 index 084b8bd7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaUnitErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaUnitErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaUnitErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaUnitCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaUnitCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaUnitCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaUnitCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaUnitCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaUnitCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaUnitCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaUnitCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaUnitCreationException. - - Returns - ------- - str - The name of this GsaUnitCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaUnitCreationException. - - Parameters - ---------- - name: str - The name of this GsaUnitCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaUnitErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaUnitCreationException. - - Returns - ------- - list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaUnitCreationException. - - Parameters - ---------- - errors: list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_deletion_exception.py deleted file mode 100644 index dfdedfc9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_deletion_exception.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_entity_type import ( - GsaDeletionEntityType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_deletion_exception import ( # noqa: F401 - GsaDeletionException, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitDeletionException(GsaDeletionException): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_guid": "str", - "entity_type": "GsaDeletionEntityType", - "code": "GsaErrorCode", - "errors": "list[GsaDataModificationErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "entity_guid": "entityGuid", - "entity_type": "entityType", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_guid: "str", - entity_type: "GsaDeletionEntityType" = GsaDeletionEntityType.UNIT, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitDeletionException - a model defined in Swagger - - Parameters - ---------- - entity_guid: str - entity_type: GsaDeletionEntityType - code: GsaErrorCode, optional - errors: list[GsaDataModificationErrorDetail] | None, optional - message: str | None, optional - """ - super().__init__( - entity_guid=entity_guid, - entity_type=entity_type, - code=code, - errors=errors, - message=message, - ) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_detail.py deleted file mode 100644 index 28e55153..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitEquationErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaUnitEquationErrorReason", - } - - discriminator_value_class_map = { - "general".lower(): "#/components/schemas/GsaGeneralUnitEquationErrorDetail", - "unknownUnitSymbol".lower(): "#/components/schemas/GsaUnknownUnitSymbolUnitEquationErrorDetail", - "bracketMismatch".lower(): "#/components/schemas/GsaBracketMismatchUnitEquationErrorDetail", - "numberParsing".lower(): "#/components/schemas/GsaNumberParsingUnitEquationErrorDetail", - "unitAsExponent".lower(): "#/components/schemas/GsaUnitAsExponentUnitEquationErrorDetail", - "divideByZero".lower(): "#/components/schemas/GsaDivideByZeroUnitEquationErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason", - ) -> None: - """GsaUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - self._message: str - self._reason: GsaUnitEquationErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaUnitEquationErrorDetail. - - Returns - ------- - str - The message of this GsaUnitEquationErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaUnitEquationErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaUnitEquationErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaUnitEquationErrorReason": - """Gets the reason of this GsaUnitEquationErrorDetail. - - Returns - ------- - GsaUnitEquationErrorReason - The reason of this GsaUnitEquationErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaUnitEquationErrorReason") -> None: - """Sets the reason of this GsaUnitEquationErrorDetail. - - Parameters - ---------- - reason: GsaUnitEquationErrorReason - The reason of this GsaUnitEquationErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_reason.py deleted file mode 100644 index dee4c5f9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equation_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitEquationErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - GENERAL = "general" - UNKNOWNUNITSYMBOL = "unknownUnitSymbol" - BRACKETMISMATCH = "bracketMismatch" - NUMBERPARSING = "numberParsing" - UNITASEXPONENT = "unitAsExponent" - DIVIDEBYZERO = "divideByZero" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent.py index e0c4ef50..631b495f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent.py @@ -61,9 +61,9 @@ class GsaUnitEquivalent(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "equivalent_unit": "GsaSlimUnit", - "unit": "GsaSlimEntity", - "unit_system": "GsaSlimEntity", + "equivalent_unit": "GsaUnit", + "unit": "GsaUnit", + "unit_system": "GsaUnitSystem", } attribute_map: dict[str, str] = { @@ -73,9 +73,9 @@ class GsaUnitEquivalent(ModelBase): } subtype_mapping: dict[str, str] = { - "unit": "GsaSlimEntity", - "unitSystem": "GsaSlimEntity", - "equivalentUnit": "GsaSlimUnit", + "unit": "GsaUnit", + "unitSystem": "GsaUnitSystem", + "equivalentUnit": "GsaUnit", } discriminator: Optional[str] = None @@ -83,44 +83,44 @@ class GsaUnitEquivalent(ModelBase): def __init__( self, *, - equivalent_unit: "GsaSlimUnit", - unit: "GsaSlimEntity", - unit_system: "GsaSlimEntity", + equivalent_unit: "GsaUnit", + unit: "GsaUnit", + unit_system: "GsaUnitSystem", ) -> None: """GsaUnitEquivalent - a model defined in Swagger Parameters ---------- - equivalent_unit: GsaSlimUnit - unit: GsaSlimEntity - unit_system: GsaSlimEntity + equivalent_unit: GsaUnit + unit: GsaUnit + unit_system: GsaUnitSystem """ - self._unit: GsaSlimEntity - self._unit_system: GsaSlimEntity - self._equivalent_unit: GsaSlimUnit + self._unit: GsaUnit + self._unit_system: GsaUnitSystem + self._equivalent_unit: GsaUnit self.unit = unit self.unit_system = unit_system self.equivalent_unit = equivalent_unit @property - def unit(self) -> "GsaSlimEntity": + def unit(self) -> "GsaUnit": """Gets the unit of this GsaUnitEquivalent. Returns ------- - GsaSlimEntity + GsaUnit The unit of this GsaUnitEquivalent. """ return self._unit @unit.setter - def unit(self, unit: "GsaSlimEntity") -> None: + def unit(self, unit: "GsaUnit") -> None: """Sets the unit of this GsaUnitEquivalent. Parameters ---------- - unit: GsaSlimEntity + unit: GsaUnit The unit of this GsaUnitEquivalent. """ # Field is not nullable @@ -132,23 +132,23 @@ def unit(self, unit: "GsaSlimEntity") -> None: self._unit = unit @property - def unit_system(self) -> "GsaSlimEntity": + def unit_system(self) -> "GsaUnitSystem": """Gets the unit_system of this GsaUnitEquivalent. Returns ------- - GsaSlimEntity + GsaUnitSystem The unit_system of this GsaUnitEquivalent. """ return self._unit_system @unit_system.setter - def unit_system(self, unit_system: "GsaSlimEntity") -> None: + def unit_system(self, unit_system: "GsaUnitSystem") -> None: """Sets the unit_system of this GsaUnitEquivalent. Parameters ---------- - unit_system: GsaSlimEntity + unit_system: GsaUnitSystem The unit_system of this GsaUnitEquivalent. """ # Field is not nullable @@ -160,23 +160,23 @@ def unit_system(self, unit_system: "GsaSlimEntity") -> None: self._unit_system = unit_system @property - def equivalent_unit(self) -> "GsaSlimUnit": + def equivalent_unit(self) -> "GsaUnit": """Gets the equivalent_unit of this GsaUnitEquivalent. Returns ------- - GsaSlimUnit + GsaUnit The equivalent_unit of this GsaUnitEquivalent. """ return self._equivalent_unit @equivalent_unit.setter - def equivalent_unit(self, equivalent_unit: "GsaSlimUnit") -> None: + def equivalent_unit(self, equivalent_unit: "GsaUnit") -> None: """Sets the equivalent_unit of this GsaUnitEquivalent. Parameters ---------- - equivalent_unit: GsaSlimUnit + equivalent_unit: GsaUnit The equivalent_unit of this GsaUnitEquivalent. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_detail.py deleted file mode 100644 index ba429249..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitEquivalentErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaUnitEquivalentErrorReason", - } - - discriminator_value_class_map = { - "noSuchUnit".lower(): "#/components/schemas/GsaNoSuchUnitUnitEquivalentErrorDetail", - "noSuchUnitSystem".lower(): "#/components/schemas/GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "incompatibleUnits".lower(): "#/components/schemas/GsaIncompatibleUnitsErrorDetail", - "invalidEquivalenceTarget".lower(): "#/components/schemas/GsaInvalidEquivalenceTargetErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason", - ) -> None: - """GsaUnitEquivalentErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - """ - self._message: str - self._reason: GsaUnitEquivalentErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaUnitEquivalentErrorDetail. - - Returns - ------- - str - The message of this GsaUnitEquivalentErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaUnitEquivalentErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaUnitEquivalentErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaUnitEquivalentErrorReason": - """Gets the reason of this GsaUnitEquivalentErrorDetail. - - Returns - ------- - GsaUnitEquivalentErrorReason - The reason of this GsaUnitEquivalentErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaUnitEquivalentErrorReason") -> None: - """Sets the reason of this GsaUnitEquivalentErrorDetail. - - Parameters - ---------- - reason: GsaUnitEquivalentErrorReason - The reason of this GsaUnitEquivalentErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitEquivalentErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_reason.py deleted file mode 100644 index 837043f3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_equivalent_error_reason.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitEquivalentErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOSUCHUNIT = "noSuchUnit" - NOSUCHUNITSYSTEM = "noSuchUnitSystem" - INCOMPATIBLEUNITS = "incompatibleUnits" - INVALIDEQUIVALENCETARGET = "invalidEquivalenceTarget" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_detail.py deleted file mode 100644 index e4e97280..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_detail.py +++ /dev/null @@ -1,198 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaUnitErrorReason", - } - - discriminator_value_class_map = { - "emptySymbol".lower(): "#/components/schemas/GsaEmptySymbolUnitErrorDetail", - "duplicateSymbol".lower(): "#/components/schemas/GsaDuplicateSymbolUnitErrorDetail", - "symbolCannotContainComma".lower(): "#/components/schemas/GsaSymbolCannotContainCommaUnitErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityUnitErrorDetail", - "equation".lower(): "#/components/schemas/GsaEquationUnitErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason", - ) -> None: - """GsaUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - """ - self._message: str - self._reason: GsaUnitErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaUnitErrorDetail. - - Returns - ------- - str - The message of this GsaUnitErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaUnitErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaUnitErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaUnitErrorReason": - """Gets the reason of this GsaUnitErrorDetail. - - Returns - ------- - GsaUnitErrorReason - The reason of this GsaUnitErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaUnitErrorReason") -> None: - """Sets the reason of this GsaUnitErrorDetail. - - Parameters - ---------- - reason: GsaUnitErrorReason - The reason of this GsaUnitErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_reason.py deleted file mode 100644 index 32bb1a2f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_error_reason.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - EMPTYSYMBOL = "emptySymbol" - DUPLICATESYMBOL = "duplicateSymbol" - SYMBOLCANNOTCONTAINCOMMA = "symbolCannotContainComma" - NAMEDENTITY = "namedEntity" - EQUATION = "equation" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_system.py index 0b0830e6..87fe9094 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_system.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_system.py @@ -138,7 +138,6 @@ def unit_mappings(self, unit_mappings: "list[GsaUnitMapping]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaUnitSystem. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -150,7 +149,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaUnitSystem. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_systems_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_systems_info.py index 8f780749..174bc91a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_systems_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_systems_info.py @@ -61,7 +61,7 @@ class GsaUnitSystemsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "unit_systems": "list[GsaSlimLocalizedEntity]", + "unit_systems": "list[GsaSlimUnitSystem]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaUnitSystemsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "unitSystems": "GsaSlimLocalizedEntity", + "unitSystems": "GsaSlimUnitSystem", } discriminator: Optional[str] = None @@ -77,39 +77,37 @@ class GsaUnitSystemsInfo(ModelBase): def __init__( self, *, - unit_systems: "list[GsaSlimLocalizedEntity] | None | Unset_Type" = Unset, + unit_systems: "list[GsaSlimUnitSystem] | None | Unset_Type" = Unset, ) -> None: """GsaUnitSystemsInfo - a model defined in Swagger Parameters ---------- - unit_systems: list[GsaSlimLocalizedEntity] | None, optional + unit_systems: list[GsaSlimUnitSystem] | None, optional """ - self._unit_systems: list[GsaSlimLocalizedEntity] | None | Unset_Type = Unset + self._unit_systems: list[GsaSlimUnitSystem] | None | Unset_Type = Unset if unit_systems is not Unset: self.unit_systems = unit_systems @property - def unit_systems(self) -> "list[GsaSlimLocalizedEntity] | None | Unset_Type": + def unit_systems(self) -> "list[GsaSlimUnitSystem] | None | Unset_Type": """Gets the unit_systems of this GsaUnitSystemsInfo. Returns ------- - list[GsaSlimLocalizedEntity] | None | Unset_Type + list[GsaSlimUnitSystem] | None | Unset_Type The unit_systems of this GsaUnitSystemsInfo. """ return self._unit_systems @unit_systems.setter - def unit_systems( - self, unit_systems: "list[GsaSlimLocalizedEntity] | None | Unset_Type" - ) -> None: + def unit_systems(self, unit_systems: "list[GsaSlimUnitSystem] | None | Unset_Type") -> None: """Sets the unit_systems of this GsaUnitSystemsInfo. Parameters ---------- - unit_systems: list[GsaSlimLocalizedEntity] | None | Unset_Type + unit_systems: list[GsaSlimUnitSystem] | None | Unset_Type The unit_systems of this GsaUnitSystemsInfo. """ self._unit_systems = unit_systems diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_update_exception.py deleted file mode 100644 index 38ccbd68..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaUnitErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitUpdateException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaUnitErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaUnitErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaUnitUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaUnitUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaUnitUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaUnitUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaUnitUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaUnitUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaUnitUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaUnitUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUnitUpdateException. - - Returns - ------- - str - The guid of this GsaUnitUpdateException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUnitUpdateException. - - Parameters - ---------- - guid: str - The guid of this GsaUnitUpdateException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaUnitErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaUnitUpdateException. - - Returns - ------- - list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaUnitUpdateException. - - Parameters - ---------- - errors: list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage.py index b309b955..640d1b64 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage.py @@ -61,11 +61,11 @@ class GsaUnitUsage(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "attributes": "list[GsaSlimAttribute]", + "attributes": "list[GsaSlimNamedEntity]", "constants": "list[GsaSlimNamedEntity]", - "expressions": "list[GsaSlimExpression]", + "expressions": "list[GsaSlimNamedEntity]", "parameters": "list[GsaSlimNamedEntity]", - "units": "list[GsaUnit]", + "units": "list[GsaSlimUnit]", } attribute_map: dict[str, str] = { @@ -77,11 +77,11 @@ class GsaUnitUsage(ModelBase): } subtype_mapping: dict[str, str] = { - "attributes": "GsaSlimAttribute", + "attributes": "GsaSlimNamedEntity", "parameters": "GsaSlimNamedEntity", "constants": "GsaSlimNamedEntity", - "expressions": "GsaSlimExpression", - "units": "GsaUnit", + "expressions": "GsaSlimNamedEntity", + "units": "GsaSlimUnit", } discriminator: Optional[str] = None @@ -89,147 +89,172 @@ class GsaUnitUsage(ModelBase): def __init__( self, *, - attributes: "list[GsaSlimAttribute] | None | Unset_Type" = Unset, - constants: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - expressions: "list[GsaSlimExpression] | None | Unset_Type" = Unset, - parameters: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - units: "list[GsaUnit] | None | Unset_Type" = Unset, + attributes: "list[GsaSlimNamedEntity]", + constants: "list[GsaSlimNamedEntity]", + expressions: "list[GsaSlimNamedEntity]", + parameters: "list[GsaSlimNamedEntity]", + units: "list[GsaSlimUnit]", ) -> None: """GsaUnitUsage - a model defined in Swagger Parameters ---------- - attributes: list[GsaSlimAttribute] | None, optional - constants: list[GsaSlimNamedEntity] | None, optional - expressions: list[GsaSlimExpression] | None, optional - parameters: list[GsaSlimNamedEntity] | None, optional - units: list[GsaUnit] | None, optional + attributes: list[GsaSlimNamedEntity] + constants: list[GsaSlimNamedEntity] + expressions: list[GsaSlimNamedEntity] + parameters: list[GsaSlimNamedEntity] + units: list[GsaSlimUnit] """ - self._attributes: list[GsaSlimAttribute] | None | Unset_Type = Unset - self._parameters: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - self._constants: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - self._expressions: list[GsaSlimExpression] | None | Unset_Type = Unset - self._units: list[GsaUnit] | None | Unset_Type = Unset - - if attributes is not Unset: - self.attributes = attributes - if parameters is not Unset: - self.parameters = parameters - if constants is not Unset: - self.constants = constants - if expressions is not Unset: - self.expressions = expressions - if units is not Unset: - self.units = units + self._attributes: list[GsaSlimNamedEntity] + self._parameters: list[GsaSlimNamedEntity] + self._constants: list[GsaSlimNamedEntity] + self._expressions: list[GsaSlimNamedEntity] + self._units: list[GsaSlimUnit] + + self.attributes = attributes + self.parameters = parameters + self.constants = constants + self.expressions = expressions + self.units = units @property - def attributes(self) -> "list[GsaSlimAttribute] | None | Unset_Type": + def attributes(self) -> "list[GsaSlimNamedEntity]": """Gets the attributes of this GsaUnitUsage. Returns ------- - list[GsaSlimAttribute] | None | Unset_Type + list[GsaSlimNamedEntity] The attributes of this GsaUnitUsage. """ return self._attributes @attributes.setter - def attributes(self, attributes: "list[GsaSlimAttribute] | None | Unset_Type") -> None: + def attributes(self, attributes: "list[GsaSlimNamedEntity]") -> None: """Sets the attributes of this GsaUnitUsage. Parameters ---------- - attributes: list[GsaSlimAttribute] | None | Unset_Type + attributes: list[GsaSlimNamedEntity] The attributes of this GsaUnitUsage. """ + # Field is not nullable + if attributes is None: + raise ValueError("Invalid value for 'attributes', must not be 'None'") + # Field is required + if attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'attributes', must not be 'Unset'") self._attributes = attributes @property - def parameters(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + def parameters(self) -> "list[GsaSlimNamedEntity]": """Gets the parameters of this GsaUnitUsage. Returns ------- - list[GsaSlimNamedEntity] | None | Unset_Type + list[GsaSlimNamedEntity] The parameters of this GsaUnitUsage. """ return self._parameters @parameters.setter - def parameters(self, parameters: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: + def parameters(self, parameters: "list[GsaSlimNamedEntity]") -> None: """Sets the parameters of this GsaUnitUsage. Parameters ---------- - parameters: list[GsaSlimNamedEntity] | None | Unset_Type + parameters: list[GsaSlimNamedEntity] The parameters of this GsaUnitUsage. """ + # Field is not nullable + if parameters is None: + raise ValueError("Invalid value for 'parameters', must not be 'None'") + # Field is required + if parameters is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'parameters', must not be 'Unset'") self._parameters = parameters @property - def constants(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + def constants(self) -> "list[GsaSlimNamedEntity]": """Gets the constants of this GsaUnitUsage. Returns ------- - list[GsaSlimNamedEntity] | None | Unset_Type + list[GsaSlimNamedEntity] The constants of this GsaUnitUsage. """ return self._constants @constants.setter - def constants(self, constants: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: + def constants(self, constants: "list[GsaSlimNamedEntity]") -> None: """Sets the constants of this GsaUnitUsage. Parameters ---------- - constants: list[GsaSlimNamedEntity] | None | Unset_Type + constants: list[GsaSlimNamedEntity] The constants of this GsaUnitUsage. """ + # Field is not nullable + if constants is None: + raise ValueError("Invalid value for 'constants', must not be 'None'") + # Field is required + if constants is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'constants', must not be 'Unset'") self._constants = constants @property - def expressions(self) -> "list[GsaSlimExpression] | None | Unset_Type": + def expressions(self) -> "list[GsaSlimNamedEntity]": """Gets the expressions of this GsaUnitUsage. Returns ------- - list[GsaSlimExpression] | None | Unset_Type + list[GsaSlimNamedEntity] The expressions of this GsaUnitUsage. """ return self._expressions @expressions.setter - def expressions(self, expressions: "list[GsaSlimExpression] | None | Unset_Type") -> None: + def expressions(self, expressions: "list[GsaSlimNamedEntity]") -> None: """Sets the expressions of this GsaUnitUsage. Parameters ---------- - expressions: list[GsaSlimExpression] | None | Unset_Type + expressions: list[GsaSlimNamedEntity] The expressions of this GsaUnitUsage. """ + # Field is not nullable + if expressions is None: + raise ValueError("Invalid value for 'expressions', must not be 'None'") + # Field is required + if expressions is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'expressions', must not be 'Unset'") self._expressions = expressions @property - def units(self) -> "list[GsaUnit] | None | Unset_Type": + def units(self) -> "list[GsaSlimUnit]": """Gets the units of this GsaUnitUsage. Returns ------- - list[GsaUnit] | None | Unset_Type + list[GsaSlimUnit] The units of this GsaUnitUsage. """ return self._units @units.setter - def units(self, units: "list[GsaUnit] | None | Unset_Type") -> None: + def units(self, units: "list[GsaSlimUnit]") -> None: """Sets the units of this GsaUnitUsage. Parameters ---------- - units: list[GsaUnit] | None | Unset_Type + units: list[GsaSlimUnit] The units of this GsaUnitUsage. """ + # Field is not nullable + if units is None: + raise ValueError("Invalid value for 'units', must not be 'None'") + # Field is required + if units is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'units', must not be 'Unset'") self._units = units @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_data_modification_error_detail.py deleted file mode 100644 index b526e3fa..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_data_modification_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimNamedEntity]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.UNIT, - referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimNamedEntity] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaUnitUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaUnitUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaUnitUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaUnitUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_type.py deleted file mode 100644 index ee1bd3e5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unit_usage_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitUsageType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTES = "attributes" - PARAMETERS = "parameters" - CONSTANTS = "constants" - EXPRESSIONS = "expressions" - UNITS = "units" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_grouping_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_grouping_info.py deleted file mode 100644 index 7c4ee1a3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_grouping_info.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitsGroupingInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "unit_groups": "list[list[GsaSlimUnit]]", - } - - attribute_map: dict[str, str] = { - "unit_groups": "unitGroups", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - unit_groups: "list[list[GsaSlimUnit]] | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitsGroupingInfo - a model defined in Swagger - - Parameters - ---------- - unit_groups: list[list[GsaSlimUnit]] | None, optional - """ - self._unit_groups: list[list[GsaSlimUnit]] | None | Unset_Type = Unset - - if unit_groups is not Unset: - self.unit_groups = unit_groups - - @property - def unit_groups(self) -> "list[list[GsaSlimUnit]] | None | Unset_Type": - """Gets the unit_groups of this GsaUnitsGroupingInfo. - - Returns - ------- - list[list[GsaSlimUnit]] | None | Unset_Type - The unit_groups of this GsaUnitsGroupingInfo. - """ - return self._unit_groups - - @unit_groups.setter - def unit_groups(self, unit_groups: "list[list[GsaSlimUnit]] | None | Unset_Type") -> None: - """Sets the unit_groups of this GsaUnitsGroupingInfo. - - Parameters - ---------- - unit_groups: list[list[GsaSlimUnit]] | None | Unset_Type - The unit_groups of this GsaUnitsGroupingInfo. - """ - self._unit_groups = unit_groups - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitsGroupingInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_info.py index a1359309..b00c54ae 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_units_info.py @@ -61,7 +61,7 @@ class GsaUnitsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "units": "list[GsaUnit]", + "units": "list[GsaSlimNamedUnit]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaUnitsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "units": "GsaUnit", + "units": "GsaSlimNamedUnit", } discriminator: Optional[str] = None @@ -77,37 +77,37 @@ class GsaUnitsInfo(ModelBase): def __init__( self, *, - units: "list[GsaUnit] | None | Unset_Type" = Unset, + units: "list[GsaSlimNamedUnit] | None | Unset_Type" = Unset, ) -> None: """GsaUnitsInfo - a model defined in Swagger Parameters ---------- - units: list[GsaUnit] | None, optional + units: list[GsaSlimNamedUnit] | None, optional """ - self._units: list[GsaUnit] | None | Unset_Type = Unset + self._units: list[GsaSlimNamedUnit] | None | Unset_Type = Unset if units is not Unset: self.units = units @property - def units(self) -> "list[GsaUnit] | None | Unset_Type": + def units(self) -> "list[GsaSlimNamedUnit] | None | Unset_Type": """Gets the units of this GsaUnitsInfo. Returns ------- - list[GsaUnit] | None | Unset_Type + list[GsaSlimNamedUnit] | None | Unset_Type The units of this GsaUnitsInfo. """ return self._units @units.setter - def units(self, units: "list[GsaUnit] | None | Unset_Type") -> None: + def units(self, units: "list[GsaSlimNamedUnit] | None | Unset_Type") -> None: """Sets the units of this GsaUnitsInfo. Parameters ---------- - units: list[GsaUnit] | None | Unset_Type + units: list[GsaSlimNamedUnit] | None | Unset_Type The units of this GsaUnitsInfo. """ self._units = units diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unknown_unit_symbol_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unknown_unit_symbol_unit_equation_error_detail.py deleted file mode 100644 index b9db4679..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unknown_unit_symbol_unit_equation_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnknownUnitSymbolUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - "symbol": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "symbol": "symbol", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.UNKNOWNUNITSYMBOL, - symbol: "str", - ) -> None: - """GsaUnknownUnitSymbolUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - symbol: str - """ - super().__init__(message=message, reason=reason) - self._symbol: str - - self.symbol = symbol - - @property - def symbol(self) -> "str": - """Gets the symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - - Returns - ------- - str - The symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - """ - return self._symbol - - @symbol.setter - def symbol(self, symbol: "str") -> None: - """Sets the symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - - Parameters - ---------- - symbol: str - The symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - """ - # Field is not nullable - if symbol is None: - raise ValueError("Invalid value for 'symbol', must not be 'None'") - # Field is required - if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'symbol', must not be 'Unset'") - self._symbol = symbol - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnknownUnitSymbolUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_attribute_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_attribute_guids_error_detail.py deleted file mode 100644 index 9c67ffb9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_attribute_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedAttributeGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDATTRIBUTEGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedAttributeGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedAttributeGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_breadcrumb.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_breadcrumb.py deleted file mode 100644 index 6640ea1a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_breadcrumb.py +++ /dev/null @@ -1,122 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_breadcrumb import ( # noqa: F401 - GsaBreadcrumb, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_breadcrumb_type import GsaBreadcrumbType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedBreadcrumb(GsaBreadcrumb): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "breadcrumb_type": "GsaBreadcrumbType", - } - - attribute_map: dict[str, str] = { - "breadcrumb_type": "breadcrumbType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - breadcrumb_type: "GsaBreadcrumbType" = GsaBreadcrumbType.UNRESOLVED, - ) -> None: - """GsaUnresolvedBreadcrumb - a model defined in Swagger - - Parameters - ---------- - breadcrumb_type: GsaBreadcrumbType - """ - super().__init__(breadcrumb_type=breadcrumb_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedBreadcrumb): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_cross_database_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_cross_database_record_link_group_guids_error_detail.py deleted file mode 100644 index 2bbfc097..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_cross_database_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDCROSSDATABASERECORDLINKGROUPGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_parameter_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_parameter_guids_error_detail.py deleted file mode 100644 index 7f437db5..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_parameter_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedParameterGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDPARAMETERGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedParameterGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedParameterGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_record_link_group_guids_error_detail.py deleted file mode 100644 index 3cd53a30..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDRECORDLINKGROUPGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_reverse_record_link_groups_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_reverse_record_link_groups_error_detail.py deleted file mode 100644 index fb72ed8f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_reverse_record_link_groups_error_detail.py +++ /dev/null @@ -1,173 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedReverseRecordLinkGroupsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "record_link_group_guids_with_no_reverse_link_group": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "record_link_group_guids_with_no_reverse_link_group": "recordLinkGroupGuidsWithNoReverseLinkGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDREVERSERECORDLINKGROUPS, - record_link_group_guids_with_no_reverse_link_group: "list[str]", - ) -> None: - """GsaUnresolvedReverseRecordLinkGroupsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - record_link_group_guids_with_no_reverse_link_group: list[str] - """ - super().__init__(message=message, reason=reason) - self._record_link_group_guids_with_no_reverse_link_group: list[str] - - self.record_link_group_guids_with_no_reverse_link_group = ( - record_link_group_guids_with_no_reverse_link_group - ) - - @property - def record_link_group_guids_with_no_reverse_link_group(self) -> "list[str]": - """Gets the record_link_group_guids_with_no_reverse_link_group of this GsaUnresolvedReverseRecordLinkGroupsErrorDetail. - - Returns - ------- - list[str] - The record_link_group_guids_with_no_reverse_link_group of this GsaUnresolvedReverseRecordLinkGroupsErrorDetail. - """ - return self._record_link_group_guids_with_no_reverse_link_group - - @record_link_group_guids_with_no_reverse_link_group.setter - def record_link_group_guids_with_no_reverse_link_group( - self, record_link_group_guids_with_no_reverse_link_group: "list[str]" - ) -> None: - """Sets the record_link_group_guids_with_no_reverse_link_group of this GsaUnresolvedReverseRecordLinkGroupsErrorDetail. - - Parameters - ---------- - record_link_group_guids_with_no_reverse_link_group: list[str] - The record_link_group_guids_with_no_reverse_link_group of this GsaUnresolvedReverseRecordLinkGroupsErrorDetail. - """ - # Field is not nullable - if record_link_group_guids_with_no_reverse_link_group is None: - raise ValueError( - "Invalid value for 'record_link_group_guids_with_no_reverse_link_group', must not be 'None'" - ) - # Field is required - if record_link_group_guids_with_no_reverse_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'record_link_group_guids_with_no_reverse_link_group', must not be 'Unset'" - ) - self._record_link_group_guids_with_no_reverse_link_group = ( - record_link_group_guids_with_no_reverse_link_group - ) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedReverseRecordLinkGroupsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_target_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_target_attribute.py deleted file mode 100644 index 2ceb3329..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_unresolved_target_attribute.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_target_attribute import ( # noqa: F401 - GsaTargetAttribute, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_target_attribute_type import ( - GsaTargetAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedTargetAttribute(GsaTargetAttribute): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "target_type": "GsaTargetAttributeType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "target_type": "targetType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - target_type: "GsaTargetAttributeType" = GsaTargetAttributeType.UNRESOLVED, - ) -> None: - """GsaUnresolvedTargetAttribute - a model defined in Swagger - - Parameters - ---------- - guid: str - target_type: GsaTargetAttributeType - """ - super().__init__(guid=guid, target_type=target_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedTargetAttribute): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control.py deleted file mode 100644 index 7ed5886d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - discriminator_value_class_map = { - "permissionBased".lower(): "#/components/schemas/GsaUpdatePermissionBasedAccessControl", - "attributeBased".lower(): "#/components/schemas/GsaUpdateAttributeBasedAccessControl", - } - - discriminator: Optional[str] = "mode" - - def __init__( - self, - *, - mode: "GsaAccessControlMode", - ) -> None: - """GsaUpdateAccessControl - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - self._mode: GsaAccessControlMode - - self.mode = mode - - @property - def mode(self) -> "GsaAccessControlMode": - """Gets the mode of this GsaUpdateAccessControl. - - Returns - ------- - GsaAccessControlMode - The mode of this GsaUpdateAccessControl. - """ - return self._mode - - @mode.setter - def mode(self, mode: "GsaAccessControlMode") -> None: - """Sets the mode of this GsaUpdateAccessControl. - - Parameters - ---------- - mode: GsaAccessControlMode - The mode of this GsaUpdateAccessControl. - """ - # Field is not nullable - if mode is None: - raise ValueError("Invalid value for 'mode', must not be 'None'") - # Field is required - if mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'mode', must not be 'Unset'") - self._mode = mode - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category.py deleted file mode 100644 index 30c79ea1..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category.py +++ /dev/null @@ -1,216 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAccessControlCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "table_mappings": "list[GsaUpdateAccessControlCategoryTableMapping]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "table_mappings": "tableMappings", - } - - subtype_mapping: dict[str, str] = { - "tableMappings": "GsaUpdateAccessControlCategoryTableMapping", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - table_mappings: "list[GsaUpdateAccessControlCategoryTableMapping] | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdateAccessControlCategory - a model defined in Swagger - - Parameters - ---------- - guid: str, optional - name: str, optional - table_mappings: list[GsaUpdateAccessControlCategoryTableMapping] | None, optional - """ - self._table_mappings: ( - list[GsaUpdateAccessControlCategoryTableMapping] | None | Unset_Type - ) = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if table_mappings is not Unset: - self.table_mappings = table_mappings - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def table_mappings( - self, - ) -> "list[GsaUpdateAccessControlCategoryTableMapping] | None | Unset_Type": - """Gets the table_mappings of this GsaUpdateAccessControlCategory. - Optionally maps an attribute, and values applied to the table, for each table. Replaces all existing table mappings with the provided list. There can be at most one entry for each table. Existing mappings for tables not included in this list will be deleted. To remove an existing mapping, include the table with a null attribute. To remove all mappings, set this property to null. If this property is omitted, table mappings are not changed. - - Returns - ------- - list[GsaUpdateAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaUpdateAccessControlCategory. - """ - return self._table_mappings - - @table_mappings.setter - def table_mappings( - self, table_mappings: "list[GsaUpdateAccessControlCategoryTableMapping] | None | Unset_Type" - ) -> None: - """Sets the table_mappings of this GsaUpdateAccessControlCategory. - Optionally maps an attribute, and values applied to the table, for each table. Replaces all existing table mappings with the provided list. There can be at most one entry for each table. Existing mappings for tables not included in this list will be deleted. To remove an existing mapping, include the table with a null attribute. To remove all mappings, set this property to null. If this property is omitted, table mappings are not changed. - - Parameters - ---------- - table_mappings: list[GsaUpdateAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaUpdateAccessControlCategory. - """ - self._table_mappings = table_mappings - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdateAccessControlCategory. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdateAccessControlCategory. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdateAccessControlCategory. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdateAccessControlCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdateAccessControlCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdateAccessControlCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdateAccessControlCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdateAccessControlCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAccessControlCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category_table_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category_table_mapping.py deleted file mode 100644 index cd061816..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_access_control_category_table_mapping.py +++ /dev/null @@ -1,216 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAccessControlCategoryTableMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "table_discrete_values": "list[GsaSlimEntity]", - } - - attribute_map: dict[str, str] = { - "table": "table", - "attribute": "attribute", - "table_discrete_values": "tableDiscreteValues", - } - - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "tableDiscreteValues": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table: "GsaSlimEntity", - attribute: "GsaSlimEntity | Unset_Type" = Unset, - table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdateAccessControlCategoryTableMapping - a model defined in Swagger - - Parameters - ---------- - table: GsaSlimEntity - attribute: GsaSlimEntity, optional - table_discrete_values: list[GsaSlimEntity] | None, optional - """ - self._table: GsaSlimEntity - self._attribute: GsaSlimEntity | Unset_Type = Unset - self._table_discrete_values: list[GsaSlimEntity] | None | Unset_Type = Unset - - self.table = table - if attribute is not Unset: - self.attribute = attribute - if table_discrete_values is not Unset: - self.table_discrete_values = table_discrete_values - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaUpdateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The table of this GsaUpdateAccessControlCategoryTableMapping. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaUpdateAccessControlCategoryTableMapping. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaUpdateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def attribute(self) -> "GsaSlimEntity | Unset_Type": - """Gets the attribute of this GsaUpdateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity | Unset_Type - The attribute of this GsaUpdateAccessControlCategoryTableMapping. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity | Unset_Type") -> None: - """Sets the attribute of this GsaUpdateAccessControlCategoryTableMapping. - - Parameters - ---------- - attribute: GsaSlimEntity | Unset_Type - The attribute of this GsaUpdateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - self._attribute = attribute - - @property - def table_discrete_values(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - The discrete values applied to the table for this mapping. If omitted and a mapping already exists for this table and attribute, the existing values are kept. If omitted and the attribute changed, any existing table discrete values are removed. Set to null or an empty array to remove all table discrete values. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - """ - return self._table_discrete_values - - @table_discrete_values.setter - def table_discrete_values( - self, table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - The discrete values applied to the table for this mapping. If omitted and a mapping already exists for this table and attribute, the existing values are kept. If omitted and the attribute changed, any existing table discrete values are removed. Set to null or an empty array to remove all table discrete values. - - Parameters - ---------- - table_discrete_values: list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - """ - self._table_discrete_values = table_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAccessControlCategoryTableMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute.py index ac9c797f..a31604e3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute.py @@ -65,8 +65,8 @@ class GsaUpdateAttribute(ModelBase): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -76,8 +76,8 @@ class GsaUpdateAttribute(ModelBase): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -87,6 +87,7 @@ class GsaUpdateAttribute(ModelBase): subtype_mapping: dict[str, str] = { "type": "GsaAttributeType", "defaultThresholdType": "GsaAttributeThresholdType", + "axisName": "GsaUpdateAxisName", "aboutAttribute": "GsaSlimEntity", } @@ -115,8 +116,8 @@ def __init__( *, type: "GsaAttributeType", about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -128,8 +129,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -137,24 +138,24 @@ def __init__( """ self._type: GsaAttributeType self._default_threshold_type: GsaAttributeThresholdType | Unset_Type = Unset + self._axis_name: GsaUpdateAxisName | Unset_Type = Unset self._help_path: str | None | Unset_Type = Unset self._about_attribute: GsaSlimEntity | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset self._name: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset self.type = type if default_threshold_type is not Unset: self.default_threshold_type = default_threshold_type + if axis_name is not Unset: + self.axis_name = axis_name if help_path is not Unset: self.help_path = help_path if about_attribute is not Unset: self.about_attribute = about_attribute if is_hidden_from_search_criteria is not Unset: self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - if display_names is not Unset: - self.display_names = display_names if name is not Unset: self.name = name if guid is not Unset: @@ -215,6 +216,31 @@ def default_threshold_type( raise ValueError("Invalid value for 'default_threshold_type', must not be 'None'") self._default_threshold_type = default_threshold_type + @property + def axis_name(self) -> "GsaUpdateAxisName | Unset_Type": + """Gets the axis_name of this GsaUpdateAttribute. + + Returns + ------- + GsaUpdateAxisName | Unset_Type + The axis_name of this GsaUpdateAttribute. + """ + return self._axis_name + + @axis_name.setter + def axis_name(self, axis_name: "GsaUpdateAxisName | Unset_Type") -> None: + """Sets the axis_name of this GsaUpdateAttribute. + + Parameters + ---------- + axis_name: GsaUpdateAxisName | Unset_Type + The axis_name of this GsaUpdateAttribute. + """ + # Field is not nullable + if axis_name is None: + raise ValueError("Invalid value for 'axis_name', must not be 'None'") + self._axis_name = axis_name + @property def help_path(self) -> "str | None | Unset_Type": """Gets the help_path of this GsaUpdateAttribute. @@ -288,30 +314,6 @@ def is_hidden_from_search_criteria( """ self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaUpdateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaUpdateAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaUpdateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaUpdateAttribute. - """ - self._display_names = display_names - @property def name(self) -> "str | Unset_Type": """Gets the name of this GsaUpdateAttribute. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute_based_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute_based_access_control.py deleted file mode 100644 index d5da41d8..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_attribute_based_access_control.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_update_access_control import ( # noqa: F401 - GsaUpdateAccessControl, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAttributeBasedAccessControl(GsaUpdateAccessControl): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - "update_current_rule_engine": "GsaUpdateCurrentRuleEngine", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - "update_current_rule_engine": "updateCurrentRuleEngine", - } - - subtype_mapping: dict[str, str] = { - "updateCurrentRuleEngine": "GsaUpdateCurrentRuleEngine", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode" = GsaAccessControlMode.ATTRIBUTEBASED, - update_current_rule_engine: "GsaUpdateCurrentRuleEngine", - ) -> None: - """GsaUpdateAttributeBasedAccessControl - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - update_current_rule_engine: GsaUpdateCurrentRuleEngine - """ - super().__init__(mode=mode) - self._update_current_rule_engine: GsaUpdateCurrentRuleEngine - - self.update_current_rule_engine = update_current_rule_engine - - @property - def update_current_rule_engine(self) -> "GsaUpdateCurrentRuleEngine": - """Gets the update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - - Returns - ------- - GsaUpdateCurrentRuleEngine - The update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - """ - return self._update_current_rule_engine - - @update_current_rule_engine.setter - def update_current_rule_engine( - self, update_current_rule_engine: "GsaUpdateCurrentRuleEngine" - ) -> None: - """Sets the update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - - Parameters - ---------- - update_current_rule_engine: GsaUpdateCurrentRuleEngine - The update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - """ - # Field is not nullable - if update_current_rule_engine is None: - raise ValueError("Invalid value for 'update_current_rule_engine', must not be 'None'") - # Field is required - if update_current_rule_engine is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'update_current_rule_engine', must not be 'Unset'") - self._update_current_rule_engine = update_current_rule_engine - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAttributeBasedAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_current_rule_engine.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_current_rule_engine.py deleted file mode 100644 index d6e88a38..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_current_rule_engine.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateCurrentRuleEngine(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "fully_qualified_type_name": "str", - } - - attribute_map: dict[str, str] = { - "fully_qualified_type_name": "fullyQualifiedTypeName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - fully_qualified_type_name: "str", - ) -> None: - """GsaUpdateCurrentRuleEngine - a model defined in Swagger - - Parameters - ---------- - fully_qualified_type_name: str - """ - self._fully_qualified_type_name: str - - self.fully_qualified_type_name = fully_qualified_type_name - - @property - def fully_qualified_type_name(self) -> "str": - """Gets the fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - The fully qualified name of the rule engine implementation. - - Returns - ------- - str - The fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - """ - return self._fully_qualified_type_name - - @fully_qualified_type_name.setter - def fully_qualified_type_name(self, fully_qualified_type_name: "str") -> None: - """Sets the fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - The fully qualified name of the rule engine implementation. - - Parameters - ---------- - fully_qualified_type_name: str - The fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - """ - # Field is not nullable - if fully_qualified_type_name is None: - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'None'") - # Field is required - if fully_qualified_type_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'Unset'") - self._fully_qualified_type_name = fully_qualified_type_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateCurrentRuleEngine): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database.py index 944826dd..b40fb090 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database.py @@ -67,10 +67,8 @@ class GsaUpdateDatabase(ModelBase): "currency_code": "str", "data_source": "str", "database_key": "str", - "default_table": "GsaSlimEntity", "guid": "str", "initial_catalog": "str", - "is_implicit_profile_disabled": "bool", "is_read_only": "bool", "language": "str", "loading_order": "int", @@ -78,7 +76,6 @@ class GsaUpdateDatabase(ModelBase): "notes": "str", "sql_password": "str", "sql_user_name": "str", - "use_configuration_database_credentials": "bool", "use_integrated_security": "bool", "version_guid": "str", } @@ -90,10 +87,8 @@ class GsaUpdateDatabase(ModelBase): "currency_code": "currencyCode", "data_source": "dataSource", "database_key": "databaseKey", - "default_table": "defaultTable", "guid": "guid", "initial_catalog": "initialCatalog", - "is_implicit_profile_disabled": "isImplicitProfileDisabled", "is_read_only": "isReadOnly", "language": "language", "loading_order": "loadingOrder", @@ -101,14 +96,11 @@ class GsaUpdateDatabase(ModelBase): "notes": "notes", "sql_password": "sqlPassword", "sql_user_name": "sqlUserName", - "use_configuration_database_credentials": "useConfigurationDatabaseCredentials", "use_integrated_security": "useIntegratedSecurity", "version_guid": "versionGuid", } - subtype_mapping: dict[str, str] = { - "defaultTable": "GsaSlimEntity", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -118,13 +110,11 @@ def __init__( additional_sql_parameters: "str | None | Unset_Type" = Unset, author: "str | None | Unset_Type" = Unset, company: "str | None | Unset_Type" = Unset, - currency_code: "str | Unset_Type" = Unset, - data_source: "str | Unset_Type" = Unset, - database_key: "str | Unset_Type" = Unset, - default_table: "GsaSlimEntity | Unset_Type" = Unset, + currency_code: "str | None | Unset_Type" = Unset, + data_source: "str | None | Unset_Type" = Unset, + database_key: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, - initial_catalog: "str | Unset_Type" = Unset, - is_implicit_profile_disabled: "bool | Unset_Type" = Unset, + initial_catalog: "str | None | Unset_Type" = Unset, is_read_only: "bool | Unset_Type" = Unset, language: "str | None | Unset_Type" = Unset, loading_order: "int | Unset_Type" = Unset, @@ -132,7 +122,6 @@ def __init__( notes: "str | None | Unset_Type" = Unset, sql_password: "str | None | Unset_Type" = Unset, sql_user_name: "str | None | Unset_Type" = Unset, - use_configuration_database_credentials: "bool | None | Unset_Type" = Unset, use_integrated_security: "bool | None | Unset_Type" = Unset, version_guid: "str | Unset_Type" = Unset, ) -> None: @@ -143,13 +132,11 @@ def __init__( additional_sql_parameters: str | None, optional author: str | None, optional company: str | None, optional - currency_code: str, optional - data_source: str, optional - database_key: str, optional - default_table: GsaSlimEntity, optional + currency_code: str | None, optional + data_source: str | None, optional + database_key: str | None, optional guid: str, optional - initial_catalog: str, optional - is_implicit_profile_disabled: bool, optional + initial_catalog: str | None, optional is_read_only: bool, optional language: str | None, optional loading_order: int, optional @@ -157,30 +144,26 @@ def __init__( notes: str | None, optional sql_password: str | None, optional sql_user_name: str | None, optional - use_configuration_database_credentials: bool | None, optional use_integrated_security: bool | None, optional version_guid: str, optional """ self._author: str | None | Unset_Type = Unset self._company: str | None | Unset_Type = Unset self._notes: str | None | Unset_Type = Unset - self._currency_code: str | Unset_Type = Unset + self._currency_code: str | None | Unset_Type = Unset self._version_guid: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset self._name: str | Unset_Type = Unset - self._is_implicit_profile_disabled: bool | Unset_Type = Unset self._is_read_only: bool | Unset_Type = Unset self._language: str | None | Unset_Type = Unset - self._database_key: str | Unset_Type = Unset - self._data_source: str | Unset_Type = Unset - self._use_configuration_database_credentials: bool | None | Unset_Type = Unset + self._database_key: str | None | Unset_Type = Unset + self._data_source: str | None | Unset_Type = Unset self._use_integrated_security: bool | None | Unset_Type = Unset self._sql_user_name: str | None | Unset_Type = Unset self._sql_password: str | None | Unset_Type = Unset - self._initial_catalog: str | Unset_Type = Unset + self._initial_catalog: str | None | Unset_Type = Unset self._additional_sql_parameters: str | None | Unset_Type = Unset self._loading_order: int | Unset_Type = Unset - self._default_table: GsaSlimEntity | Unset_Type = Unset if author is not Unset: self.author = author @@ -196,8 +179,6 @@ def __init__( self.guid = guid if name is not Unset: self.name = name - if is_implicit_profile_disabled is not Unset: - self.is_implicit_profile_disabled = is_implicit_profile_disabled if is_read_only is not Unset: self.is_read_only = is_read_only if language is not Unset: @@ -206,8 +187,6 @@ def __init__( self.database_key = database_key if data_source is not Unset: self.data_source = data_source - if use_configuration_database_credentials is not Unset: - self.use_configuration_database_credentials = use_configuration_database_credentials if use_integrated_security is not Unset: self.use_integrated_security = use_integrated_security if sql_user_name is not Unset: @@ -220,8 +199,6 @@ def __init__( self.additional_sql_parameters = additional_sql_parameters if loading_order is not Unset: self.loading_order = loading_order - if default_table is not Unset: - self.default_table = default_table @property def author(self) -> "str | None | Unset_Type": @@ -296,30 +273,27 @@ def notes(self, notes: "str | None | Unset_Type") -> None: self._notes = notes @property - def currency_code(self) -> "str | Unset_Type": + def currency_code(self) -> "str | None | Unset_Type": """Gets the currency_code of this GsaUpdateDatabase. The currency code on the database. Can only be edited by a database data administrator Returns ------- - str | Unset_Type + str | None | Unset_Type The currency_code of this GsaUpdateDatabase. """ return self._currency_code @currency_code.setter - def currency_code(self, currency_code: "str | Unset_Type") -> None: + def currency_code(self, currency_code: "str | None | Unset_Type") -> None: """Sets the currency_code of this GsaUpdateDatabase. The currency code on the database. Can only be edited by a database data administrator Parameters ---------- - currency_code: str | Unset_Type + currency_code: str | None | Unset_Type The currency_code of this GsaUpdateDatabase. """ - # Field is not nullable - if currency_code is None: - raise ValueError("Invalid value for 'currency_code', must not be 'None'") self._currency_code = currency_code @property @@ -403,35 +377,6 @@ def name(self, name: "str | Unset_Type") -> None: raise ValueError("Invalid value for 'name', must not be 'None'") self._name = name - @property - def is_implicit_profile_disabled(self) -> "bool | Unset_Type": - """Gets the is_implicit_profile_disabled of this GsaUpdateDatabase. - Whether the implicit Profile for this database is disabled. Can only be edited by a database data administrator - - Returns - ------- - bool | Unset_Type - The is_implicit_profile_disabled of this GsaUpdateDatabase. - """ - return self._is_implicit_profile_disabled - - @is_implicit_profile_disabled.setter - def is_implicit_profile_disabled( - self, is_implicit_profile_disabled: "bool | Unset_Type" - ) -> None: - """Sets the is_implicit_profile_disabled of this GsaUpdateDatabase. - Whether the implicit Profile for this database is disabled. Can only be edited by a database data administrator - - Parameters - ---------- - is_implicit_profile_disabled: bool | Unset_Type - The is_implicit_profile_disabled of this GsaUpdateDatabase. - """ - # Field is not nullable - if is_implicit_profile_disabled is None: - raise ValueError("Invalid value for 'is_implicit_profile_disabled', must not be 'None'") - self._is_implicit_profile_disabled = is_implicit_profile_disabled - @property def is_read_only(self) -> "bool | Unset_Type": """Gets the is_read_only of this GsaUpdateDatabase. @@ -484,85 +429,53 @@ def language(self, language: "str | None | Unset_Type") -> None: self._language = language @property - def database_key(self) -> "str | Unset_Type": + def database_key(self) -> "str | None | Unset_Type": """Gets the database_key of this GsaUpdateDatabase. The unique key of the database. Can only be edited by a system administrator Returns ------- - str | Unset_Type + str | None | Unset_Type The database_key of this GsaUpdateDatabase. """ return self._database_key @database_key.setter - def database_key(self, database_key: "str | Unset_Type") -> None: + def database_key(self, database_key: "str | None | Unset_Type") -> None: """Sets the database_key of this GsaUpdateDatabase. The unique key of the database. Can only be edited by a system administrator Parameters ---------- - database_key: str | Unset_Type + database_key: str | None | Unset_Type The database_key of this GsaUpdateDatabase. """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") self._database_key = database_key @property - def data_source(self) -> "str | Unset_Type": + def data_source(self) -> "str | None | Unset_Type": """Gets the data_source of this GsaUpdateDatabase. The SQL server data source. Can only be edited by a system administrator Returns ------- - str | Unset_Type + str | None | Unset_Type The data_source of this GsaUpdateDatabase. """ return self._data_source @data_source.setter - def data_source(self, data_source: "str | Unset_Type") -> None: + def data_source(self, data_source: "str | None | Unset_Type") -> None: """Sets the data_source of this GsaUpdateDatabase. The SQL server data source. Can only be edited by a system administrator Parameters ---------- - data_source: str | Unset_Type + data_source: str | None | Unset_Type The data_source of this GsaUpdateDatabase. """ - # Field is not nullable - if data_source is None: - raise ValueError("Invalid value for 'data_source', must not be 'None'") self._data_source = data_source - @property - def use_configuration_database_credentials(self) -> "bool | None | Unset_Type": - """Gets the use_configuration_database_credentials of this GsaUpdateDatabase. - Set to true if the SQL connection to the database should use the same credentials as connection to Configuration Database. Can only be edited by a system administrator - - Returns - ------- - bool | None | Unset_Type - The use_configuration_database_credentials of this GsaUpdateDatabase. - """ - return self._use_configuration_database_credentials - - @use_configuration_database_credentials.setter - def use_configuration_database_credentials( - self, use_configuration_database_credentials: "bool | None | Unset_Type" - ) -> None: - """Sets the use_configuration_database_credentials of this GsaUpdateDatabase. - Set to true if the SQL connection to the database should use the same credentials as connection to Configuration Database. Can only be edited by a system administrator - - Parameters - ---------- - use_configuration_database_credentials: bool | None | Unset_Type - The use_configuration_database_credentials of this GsaUpdateDatabase. - """ - self._use_configuration_database_credentials = use_configuration_database_credentials - @property def use_integrated_security(self) -> "bool | None | Unset_Type": """Gets the use_integrated_security of this GsaUpdateDatabase. @@ -636,30 +549,27 @@ def sql_password(self, sql_password: "str | None | Unset_Type") -> None: self._sql_password = sql_password @property - def initial_catalog(self) -> "str | Unset_Type": + def initial_catalog(self) -> "str | None | Unset_Type": """Gets the initial_catalog of this GsaUpdateDatabase. The name of the database in SQL server. Can only be edited by a system administrator Returns ------- - str | Unset_Type + str | None | Unset_Type The initial_catalog of this GsaUpdateDatabase. """ return self._initial_catalog @initial_catalog.setter - def initial_catalog(self, initial_catalog: "str | Unset_Type") -> None: + def initial_catalog(self, initial_catalog: "str | None | Unset_Type") -> None: """Sets the initial_catalog of this GsaUpdateDatabase. The name of the database in SQL server. Can only be edited by a system administrator Parameters ---------- - initial_catalog: str | Unset_Type + initial_catalog: str | None | Unset_Type The initial_catalog of this GsaUpdateDatabase. """ - # Field is not nullable - if initial_catalog is None: - raise ValueError("Invalid value for 'initial_catalog', must not be 'None'") self._initial_catalog = initial_catalog @property @@ -715,31 +625,6 @@ def loading_order(self, loading_order: "int | Unset_Type") -> None: raise ValueError("Invalid value for 'loading_order', must not be 'None'") self._loading_order = loading_order - @property - def default_table(self) -> "GsaSlimEntity | Unset_Type": - """Gets the default_table of this GsaUpdateDatabase. - - Returns - ------- - GsaSlimEntity | Unset_Type - The default_table of this GsaUpdateDatabase. - """ - return self._default_table - - @default_table.setter - def default_table(self, default_table: "GsaSlimEntity | Unset_Type") -> None: - """Sets the default_table of this GsaUpdateDatabase. - - Parameters - ---------- - default_table: GsaSlimEntity | Unset_Type - The default_table of this GsaUpdateDatabase. - """ - # Field is not nullable - if default_table is None: - raise ValueError("Invalid value for 'default_table', must not be 'None'") - self._default_table = default_table - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database_security_groups.py deleted file mode 100644 index 285ac693..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_database_security_groups.py +++ /dev/null @@ -1,258 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDatabaseSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str | None | Unset_Type" = Unset, - grant_group: "str | None | Unset_Type" = Unset, - power_user_group: "str | None | Unset_Type" = Unset, - read_group: "str | None | Unset_Type" = Unset, - write_group: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdateDatabaseSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str | None, optional - grant_group: str | None, optional - power_user_group: str | None, optional - read_group: str | None, optional - write_group: str | None, optional - """ - self._admin_group: str | None | Unset_Type = Unset - self._grant_group: str | None | Unset_Type = Unset - self._power_user_group: str | None | Unset_Type = Unset - self._write_group: str | None | Unset_Type = Unset - self._read_group: str | None | Unset_Type = Unset - - if admin_group is not Unset: - self.admin_group = admin_group - if grant_group is not Unset: - self.grant_group = grant_group - if power_user_group is not Unset: - self.power_user_group = power_user_group - if write_group is not Unset: - self.write_group = write_group - if read_group is not Unset: - self.read_group = read_group - - @property - def admin_group(self) -> "str | None | Unset_Type": - """Gets the admin_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The admin_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str | None | Unset_Type") -> None: - """Sets the admin_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - admin_group: str | None | Unset_Type - The admin_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._admin_group = admin_group - - @property - def grant_group(self) -> "str | None | Unset_Type": - """Gets the grant_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The grant_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str | None | Unset_Type") -> None: - """Sets the grant_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - grant_group: str | None | Unset_Type - The grant_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str | None | Unset_Type": - """Gets the power_user_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The power_user_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str | None | Unset_Type") -> None: - """Sets the power_user_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - power_user_group: str | None | Unset_Type - The power_user_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str | None | Unset_Type": - """Gets the write_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The write_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str | None | Unset_Type") -> None: - """Sets the write_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - write_group: str | None | Unset_Type - The write_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._write_group = write_group - - @property - def read_group(self) -> "str | None | Unset_Type": - """Gets the read_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The read_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str | None | Unset_Type") -> None: - """Sets the read_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - read_group: str | None | Unset_Type - The read_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDatabaseSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_date_time_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_date_time_attribute.py index dc2c127d..899e0742 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_date_time_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_date_time_attribute.py @@ -68,8 +68,8 @@ class GsaUpdateDateTimeAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -79,8 +79,8 @@ class GsaUpdateDateTimeAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -96,8 +96,8 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.DATETIME, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -109,8 +109,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -119,8 +119,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_database.py deleted file mode 100644 index 672c3111..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_database.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDefaultDatabase(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "default_database_key": "str", - } - - attribute_map: dict[str, str] = { - "default_database_key": "defaultDatabaseKey", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - default_database_key: "str", - ) -> None: - """GsaUpdateDefaultDatabase - a model defined in Swagger - - Parameters - ---------- - default_database_key: str - """ - self._default_database_key: str - - self.default_database_key = default_database_key - - @property - def default_database_key(self) -> "str": - """Gets the default_database_key of this GsaUpdateDefaultDatabase. - - Returns - ------- - str - The default_database_key of this GsaUpdateDefaultDatabase. - """ - return self._default_database_key - - @default_database_key.setter - def default_database_key(self, default_database_key: "str") -> None: - """Sets the default_database_key of this GsaUpdateDefaultDatabase. - - Parameters - ---------- - default_database_key: str - The default_database_key of this GsaUpdateDefaultDatabase. - """ - # Field is not nullable - if default_database_key is None: - raise ValueError("Invalid value for 'default_database_key', must not be 'None'") - # Field is required - if default_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'default_database_key', must not be 'Unset'") - self._default_database_key = default_database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDefaultDatabase): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_fallback_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_fallback_security_groups.py deleted file mode 100644 index ade64e91..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_default_fallback_security_groups.py +++ /dev/null @@ -1,305 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDefaultFallbackSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "system_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "system_group": "systemGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str | Unset_Type" = Unset, - grant_group: "str | Unset_Type" = Unset, - power_user_group: "str | Unset_Type" = Unset, - read_group: "str | Unset_Type" = Unset, - system_group: "str | Unset_Type" = Unset, - write_group: "str | Unset_Type" = Unset, - ) -> None: - """GsaUpdateDefaultFallbackSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str, optional - grant_group: str, optional - power_user_group: str, optional - read_group: str, optional - system_group: str, optional - write_group: str, optional - """ - self._system_group: str | Unset_Type = Unset - self._admin_group: str | Unset_Type = Unset - self._grant_group: str | Unset_Type = Unset - self._power_user_group: str | Unset_Type = Unset - self._write_group: str | Unset_Type = Unset - self._read_group: str | Unset_Type = Unset - - if system_group is not Unset: - self.system_group = system_group - if admin_group is not Unset: - self.admin_group = admin_group - if grant_group is not Unset: - self.grant_group = grant_group - if power_user_group is not Unset: - self.power_user_group = power_user_group - if write_group is not Unset: - self.write_group = write_group - if read_group is not Unset: - self.read_group = read_group - - @property - def system_group(self) -> "str | Unset_Type": - """Gets the system_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The system_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._system_group - - @system_group.setter - def system_group(self, system_group: "str | Unset_Type") -> None: - """Sets the system_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - system_group: str | Unset_Type - The system_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if system_group is None: - raise ValueError("Invalid value for 'system_group', must not be 'None'") - self._system_group = system_group - - @property - def admin_group(self) -> "str | Unset_Type": - """Gets the admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str | Unset_Type") -> None: - """Sets the admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - admin_group: str | Unset_Type - The admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if admin_group is None: - raise ValueError("Invalid value for 'admin_group', must not be 'None'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str | Unset_Type": - """Gets the grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str | Unset_Type") -> None: - """Sets the grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - grant_group: str | Unset_Type - The grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if grant_group is None: - raise ValueError("Invalid value for 'grant_group', must not be 'None'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str | Unset_Type": - """Gets the power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str | Unset_Type") -> None: - """Sets the power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - power_user_group: str | Unset_Type - The power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if power_user_group is None: - raise ValueError("Invalid value for 'power_user_group', must not be 'None'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str | Unset_Type": - """Gets the write_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The write_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str | Unset_Type") -> None: - """Sets the write_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - write_group: str | Unset_Type - The write_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if write_group is None: - raise ValueError("Invalid value for 'write_group', must not be 'None'") - self._write_group = write_group - - @property - def read_group(self) -> "str | Unset_Type": - """Gets the read_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The read_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str | Unset_Type") -> None: - """Sets the read_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - read_group: str | Unset_Type - The read_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if read_group is None: - raise ValueError("Invalid value for 'read_group', must not be 'None'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDefaultFallbackSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_attribute.py index 6069426b..26c19c57 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_attribute.py @@ -68,8 +68,8 @@ class GsaUpdateDiscreteAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -80,8 +80,8 @@ class GsaUpdateDiscreteAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -98,8 +98,8 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.DISCRETE, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -112,8 +112,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -123,8 +123,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_functional_attribute.py index 0b71c86c..6e8f77d8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_functional_attribute.py @@ -69,8 +69,8 @@ class GsaUpdateDiscreteFunctionalAttribute(GsaUpdateAttribute): "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", "attribute_parameters": "list[GsaUpdateDiscreteFunctionalAttributeParameter]", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -81,8 +81,8 @@ class GsaUpdateDiscreteFunctionalAttribute(GsaUpdateAttribute): "type": "type", "about_attribute": "aboutAttribute", "attribute_parameters": "attributeParameters", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -101,8 +101,8 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.DISCRETEFUNCTIONAL, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, attribute_parameters: "list[GsaUpdateDiscreteFunctionalAttributeParameter] | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -115,8 +115,8 @@ def __init__( type: GsaAttributeType about_attribute: GsaSlimEntity, optional attribute_parameters: list[GsaUpdateDiscreteFunctionalAttributeParameter], optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -125,8 +125,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_parameter.py index 9b9e41bc..5a0fcb35 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_parameter.py @@ -68,24 +68,20 @@ class GsaUpdateDiscreteParameter(GsaUpdateParameter): swagger_types: dict[str, str] = { "type": "GsaParameterType", "default_parameter_value_guid": "str", - "default_parameter_value_index": "int", "guid": "str", + "help_path": "str", "name": "str", - "values": "list[GsaUpdateDiscreteParameterValue]", } attribute_map: dict[str, str] = { "type": "type", "default_parameter_value_guid": "defaultParameterValueGuid", - "default_parameter_value_index": "defaultParameterValueIndex", "guid": "guid", + "help_path": "helpPath", "name": "name", - "values": "values", } - subtype_mapping: dict[str, str] = { - "values": "GsaUpdateDiscreteParameterValue", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -94,10 +90,9 @@ def __init__( *, type: "GsaParameterType" = GsaParameterType.DISCRETE, default_parameter_value_guid: "str | Unset_Type" = Unset, - default_parameter_value_index: "int | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, - values: "list[GsaUpdateDiscreteParameterValue] | Unset_Type" = Unset, ) -> None: """GsaUpdateDiscreteParameter - a model defined in Swagger @@ -105,49 +100,17 @@ def __init__( ---------- type: GsaParameterType default_parameter_value_guid: str, optional - default_parameter_value_index: int, optional guid: str, optional + help_path: str | None, optional name: str, optional - values: list[GsaUpdateDiscreteParameterValue], optional """ super().__init__( type=type, default_parameter_value_guid=default_parameter_value_guid, - default_parameter_value_index=default_parameter_value_index, guid=guid, + help_path=help_path, name=name, ) - self._values: list[GsaUpdateDiscreteParameterValue] | Unset_Type = Unset - - if values is not Unset: - self.values = values - - @property - def values(self) -> "list[GsaUpdateDiscreteParameterValue] | Unset_Type": - """Gets the values of this GsaUpdateDiscreteParameter. - Update the set of parameter values. This can result in adding, modifying, deleting and reordering parameter values. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a name. - - Returns - ------- - list[GsaUpdateDiscreteParameterValue] | Unset_Type - The values of this GsaUpdateDiscreteParameter. - """ - return self._values - - @values.setter - def values(self, values: "list[GsaUpdateDiscreteParameterValue] | Unset_Type") -> None: - """Sets the values of this GsaUpdateDiscreteParameter. - Update the set of parameter values. This can result in adding, modifying, deleting and reordering parameter values. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a name. - - Parameters - ---------- - values: list[GsaUpdateDiscreteParameterValue] | Unset_Type - The values of this GsaUpdateDiscreteParameter. - """ - # Field is not nullable - if values is None: - raise ValueError("Invalid value for 'values', must not be 'None'") - self._values = values @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_type.py index d68a806a..8867a191 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_discrete_type.py @@ -61,29 +61,24 @@ class GsaUpdateDiscreteType(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "discrete_values": "list[GsaPutDiscreteValue]", "guid": "str", "is_ordered": "bool", "name": "str", } attribute_map: dict[str, str] = { - "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", "name": "name", } - subtype_mapping: dict[str, str] = { - "discreteValues": "GsaPutDiscreteValue", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - discrete_values: "list[GsaPutDiscreteValue] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, is_ordered: "bool | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, @@ -92,20 +87,16 @@ def __init__( Parameters ---------- - discrete_values: list[GsaPutDiscreteValue] | None, optional guid: str, optional is_ordered: bool, optional name: str, optional """ self._is_ordered: bool | Unset_Type = Unset - self._discrete_values: list[GsaPutDiscreteValue] | None | Unset_Type = Unset self._name: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset if is_ordered is not Unset: self.is_ordered = is_ordered - if discrete_values is not Unset: - self.discrete_values = discrete_values if name is not Unset: self.name = name if guid is not Unset: @@ -136,30 +127,6 @@ def is_ordered(self, is_ordered: "bool | Unset_Type") -> None: raise ValueError("Invalid value for 'is_ordered', must not be 'None'") self._is_ordered = is_ordered - @property - def discrete_values(self) -> "list[GsaPutDiscreteValue] | None | Unset_Type": - """Gets the discrete_values of this GsaUpdateDiscreteType. - - Returns - ------- - list[GsaPutDiscreteValue] | None | Unset_Type - The discrete_values of this GsaUpdateDiscreteType. - """ - return self._discrete_values - - @discrete_values.setter - def discrete_values( - self, discrete_values: "list[GsaPutDiscreteValue] | None | Unset_Type" - ) -> None: - """Sets the discrete_values of this GsaUpdateDiscreteType. - - Parameters - ---------- - discrete_values: list[GsaPutDiscreteValue] | None | Unset_Type - The discrete_values of this GsaUpdateDiscreteType. - """ - self._discrete_values = discrete_values - @property def name(self) -> "str | Unset_Type": """Gets the name of this GsaUpdateDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names.py deleted file mode 100644 index b1e73829..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDisplayNames(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "GsaGrid", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - } - - subtype_mapping: dict[str, str] = { - "displayNames": "GsaGrid", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "GsaGrid | Unset_Type" = Unset, - ) -> None: - """GsaUpdateDisplayNames - a model defined in Swagger - - Parameters - ---------- - display_names: GsaGrid, optional - """ - self._display_names: GsaGrid | Unset_Type = Unset - - if display_names is not Unset: - self.display_names = display_names - - @property - def display_names(self) -> "GsaGrid | Unset_Type": - """Gets the display_names of this GsaUpdateDisplayNames. - - Returns - ------- - GsaGrid | Unset_Type - The display_names of this GsaUpdateDisplayNames. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "GsaGrid | Unset_Type") -> None: - """Sets the display_names of this GsaUpdateDisplayNames. - - Parameters - ---------- - display_names: GsaGrid | Unset_Type - The display_names of this GsaUpdateDisplayNames. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - self._display_names = display_names - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDisplayNames): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names_response.py deleted file mode 100644 index a3d6d8d7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_display_names_response.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDisplayNamesResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "number_deleted": "int", - "number_updated": "int", - } - - attribute_map: dict[str, str] = { - "number_deleted": "numberDeleted", - "number_updated": "numberUpdated", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - number_deleted: "int", - number_updated: "int", - ) -> None: - """GsaUpdateDisplayNamesResponse - a model defined in Swagger - - Parameters - ---------- - number_deleted: int - number_updated: int - """ - self._number_updated: int - self._number_deleted: int - - self.number_updated = number_updated - self.number_deleted = number_deleted - - @property - def number_updated(self) -> "int": - """Gets the number_updated of this GsaUpdateDisplayNamesResponse. - - Returns - ------- - int - The number_updated of this GsaUpdateDisplayNamesResponse. - """ - return self._number_updated - - @number_updated.setter - def number_updated(self, number_updated: "int") -> None: - """Sets the number_updated of this GsaUpdateDisplayNamesResponse. - - Parameters - ---------- - number_updated: int - The number_updated of this GsaUpdateDisplayNamesResponse. - """ - # Field is not nullable - if number_updated is None: - raise ValueError("Invalid value for 'number_updated', must not be 'None'") - # Field is required - if number_updated is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_updated', must not be 'Unset'") - self._number_updated = number_updated - - @property - def number_deleted(self) -> "int": - """Gets the number_deleted of this GsaUpdateDisplayNamesResponse. - - Returns - ------- - int - The number_deleted of this GsaUpdateDisplayNamesResponse. - """ - return self._number_deleted - - @number_deleted.setter - def number_deleted(self, number_deleted: "int") -> None: - """Sets the number_deleted of this GsaUpdateDisplayNamesResponse. - - Parameters - ---------- - number_deleted: int - The number_deleted of this GsaUpdateDisplayNamesResponse. - """ - # Field is not nullable - if number_deleted is None: - raise ValueError("Invalid value for 'number_deleted', must not be 'None'") - # Field is required - if number_deleted is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_deleted', must not be 'Unset'") - self._number_deleted = number_deleted - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDisplayNamesResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_smart_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_dynamic_record_link_group.py similarity index 85% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_smart_record_link_group.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_dynamic_record_link_group.py index 2287287c..41ad7281 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_smart_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_dynamic_record_link_group.py @@ -49,7 +49,7 @@ from . import * -class GsaUpdateSmartRecordLinkGroup(GsaUpdateRecordLinkGroup): +class GsaUpdateDynamicRecordLinkGroup(GsaUpdateRecordLinkGroup): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -97,7 +97,7 @@ class GsaUpdateSmartRecordLinkGroup(GsaUpdateRecordLinkGroup): def __init__( self, *, - type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, + type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.DYNAMIC, attribute_pairs: "list[GsaCreateAttributeLinkPair] | Unset_Type" = Unset, forbid_orphans: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, @@ -105,7 +105,7 @@ def __init__( referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" = Unset, reverse_name: "str | Unset_Type" = Unset, ) -> None: - """GsaUpdateSmartRecordLinkGroup - a model defined in Swagger + """GsaUpdateDynamicRecordLinkGroup - a model defined in Swagger Parameters ---------- @@ -131,23 +131,23 @@ def __init__( @property def forbid_orphans(self) -> "bool | Unset_Type": - """Gets the forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + """Gets the forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. Returns ------- bool | Unset_Type - The forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + The forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. """ return self._forbid_orphans @forbid_orphans.setter def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: - """Sets the forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + """Sets the forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. Parameters ---------- forbid_orphans: bool | Unset_Type - The forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + The forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. """ # Field is not nullable if forbid_orphans is None: @@ -156,12 +156,12 @@ def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: @property def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_Type": - """Gets the referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + """Gets the referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. Returns ------- GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + The referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. """ return self._referential_integrity_model @@ -169,12 +169,12 @@ def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_T def referential_integrity_model( self, referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" ) -> None: - """Sets the referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + """Sets the referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. Parameters ---------- referential_integrity_model: GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + The referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. """ # Field is not nullable if referential_integrity_model is None: @@ -183,13 +183,12 @@ def referential_integrity_model( @property def attribute_pairs(self) -> "list[GsaCreateAttributeLinkPair] | Unset_Type": - """Gets the attribute_pairs of this GsaUpdateSmartRecordLinkGroup. - The attribute pairs cannot be updated other than by creating a new set. There must be at least one and not more than three attribute pairs. + """Gets the attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. Returns ------- list[GsaCreateAttributeLinkPair] | Unset_Type - The attribute_pairs of this GsaUpdateSmartRecordLinkGroup. + The attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. """ return self._attribute_pairs @@ -197,13 +196,12 @@ def attribute_pairs(self) -> "list[GsaCreateAttributeLinkPair] | Unset_Type": def attribute_pairs( self, attribute_pairs: "list[GsaCreateAttributeLinkPair] | Unset_Type" ) -> None: - """Sets the attribute_pairs of this GsaUpdateSmartRecordLinkGroup. - The attribute pairs cannot be updated other than by creating a new set. There must be at least one and not more than three attribute pairs. + """Sets the attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. Parameters ---------- attribute_pairs: list[GsaCreateAttributeLinkPair] | Unset_Type - The attribute_pairs of this GsaUpdateSmartRecordLinkGroup. + The attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. """ # Field is not nullable if attribute_pairs is None: @@ -232,7 +230,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateSmartRecordLinkGroup): + if not isinstance(other, GsaUpdateDynamicRecordLinkGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_file_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_file_attribute.py index b3be3721..7bf06c4f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_file_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_file_attribute.py @@ -68,8 +68,8 @@ class GsaUpdateFileAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -79,8 +79,8 @@ class GsaUpdateFileAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -96,8 +96,8 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.FILE, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -109,8 +109,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -119,8 +119,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_float_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_float_functional_attribute.py index 84f65a65..1e9ae079 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_float_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_float_functional_attribute.py @@ -71,7 +71,6 @@ class GsaUpdateFloatFunctionalAttribute(GsaUpdateAttribute): "attribute_parameters": "list[GsaUpdateFloatFunctionalAttributeParameter]", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -86,7 +85,6 @@ class GsaUpdateFloatFunctionalAttribute(GsaUpdateAttribute): "attribute_parameters": "attributeParameters", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -98,7 +96,6 @@ class GsaUpdateFloatFunctionalAttribute(GsaUpdateAttribute): subtype_mapping: dict[str, str] = { "unit": "GsaSlimEntity", "attributeParameters": "GsaUpdateFloatFunctionalAttributeParameter", - "axisName": "GsaUpdateAxisName", } discriminator: Optional[str] = None @@ -111,7 +108,6 @@ def __init__( attribute_parameters: "list[GsaUpdateFloatFunctionalAttributeParameter] | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -128,7 +124,6 @@ def __init__( attribute_parameters: list[GsaUpdateFloatFunctionalAttributeParameter], optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -139,8 +134,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, @@ -151,7 +146,6 @@ def __init__( list[GsaUpdateFloatFunctionalAttributeParameter] | Unset_Type ) = Unset self._is_range: bool | Unset_Type = Unset - self._axis_name: GsaUpdateAxisName | Unset_Type = Unset if unit is not Unset: self.unit = unit @@ -159,8 +153,6 @@ def __init__( self.attribute_parameters = attribute_parameters if is_range is not Unset: self.is_range = is_range - if axis_name is not Unset: - self.axis_name = axis_name @property def unit(self) -> "GsaSlimEntity | Unset_Type": @@ -241,31 +233,6 @@ def is_range(self, is_range: "bool | Unset_Type") -> None: raise ValueError("Invalid value for 'is_range', must not be 'None'") self._is_range = is_range - @property - def axis_name(self) -> "GsaUpdateAxisName | Unset_Type": - """Gets the axis_name of this GsaUpdateFloatFunctionalAttribute. - - Returns - ------- - GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateFloatFunctionalAttribute. - """ - return self._axis_name - - @axis_name.setter - def axis_name(self, axis_name: "GsaUpdateAxisName | Unset_Type") -> None: - """Sets the axis_name of this GsaUpdateFloatFunctionalAttribute. - - Parameters - ---------- - axis_name: GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateFloatFunctionalAttribute. - """ - # Field is not nullable - if axis_name is None: - raise ValueError("Invalid value for 'axis_name', must not be 'None'") - self._axis_name = axis_name - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_hyperlink_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_hyperlink_attribute.py index bb31b0b5..1f66710b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_hyperlink_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_hyperlink_attribute.py @@ -68,8 +68,8 @@ class GsaUpdateHyperlinkAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -79,8 +79,8 @@ class GsaUpdateHyperlinkAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -96,8 +96,8 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.HYPERLINK, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -109,8 +109,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -119,8 +119,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_integer_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_integer_attribute.py index 5807583a..a369e44b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_integer_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_integer_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateIntegerAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -83,7 +82,6 @@ class GsaUpdateIntegerAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -91,9 +89,7 @@ class GsaUpdateIntegerAttribute(GsaUpdateAttribute): "name": "name", } - subtype_mapping: dict[str, str] = { - "axisName": "GsaUpdateAxisName", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -104,7 +100,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -119,7 +114,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -129,20 +123,17 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, name=name, ) self._is_unique: bool | Unset_Type = Unset - self._axis_name: GsaUpdateAxisName | Unset_Type = Unset if is_unique is not Unset: self.is_unique = is_unique - if axis_name is not Unset: - self.axis_name = axis_name @property def is_unique(self) -> "bool | Unset_Type": @@ -171,31 +162,6 @@ def is_unique(self, is_unique: "bool | Unset_Type") -> None: raise ValueError("Invalid value for 'is_unique', must not be 'None'") self._is_unique = is_unique - @property - def axis_name(self) -> "GsaUpdateAxisName | Unset_Type": - """Gets the axis_name of this GsaUpdateIntegerAttribute. - - Returns - ------- - GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateIntegerAttribute. - """ - return self._axis_name - - @axis_name.setter - def axis_name(self, axis_name: "GsaUpdateAxisName | Unset_Type") -> None: - """Sets the axis_name of this GsaUpdateIntegerAttribute. - - Parameters - ---------- - axis_name: GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateIntegerAttribute. - """ - # Field is not nullable - if axis_name is None: - raise ValueError("Invalid value for 'axis_name', must not be 'None'") - self._axis_name = axis_name - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_layout_section.py deleted file mode 100644 index 3f0eb71f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_layout_section.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateLayoutSection(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "section_items": "list[GsaPutLayoutItem]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "section_items": "sectionItems", - } - - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaPutLayoutItem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - section_items: "list[GsaPutLayoutItem] | Unset_Type" = Unset, - ) -> None: - """GsaUpdateLayoutSection - a model defined in Swagger - - Parameters - ---------- - guid: str, optional - name: str, optional - section_items: list[GsaPutLayoutItem], optional - """ - self._section_items: list[GsaPutLayoutItem] | Unset_Type = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if section_items is not Unset: - self.section_items = section_items - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def section_items(self) -> "list[GsaPutLayoutItem] | Unset_Type": - """Gets the section_items of this GsaUpdateLayoutSection. - Update the set of items, in order. If an existing item is not included, it will be deleted. - - Returns - ------- - list[GsaPutLayoutItem] | Unset_Type - The section_items of this GsaUpdateLayoutSection. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "list[GsaPutLayoutItem] | Unset_Type") -> None: - """Sets the section_items of this GsaUpdateLayoutSection. - Update the set of items, in order. If an existing item is not included, it will be deleted. - - Parameters - ---------- - section_items: list[GsaPutLayoutItem] | Unset_Type - The section_items of this GsaUpdateLayoutSection. - """ - # Field is not nullable - if section_items is None: - raise ValueError("Invalid value for 'section_items', must not be 'None'") - self._section_items = section_items - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdateLayoutSection. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdateLayoutSection. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdateLayoutSection. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdateLayoutSection. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdateLayoutSection. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdateLayoutSection. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdateLayoutSection. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdateLayoutSection. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateLayoutSection): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_logical_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_logical_attribute.py index 36848475..9cc8fab4 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_logical_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_logical_attribute.py @@ -68,8 +68,8 @@ class GsaUpdateLogicalAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -79,8 +79,8 @@ class GsaUpdateLogicalAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -96,8 +96,8 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.LOGICAL, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -109,8 +109,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -119,8 +119,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_long_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_long_text_attribute.py index eb74837b..2548f0b4 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_long_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_long_text_attribute.py @@ -68,8 +68,8 @@ class GsaUpdateLongTextAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -79,8 +79,8 @@ class GsaUpdateLongTextAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -96,8 +96,8 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.LONGTEXT, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -109,8 +109,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -119,8 +119,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_maths_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_maths_functional_attribute.py index 412f56f7..a4c92c30 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_maths_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_maths_functional_attribute.py @@ -75,7 +75,6 @@ class GsaUpdateMathsFunctionalAttribute(GsaUpdateAttribute): "axis_name": "GsaUpdateAxisName", "default_content": "GsaUpdateMathsContent", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "expressions": "list[GsaSlimEntity]", "guid": "str", "help_path": "str", @@ -95,7 +94,6 @@ class GsaUpdateMathsFunctionalAttribute(GsaUpdateAttribute): "axis_name": "axisName", "default_content": "defaultContent", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "expressions": "expressions", "guid": "guid", "help_path": "helpPath", @@ -110,7 +108,6 @@ class GsaUpdateMathsFunctionalAttribute(GsaUpdateAttribute): "attributeParameters": "GsaSlimEntity", "expressions": "GsaSlimEntity", "defaultContent": "GsaUpdateMathsContent", - "axisName": "GsaUpdateAxisName", } discriminator: Optional[str] = None @@ -127,7 +124,6 @@ def __init__( axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_content: "GsaUpdateMathsContent | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, expressions: "list[GsaSlimEntity] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, @@ -149,7 +145,6 @@ def __init__( axis_name: GsaUpdateAxisName, optional default_content: GsaUpdateMathsContent, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional expressions: list[GsaSlimEntity] | None, optional guid: str, optional help_path: str | None, optional @@ -161,8 +156,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, @@ -176,7 +171,6 @@ def __init__( self._default_content: GsaUpdateMathsContent | Unset_Type = Unset self._allow_all_compatible_expressions: bool | Unset_Type = Unset self._allow_anonymous_expressions: bool | Unset_Type = Unset - self._axis_name: GsaUpdateAxisName | Unset_Type = Unset if unit is not Unset: self.unit = unit @@ -194,8 +188,6 @@ def __init__( self.allow_all_compatible_expressions = allow_all_compatible_expressions if allow_anonymous_expressions is not Unset: self.allow_anonymous_expressions = allow_anonymous_expressions - if axis_name is not Unset: - self.axis_name = axis_name @property def unit(self) -> "GsaSlimEntity | Unset_Type": @@ -397,31 +389,6 @@ def allow_anonymous_expressions(self, allow_anonymous_expressions: "bool | Unset raise ValueError("Invalid value for 'allow_anonymous_expressions', must not be 'None'") self._allow_anonymous_expressions = allow_anonymous_expressions - @property - def axis_name(self) -> "GsaUpdateAxisName | Unset_Type": - """Gets the axis_name of this GsaUpdateMathsFunctionalAttribute. - - Returns - ------- - GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateMathsFunctionalAttribute. - """ - return self._axis_name - - @axis_name.setter - def axis_name(self, axis_name: "GsaUpdateAxisName | Unset_Type") -> None: - """Sets the axis_name of this GsaUpdateMathsFunctionalAttribute. - - Parameters - ---------- - axis_name: GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateMathsFunctionalAttribute. - """ - # Field is not nullable - if axis_name is None: - raise ValueError("Invalid value for 'axis_name', must not be 'None'") - self._axis_name = axis_name - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_numeric_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_numeric_parameter.py index 18a421a0..6968a19c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_numeric_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_numeric_parameter.py @@ -68,30 +68,27 @@ class GsaUpdateNumericParameter(GsaUpdateParameter): swagger_types: dict[str, str] = { "type": "GsaParameterType", "default_parameter_value_guid": "str", - "default_parameter_value_index": "int", "guid": "str", + "help_path": "str", "interpolation_type": "GsaParameterInterpolationType", "name": "str", "scale_type": "GsaParameterScaleType", "unit": "GsaSlimEntity", - "values": "list[GsaUpdateNumericParameterValue]", } attribute_map: dict[str, str] = { "type": "type", "default_parameter_value_guid": "defaultParameterValueGuid", - "default_parameter_value_index": "defaultParameterValueIndex", "guid": "guid", + "help_path": "helpPath", "interpolation_type": "interpolationType", "name": "name", "scale_type": "scaleType", "unit": "unit", - "values": "values", } subtype_mapping: dict[str, str] = { "unit": "GsaSlimEntity", - "values": "GsaUpdateNumericParameterValue", "interpolationType": "GsaParameterInterpolationType", "scaleType": "GsaParameterScaleType", } @@ -103,13 +100,12 @@ def __init__( *, type: "GsaParameterType" = GsaParameterType.NUMERIC, default_parameter_value_guid: "str | Unset_Type" = Unset, - default_parameter_value_index: "int | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, interpolation_type: "GsaParameterInterpolationType | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, scale_type: "GsaParameterScaleType | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, - values: "list[GsaUpdateNumericParameterValue] | Unset_Type" = Unset, ) -> None: """GsaUpdateNumericParameter - a model defined in Swagger @@ -117,30 +113,26 @@ def __init__( ---------- type: GsaParameterType default_parameter_value_guid: str, optional - default_parameter_value_index: int, optional guid: str, optional + help_path: str | None, optional interpolation_type: GsaParameterInterpolationType, optional name: str, optional scale_type: GsaParameterScaleType, optional unit: GsaSlimEntity, optional - values: list[GsaUpdateNumericParameterValue], optional """ super().__init__( type=type, default_parameter_value_guid=default_parameter_value_guid, - default_parameter_value_index=default_parameter_value_index, guid=guid, + help_path=help_path, name=name, ) self._unit: GsaSlimEntity | Unset_Type = Unset - self._values: list[GsaUpdateNumericParameterValue] | Unset_Type = Unset self._interpolation_type: GsaParameterInterpolationType | Unset_Type = Unset self._scale_type: GsaParameterScaleType | Unset_Type = Unset if unit is not Unset: self.unit = unit - if values is not Unset: - self.values = values if interpolation_type is not Unset: self.interpolation_type = interpolation_type if scale_type is not Unset: @@ -171,33 +163,6 @@ def unit(self, unit: "GsaSlimEntity | Unset_Type") -> None: raise ValueError("Invalid value for 'unit', must not be 'None'") self._unit = unit - @property - def values(self) -> "list[GsaUpdateNumericParameterValue] | Unset_Type": - """Gets the values of this GsaUpdateNumericParameter. - Update the set of parameter values. This can result in adding, modifying and deleting parameter values. Numeric parameter values can not be reordered - they are ordered by numeric value. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a value. - - Returns - ------- - list[GsaUpdateNumericParameterValue] | Unset_Type - The values of this GsaUpdateNumericParameter. - """ - return self._values - - @values.setter - def values(self, values: "list[GsaUpdateNumericParameterValue] | Unset_Type") -> None: - """Sets the values of this GsaUpdateNumericParameter. - Update the set of parameter values. This can result in adding, modifying and deleting parameter values. Numeric parameter values can not be reordered - they are ordered by numeric value. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a value. - - Parameters - ---------- - values: list[GsaUpdateNumericParameterValue] | Unset_Type - The values of this GsaUpdateNumericParameter. - """ - # Field is not nullable - if values is None: - raise ValueError("Invalid value for 'values', must not be 'None'") - self._values = values - @property def interpolation_type(self) -> "GsaParameterInterpolationType | Unset_Type": """Gets the interpolation_type of this GsaUpdateNumericParameter. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_parameter.py index 3916aa87..b5562929 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_parameter.py @@ -65,16 +65,16 @@ class GsaUpdateParameter(ModelBase): swagger_types: dict[str, str] = { "type": "GsaParameterType", "default_parameter_value_guid": "str", - "default_parameter_value_index": "int", "guid": "str", + "help_path": "str", "name": "str", } attribute_map: dict[str, str] = { "type": "type", "default_parameter_value_guid": "defaultParameterValueGuid", - "default_parameter_value_index": "defaultParameterValueIndex", "guid": "guid", + "help_path": "helpPath", "name": "name", } @@ -94,8 +94,8 @@ def __init__( *, type: "GsaParameterType", default_parameter_value_guid: "str | Unset_Type" = Unset, - default_parameter_value_index: "int | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, ) -> None: """GsaUpdateParameter - a model defined in Swagger @@ -104,21 +104,21 @@ def __init__( ---------- type: GsaParameterType default_parameter_value_guid: str, optional - default_parameter_value_index: int, optional guid: str, optional + help_path: str | None, optional name: str, optional """ self._type: GsaParameterType + self._help_path: str | None | Unset_Type = Unset self._default_parameter_value_guid: str | Unset_Type = Unset - self._default_parameter_value_index: int | Unset_Type = Unset self._name: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset self.type = type + if help_path is not Unset: + self.help_path = help_path if default_parameter_value_guid is not Unset: self.default_parameter_value_guid = default_parameter_value_guid - if default_parameter_value_index is not Unset: - self.default_parameter_value_index = default_parameter_value_index if name is not Unset: self.name = name if guid is not Unset: @@ -152,10 +152,31 @@ def type(self, type: "GsaParameterType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def help_path(self) -> "str | None | Unset_Type": + """Gets the help_path of this GsaUpdateParameter. + + Returns + ------- + str | None | Unset_Type + The help_path of this GsaUpdateParameter. + """ + return self._help_path + + @help_path.setter + def help_path(self, help_path: "str | None | Unset_Type") -> None: + """Sets the help_path of this GsaUpdateParameter. + + Parameters + ---------- + help_path: str | None | Unset_Type + The help_path of this GsaUpdateParameter. + """ + self._help_path = help_path + @property def default_parameter_value_guid(self) -> "str | Unset_Type": """Gets the default_parameter_value_guid of this GsaUpdateParameter. - Use to set the default value when the parameter value GUID is known. Returns ------- @@ -169,7 +190,6 @@ def default_parameter_value_guid( self, default_parameter_value_guid: "str | Unset_Type" ) -> None: """Sets the default_parameter_value_guid of this GsaUpdateParameter. - Use to set the default value when the parameter value GUID is known. Parameters ---------- @@ -181,37 +201,6 @@ def default_parameter_value_guid( raise ValueError("Invalid value for 'default_parameter_value_guid', must not be 'None'") self._default_parameter_value_guid = default_parameter_value_guid - @property - def default_parameter_value_index(self) -> "int | Unset_Type": - """Gets the default_parameter_value_index of this GsaUpdateParameter. - Use to set the default value when also updating parameter values, if the parameter value GUID is not known. For example when creating a new parameter value. - - Returns - ------- - int | Unset_Type - The default_parameter_value_index of this GsaUpdateParameter. - """ - return self._default_parameter_value_index - - @default_parameter_value_index.setter - def default_parameter_value_index( - self, default_parameter_value_index: "int | Unset_Type" - ) -> None: - """Sets the default_parameter_value_index of this GsaUpdateParameter. - Use to set the default value when also updating parameter values, if the parameter value GUID is not known. For example when creating a new parameter value. - - Parameters - ---------- - default_parameter_value_index: int | Unset_Type - The default_parameter_value_index of this GsaUpdateParameter. - """ - # Field is not nullable - if default_parameter_value_index is None: - raise ValueError( - "Invalid value for 'default_parameter_value_index', must not be 'None'" - ) - self._default_parameter_value_index = default_parameter_value_index - @property def name(self) -> "str | Unset_Type": """Gets the name of this GsaUpdateParameter. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission.py deleted file mode 100644 index 5653921d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission.py +++ /dev/null @@ -1,300 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermission(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "description": "str", - "guid": "str", - "name": "str", - "role": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "description": "description", - "guid": "guid", - "name": "name", - "role": "role", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - description: "str | None | Unset_Type" = Unset, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - role: "str | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePermission - a model defined in Swagger - - Parameters - ---------- - description: str | None, optional - guid: str, optional - name: str, optional - role: str, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - self._role: str | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if role is not Unset: - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def role(self) -> "str | Unset_Type": - """Gets the role of this GsaUpdatePermission. - - Returns - ------- - str | Unset_Type - The role of this GsaUpdatePermission. - """ - return self._role - - @role.setter - def role(self, role: "str | Unset_Type") -> None: - """Sets the role of this GsaUpdatePermission. - - Parameters - ---------- - role: str | Unset_Type - The role of this GsaUpdatePermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaUpdatePermission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaUpdatePermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaUpdatePermission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaUpdatePermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaUpdatePermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaUpdatePermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaUpdatePermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaUpdatePermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaUpdatePermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaUpdatePermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaUpdatePermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaUpdatePermission. - """ - self._unset_message = unset_message - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePermission. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePermission. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePermission. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdatePermission. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdatePermission. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdatePermission. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdatePermission. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_access_control.py deleted file mode 100644 index 88017b89..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_access_control.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "permission": "GsaSlimEntity", - "can_read": "bool", - "can_write": "bool", - } - - attribute_map: dict[str, str] = { - "permission": "permission", - "can_read": "canRead", - "can_write": "canWrite", - } - - subtype_mapping: dict[str, str] = { - "permission": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - permission: "GsaSlimEntity", - can_read: "bool | Unset_Type" = Unset, - can_write: "bool | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePermissionAccessControl - a model defined in Swagger - - Parameters - ---------- - permission: GsaSlimEntity - can_read: bool, optional - can_write: bool, optional - """ - self._permission: GsaSlimEntity - self._can_read: bool | Unset_Type = Unset - self._can_write: bool | Unset_Type = Unset - - self.permission = permission - if can_read is not Unset: - self.can_read = can_read - if can_write is not Unset: - self.can_write = can_write - - @property - def permission(self) -> "GsaSlimEntity": - """Gets the permission of this GsaUpdatePermissionAccessControl. - - Returns - ------- - GsaSlimEntity - The permission of this GsaUpdatePermissionAccessControl. - """ - return self._permission - - @permission.setter - def permission(self, permission: "GsaSlimEntity") -> None: - """Sets the permission of this GsaUpdatePermissionAccessControl. - - Parameters - ---------- - permission: GsaSlimEntity - The permission of this GsaUpdatePermissionAccessControl. - """ - # Field is not nullable - if permission is None: - raise ValueError("Invalid value for 'permission', must not be 'None'") - # Field is required - if permission is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission', must not be 'Unset'") - self._permission = permission - - @property - def can_read(self) -> "bool | Unset_Type": - """Gets the can_read of this GsaUpdatePermissionAccessControl. - - Returns - ------- - bool | Unset_Type - The can_read of this GsaUpdatePermissionAccessControl. - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read: "bool | Unset_Type") -> None: - """Sets the can_read of this GsaUpdatePermissionAccessControl. - - Parameters - ---------- - can_read: bool | Unset_Type - The can_read of this GsaUpdatePermissionAccessControl. - """ - # Field is not nullable - if can_read is None: - raise ValueError("Invalid value for 'can_read', must not be 'None'") - self._can_read = can_read - - @property - def can_write(self) -> "bool | Unset_Type": - """Gets the can_write of this GsaUpdatePermissionAccessControl. - - Returns - ------- - bool | Unset_Type - The can_write of this GsaUpdatePermissionAccessControl. - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write: "bool | Unset_Type") -> None: - """Sets the can_write of this GsaUpdatePermissionAccessControl. - - Parameters - ---------- - can_write: bool | Unset_Type - The can_write of this GsaUpdatePermissionAccessControl. - """ - # Field is not nullable - if can_write is None: - raise ValueError("Invalid value for 'can_write', must not be 'None'") - self._can_write = can_write - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_based_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_based_access_control.py deleted file mode 100644 index 8de361da..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_based_access_control.py +++ /dev/null @@ -1,124 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_update_access_control import ( # noqa: F401 - GsaUpdateAccessControl, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionBasedAccessControl(GsaUpdateAccessControl): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode" = GsaAccessControlMode.PERMISSIONBASED, - ) -> None: - """GsaUpdatePermissionBasedAccessControl - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - super().__init__(mode=mode) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionBasedAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category.py deleted file mode 100644 index b3f404c3..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "permissions": "list[GsaPutPermission]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "permissions": "permissions", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaPutPermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - permissions: "list[GsaPutPermission] | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePermissionCategory - a model defined in Swagger - - Parameters - ---------- - guid: str, optional - name: str, optional - permissions: list[GsaPutPermission], optional - """ - self._permissions: list[GsaPutPermission] | Unset_Type = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if permissions is not Unset: - self.permissions = permissions - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def permissions(self) -> "list[GsaPutPermission] | Unset_Type": - """Gets the permissions of this GsaUpdatePermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Returns - ------- - list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaPutPermission] | Unset_Type") -> None: - """Sets the permissions of this GsaUpdatePermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Parameters - ---------- - permissions: list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - self._permissions = permissions - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePermissionCategory. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePermissionCategory. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdatePermissionCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdatePermissionCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdatePermissionCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdatePermissionCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control.py deleted file mode 100644 index c82017ac..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionCategoryAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category": "GsaSlimEntity", - "permission_access_controls": "list[GsaUpdatePermissionAccessControl]", - } - - attribute_map: dict[str, str] = { - "category": "category", - "permission_access_controls": "permissionAccessControls", - } - - subtype_mapping: dict[str, str] = { - "category": "GsaSlimEntity", - "permissionAccessControls": "GsaUpdatePermissionAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category: "GsaSlimEntity", - permission_access_controls: "list[GsaUpdatePermissionAccessControl]", - ) -> None: - """GsaUpdatePermissionCategoryAccessControl - a model defined in Swagger - - Parameters - ---------- - category: GsaSlimEntity - permission_access_controls: list[GsaUpdatePermissionAccessControl] - """ - self._category: GsaSlimEntity - self._permission_access_controls: list[GsaUpdatePermissionAccessControl] - - self.category = category - self.permission_access_controls = permission_access_controls - - @property - def category(self) -> "GsaSlimEntity": - """Gets the category of this GsaUpdatePermissionCategoryAccessControl. - - Returns - ------- - GsaSlimEntity - The category of this GsaUpdatePermissionCategoryAccessControl. - """ - return self._category - - @category.setter - def category(self, category: "GsaSlimEntity") -> None: - """Sets the category of this GsaUpdatePermissionCategoryAccessControl. - - Parameters - ---------- - category: GsaSlimEntity - The category of this GsaUpdatePermissionCategoryAccessControl. - """ - # Field is not nullable - if category is None: - raise ValueError("Invalid value for 'category', must not be 'None'") - # Field is required - if category is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category', must not be 'Unset'") - self._category = category - - @property - def permission_access_controls(self) -> "list[GsaUpdatePermissionAccessControl]": - """Gets the permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - - Returns - ------- - list[GsaUpdatePermissionAccessControl] - The permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - """ - return self._permission_access_controls - - @permission_access_controls.setter - def permission_access_controls( - self, permission_access_controls: "list[GsaUpdatePermissionAccessControl]" - ) -> None: - """Sets the permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - - Parameters - ---------- - permission_access_controls: list[GsaUpdatePermissionAccessControl] - The permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - """ - # Field is not nullable - if permission_access_controls is None: - raise ValueError("Invalid value for 'permission_access_controls', must not be 'None'") - # Field is required - if permission_access_controls is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_access_controls', must not be 'Unset'") - self._permission_access_controls = permission_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionCategoryAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control_request.py deleted file mode 100644 index 18cdc465..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_control_request.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionCategoryAccessControlRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_access_controls": "list[GsaUpdatePermissionCategoryAccessControl]", - } - - attribute_map: dict[str, str] = { - "category_access_controls": "categoryAccessControls", - } - - subtype_mapping: dict[str, str] = { - "categoryAccessControls": "GsaUpdatePermissionCategoryAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_access_controls: "list[GsaUpdatePermissionCategoryAccessControl]", - ) -> None: - """GsaUpdatePermissionCategoryAccessControlRequest - a model defined in Swagger - - Parameters - ---------- - category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - """ - self._category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - - self.category_access_controls = category_access_controls - - @property - def category_access_controls(self) -> "list[GsaUpdatePermissionCategoryAccessControl]": - """Gets the category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - - Returns - ------- - list[GsaUpdatePermissionCategoryAccessControl] - The category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - """ - return self._category_access_controls - - @category_access_controls.setter - def category_access_controls( - self, category_access_controls: "list[GsaUpdatePermissionCategoryAccessControl]" - ) -> None: - """Sets the category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - - Parameters - ---------- - category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - The category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - """ - # Field is not nullable - if category_access_controls is None: - raise ValueError("Invalid value for 'category_access_controls', must not be 'None'") - # Field is required - if category_access_controls is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_access_controls', must not be 'Unset'") - self._category_access_controls = category_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionCategoryAccessControlRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_controls_operation_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_controls_operation_request.py deleted file mode 100644 index 02d34f1d..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_permission_category_access_controls_operation_request.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionCategoryAccessControlsOperationRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_access_controls": "list[GsaUpdatePermissionCategoryAccessControl]", - "entities": "list[GsaAccessControlEntity]", - } - - attribute_map: dict[str, str] = { - "category_access_controls": "categoryAccessControls", - "entities": "entities", - } - - subtype_mapping: dict[str, str] = { - "categoryAccessControls": "GsaUpdatePermissionCategoryAccessControl", - "entities": "GsaAccessControlEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_access_controls: "list[GsaUpdatePermissionCategoryAccessControl]", - entities: "list[GsaAccessControlEntity]", - ) -> None: - """GsaUpdatePermissionCategoryAccessControlsOperationRequest - a model defined in Swagger - - Parameters - ---------- - category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - entities: list[GsaAccessControlEntity] - """ - self._category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - self._entities: list[GsaAccessControlEntity] - - self.category_access_controls = category_access_controls - self.entities = entities - - @property - def category_access_controls(self) -> "list[GsaUpdatePermissionCategoryAccessControl]": - """Gets the category_access_controls of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - - Returns - ------- - list[GsaUpdatePermissionCategoryAccessControl] - The category_access_controls of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - """ - return self._category_access_controls - - @category_access_controls.setter - def category_access_controls( - self, category_access_controls: "list[GsaUpdatePermissionCategoryAccessControl]" - ) -> None: - """Sets the category_access_controls of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - - Parameters - ---------- - category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - The category_access_controls of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - """ - # Field is not nullable - if category_access_controls is None: - raise ValueError("Invalid value for 'category_access_controls', must not be 'None'") - # Field is required - if category_access_controls is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_access_controls', must not be 'Unset'") - self._category_access_controls = category_access_controls - - @property - def entities(self) -> "list[GsaAccessControlEntity]": - """Gets the entities of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - - Returns - ------- - list[GsaAccessControlEntity] - The entities of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - """ - return self._entities - - @entities.setter - def entities(self, entities: "list[GsaAccessControlEntity]") -> None: - """Sets the entities of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - - Parameters - ---------- - entities: list[GsaAccessControlEntity] - The entities of this GsaUpdatePermissionCategoryAccessControlsOperationRequest. - """ - # Field is not nullable - if entities is None: - raise ValueError("Invalid value for 'entities', must not be 'None'") - # Field is required - if entities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entities', must not be 'Unset'") - self._entities = entities - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionCategoryAccessControlsOperationRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_picture_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_picture_attribute.py index 67ad9989..9ed830b3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_picture_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_picture_attribute.py @@ -68,8 +68,8 @@ class GsaUpdatePictureAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -79,8 +79,8 @@ class GsaUpdatePictureAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -96,8 +96,8 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.PICTURE, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -109,8 +109,8 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -119,8 +119,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_point_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_point_attribute.py index 6815d0c9..90db161c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_point_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_point_attribute.py @@ -71,7 +71,6 @@ class GsaUpdatePointAttribute(GsaUpdateAttribute): "attribute_parameters": "list[GsaSlimEntity]", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -86,7 +85,6 @@ class GsaUpdatePointAttribute(GsaUpdateAttribute): "attribute_parameters": "attributeParameters", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -98,7 +96,6 @@ class GsaUpdatePointAttribute(GsaUpdateAttribute): subtype_mapping: dict[str, str] = { "unit": "GsaSlimEntity", "attributeParameters": "GsaSlimEntity", - "axisName": "GsaUpdateAxisName", } discriminator: Optional[str] = None @@ -111,7 +108,6 @@ def __init__( attribute_parameters: "list[GsaSlimEntity] | None | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -128,7 +124,6 @@ def __init__( attribute_parameters: list[GsaSlimEntity] | None, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -139,8 +134,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, @@ -149,7 +144,6 @@ def __init__( self._unit: GsaSlimEntity | Unset_Type = Unset self._is_multi_valued: bool | Unset_Type = Unset self._attribute_parameters: list[GsaSlimEntity] | None | Unset_Type = Unset - self._axis_name: GsaUpdateAxisName | Unset_Type = Unset if unit is not Unset: self.unit = unit @@ -157,8 +151,6 @@ def __init__( self.is_multi_valued = is_multi_valued if attribute_parameters is not Unset: self.attribute_parameters = attribute_parameters - if axis_name is not Unset: - self.axis_name = axis_name @property def unit(self) -> "GsaSlimEntity | Unset_Type": @@ -234,31 +226,6 @@ def attribute_parameters( """ self._attribute_parameters = attribute_parameters - @property - def axis_name(self) -> "GsaUpdateAxisName | Unset_Type": - """Gets the axis_name of this GsaUpdatePointAttribute. - - Returns - ------- - GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdatePointAttribute. - """ - return self._axis_name - - @axis_name.setter - def axis_name(self, axis_name: "GsaUpdateAxisName | Unset_Type") -> None: - """Sets the axis_name of this GsaUpdatePointAttribute. - - Parameters - ---------- - axis_name: GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdatePointAttribute. - """ - # Field is not nullable - if axis_name is None: - raise ValueError("Invalid value for 'axis_name', must not be 'None'") - self._axis_name = axis_name - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_layout_item.py deleted file mode 100644 index 7760542e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_layout_item.py +++ /dev/null @@ -1,157 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_layout_item import ( # noqa: F401 - GsaPutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePutLayoutItem(GsaPutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "type": "type", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - type: "GsaPutType" = GsaPutType.UPDATE, - ) -> None: - """GsaUpdatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - guid: str - type: GsaPutType - """ - super().__init__(type=type) - self._guid: str - - self.guid = guid - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUpdatePutLayoutItem. - - Returns - ------- - str - The guid of this GsaUpdatePutLayoutItem. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUpdatePutLayoutItem. - - Parameters - ---------- - guid: str - The guid of this GsaUpdatePutLayoutItem. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission.py deleted file mode 100644 index e46d31d6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission.py +++ /dev/null @@ -1,314 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_permission import ( # noqa: F401 - GsaPutPermission, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePutPermission(GsaPutPermission): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "type": "GsaPutType", - "description": "str", - "name": "str", - "role": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "type": "type", - "description": "description", - "name": "name", - "role": "role", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - type: "GsaPutType" = GsaPutType.UPDATE, - description: "str | None | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - role: "str | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePutPermission - a model defined in Swagger - - Parameters - ---------- - guid: str - type: GsaPutType - description: str | None, optional - name: str, optional - role: str, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - super().__init__(type=type) - self._guid: str - self._name: str | Unset_Type = Unset - self._role: str | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - - self.guid = guid - if name is not Unset: - self.name = name - if role is not Unset: - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUpdatePutPermission. - - Returns - ------- - str - The guid of this GsaUpdatePutPermission. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUpdatePutPermission. - - Parameters - ---------- - guid: str - The guid of this GsaUpdatePutPermission. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePutPermission. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePutPermission. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePutPermission. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePutPermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def role(self) -> "str | Unset_Type": - """Gets the role of this GsaUpdatePutPermission. - - Returns - ------- - str | Unset_Type - The role of this GsaUpdatePutPermission. - """ - return self._role - - @role.setter - def role(self, role: "str | Unset_Type") -> None: - """Sets the role of this GsaUpdatePutPermission. - - Parameters - ---------- - role: str | Unset_Type - The role of this GsaUpdatePutPermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaUpdatePutPermission. - The description of the permission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaUpdatePutPermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaUpdatePutPermission. - The description of the permission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaUpdatePutPermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaUpdatePutPermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaUpdatePutPermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaUpdatePutPermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaUpdatePutPermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaUpdatePutPermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaUpdatePutPermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaUpdatePutPermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaUpdatePutPermission. - """ - self._unset_message = unset_message - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePutPermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission_category.py deleted file mode 100644 index a3073862..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_put_permission_category.py +++ /dev/null @@ -1,225 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_permission_category import ( # noqa: F401 - GsaPutPermissionCategory, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePutPermissionCategory(GsaPutPermissionCategory): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "type": "GsaPutType", - "name": "str", - "permissions": "list[GsaPutPermission]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "type": "type", - "name": "name", - "permissions": "permissions", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaPutPermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - type: "GsaPutType" = GsaPutType.UPDATE, - name: "str | Unset_Type" = Unset, - permissions: "list[GsaPutPermission] | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePutPermissionCategory - a model defined in Swagger - - Parameters - ---------- - guid: str - type: GsaPutType - name: str, optional - permissions: list[GsaPutPermission], optional - """ - super().__init__(type=type) - self._guid: str - self._name: str | Unset_Type = Unset - self._permissions: list[GsaPutPermission] | Unset_Type = Unset - - self.guid = guid - if name is not Unset: - self.name = name - if permissions is not Unset: - self.permissions = permissions - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUpdatePutPermissionCategory. - - Returns - ------- - str - The guid of this GsaUpdatePutPermissionCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUpdatePutPermissionCategory. - - Parameters - ---------- - guid: str - The guid of this GsaUpdatePutPermissionCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePutPermissionCategory. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePutPermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePutPermissionCategory. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePutPermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def permissions(self) -> "list[GsaPutPermission] | Unset_Type": - """Gets the permissions of this GsaUpdatePutPermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Returns - ------- - list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePutPermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaPutPermission] | Unset_Type") -> None: - """Sets the permissions of this GsaUpdatePutPermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Parameters - ---------- - permissions: list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePutPermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - self._permissions = permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePutPermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_range_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_range_attribute.py index 42e4221f..0670b69d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_range_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_range_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateRangeAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -83,7 +82,6 @@ class GsaUpdateRangeAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -93,7 +91,6 @@ class GsaUpdateRangeAttribute(GsaUpdateAttribute): subtype_mapping: dict[str, str] = { "unit": "GsaSlimEntity", - "axisName": "GsaUpdateAxisName", } discriminator: Optional[str] = None @@ -105,7 +102,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -120,7 +116,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -130,20 +125,17 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, name=name, ) self._unit: GsaSlimEntity | Unset_Type = Unset - self._axis_name: GsaUpdateAxisName | Unset_Type = Unset if unit is not Unset: self.unit = unit - if axis_name is not Unset: - self.axis_name = axis_name @property def unit(self) -> "GsaSlimEntity | Unset_Type": @@ -170,31 +162,6 @@ def unit(self, unit: "GsaSlimEntity | Unset_Type") -> None: raise ValueError("Invalid value for 'unit', must not be 'None'") self._unit = unit - @property - def axis_name(self) -> "GsaUpdateAxisName | Unset_Type": - """Gets the axis_name of this GsaUpdateRangeAttribute. - - Returns - ------- - GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateRangeAttribute. - """ - return self._axis_name - - @axis_name.setter - def axis_name(self, axis_name: "GsaUpdateAxisName | Unset_Type") -> None: - """Sets the axis_name of this GsaUpdateRangeAttribute. - - Parameters - ---------- - axis_name: GsaUpdateAxisName | Unset_Type - The axis_name of this GsaUpdateRangeAttribute. - """ - # Field is not nullable - if axis_name is None: - raise ValueError("Invalid value for 'axis_name', must not be 'None'") - self._axis_name = axis_name - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_record_link_group.py index 623002e4..9965a279 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_record_link_group.py @@ -82,7 +82,7 @@ class GsaUpdateRecordLinkGroup(ModelBase): discriminator_value_class_map = { "static".lower(): "#/components/schemas/GsaUpdateStaticRecordLinkGroup", - "smart".lower(): "#/components/schemas/GsaUpdateSmartRecordLinkGroup", + "dynamic".lower(): "#/components/schemas/GsaUpdateDynamicRecordLinkGroup", "crossDatabase".lower(): "#/components/schemas/GsaUpdateCrossDatabaseRecordLinkGroup", } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_root_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_root_folder_error_detail.py deleted file mode 100644 index 99f952b9..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_root_folder_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_error_detail import ( # noqa: F401 - GsaFolderErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_folder_error_reason import ( - GsaFolderErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateRootFolderErrorDetail(GsaFolderErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason" = GsaFolderErrorReason.UPDATEROOT, - ) -> None: - """GsaUpdateRootFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateRootFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_run_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_run_status.py deleted file mode 100644 index 5b462252..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_run_status.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUpdateRunStatus(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - REGISTERED = "Registered" - UPLOADINPROGRESS = "UploadInProgress" - UPLOADED = "Uploaded" - UPLOADFAILED = "UploadFailed" - DRYRUNPENDING = "DryRunPending" - DRYRUNCANCELLING = "DryRunCancelling" - DRYRUNCANCELLED = "DryRunCancelled" - DRYRUNINPROGRESS = "DryRunInProgress" - DRYRUNCOMPLETE = "DryRunComplete" - DRYRUNFAILED = "DryRunFailed" - APPLYPENDING = "ApplyPending" - APPLYINPROGRESS = "ApplyInProgress" - APPLYCANCELLING = "ApplyCancelling" - APPLYCANCELLED = "ApplyCancelled" - APPLYCOMPLETE = "ApplyComplete" - APPLYFAILED = "ApplyFailed" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_short_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_short_text_attribute.py index a3a90fc8..cedaf4d4 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_short_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_short_text_attribute.py @@ -68,9 +68,9 @@ class GsaUpdateShortTextAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "data_rule": "GsaSlimEntity", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -81,9 +81,9 @@ class GsaUpdateShortTextAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "data_rule": "dataRule", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -102,9 +102,9 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.SHORTTEXT, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, data_rule: "GsaSlimEntity | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -117,9 +117,9 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional data_rule: GsaSlimEntity, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -129,8 +129,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_standard_name.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_standard_name.py index 541980b9..03ba7cb0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_standard_name.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_standard_name.py @@ -65,7 +65,7 @@ class GsaUpdateStandardName(ModelBase): "mapped_attributes": "list[GsaSlimEntity]", "mapped_cross_database_record_link_groups": "list[GsaSlimEntity]", "mapped_parameters": "list[GsaSlimEntity]", - "mapped_record_link_groups": "list[GsaUpdateStaticRecordLinkGroupMapping]", + "mapped_record_link_groups": "list[GsaSlimEntity]", "name": "str", } @@ -81,7 +81,7 @@ class GsaUpdateStandardName(ModelBase): subtype_mapping: dict[str, str] = { "mappedAttributes": "GsaSlimEntity", "mappedParameters": "GsaSlimEntity", - "mappedRecordLinkGroups": "GsaUpdateStaticRecordLinkGroupMapping", + "mappedRecordLinkGroups": "GsaSlimEntity", "mappedCrossDatabaseRecordLinkGroups": "GsaSlimEntity", } @@ -94,7 +94,7 @@ def __init__( mapped_attributes: "list[GsaSlimEntity] | None | Unset_Type" = Unset, mapped_cross_database_record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, mapped_parameters: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - mapped_record_link_groups: "list[GsaUpdateStaticRecordLinkGroupMapping] | None | Unset_Type" = Unset, + mapped_record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, ) -> None: """GsaUpdateStandardName - a model defined in Swagger @@ -105,14 +105,12 @@ def __init__( mapped_attributes: list[GsaSlimEntity] | None, optional mapped_cross_database_record_link_groups: list[GsaSlimEntity] | None, optional mapped_parameters: list[GsaSlimEntity] | None, optional - mapped_record_link_groups: list[GsaUpdateStaticRecordLinkGroupMapping] | None, optional + mapped_record_link_groups: list[GsaSlimEntity] | None, optional name: str, optional """ self._mapped_attributes: list[GsaSlimEntity] | None | Unset_Type = Unset self._mapped_parameters: list[GsaSlimEntity] | None | Unset_Type = Unset - self._mapped_record_link_groups: ( - list[GsaUpdateStaticRecordLinkGroupMapping] | None | Unset_Type - ) = Unset + self._mapped_record_link_groups: list[GsaSlimEntity] | None | Unset_Type = Unset self._mapped_cross_database_record_link_groups: list[GsaSlimEntity] | None | Unset_Type = ( Unset ) @@ -181,28 +179,25 @@ def mapped_parameters( self._mapped_parameters = mapped_parameters @property - def mapped_record_link_groups( - self, - ) -> "list[GsaUpdateStaticRecordLinkGroupMapping] | None | Unset_Type": + def mapped_record_link_groups(self) -> "list[GsaSlimEntity] | None | Unset_Type": """Gets the mapped_record_link_groups of this GsaUpdateStandardName. Returns ------- - list[GsaUpdateStaticRecordLinkGroupMapping] | None | Unset_Type + list[GsaSlimEntity] | None | Unset_Type The mapped_record_link_groups of this GsaUpdateStandardName. """ return self._mapped_record_link_groups @mapped_record_link_groups.setter def mapped_record_link_groups( - self, - mapped_record_link_groups: "list[GsaUpdateStaticRecordLinkGroupMapping] | None | Unset_Type", + self, mapped_record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" ) -> None: """Sets the mapped_record_link_groups of this GsaUpdateStandardName. Parameters ---------- - mapped_record_link_groups: list[GsaUpdateStaticRecordLinkGroupMapping] | None | Unset_Type + mapped_record_link_groups: list[GsaSlimEntity] | None | Unset_Type The mapped_record_link_groups of this GsaUpdateStandardName. """ self._mapped_record_link_groups = mapped_record_link_groups diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_static_record_link_group_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_static_record_link_group_mapping.py deleted file mode 100644 index b75e61df..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_static_record_link_group_mapping.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateStaticRecordLinkGroupMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "is_reverse": "bool", - "static_record_link_group": "GsaSlimEntity", - } - - attribute_map: dict[str, str] = { - "is_reverse": "isReverse", - "static_record_link_group": "staticRecordLinkGroup", - } - - subtype_mapping: dict[str, str] = { - "staticRecordLinkGroup": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - is_reverse: "bool", - static_record_link_group: "GsaSlimEntity", - ) -> None: - """GsaUpdateStaticRecordLinkGroupMapping - a model defined in Swagger - - Parameters - ---------- - is_reverse: bool - static_record_link_group: GsaSlimEntity - """ - self._static_record_link_group: GsaSlimEntity - self._is_reverse: bool - - self.static_record_link_group = static_record_link_group - self.is_reverse = is_reverse - - @property - def static_record_link_group(self) -> "GsaSlimEntity": - """Gets the static_record_link_group of this GsaUpdateStaticRecordLinkGroupMapping. - - Returns - ------- - GsaSlimEntity - The static_record_link_group of this GsaUpdateStaticRecordLinkGroupMapping. - """ - return self._static_record_link_group - - @static_record_link_group.setter - def static_record_link_group(self, static_record_link_group: "GsaSlimEntity") -> None: - """Sets the static_record_link_group of this GsaUpdateStaticRecordLinkGroupMapping. - - Parameters - ---------- - static_record_link_group: GsaSlimEntity - The static_record_link_group of this GsaUpdateStaticRecordLinkGroupMapping. - """ - # Field is not nullable - if static_record_link_group is None: - raise ValueError("Invalid value for 'static_record_link_group', must not be 'None'") - # Field is required - if static_record_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'static_record_link_group', must not be 'Unset'") - self._static_record_link_group = static_record_link_group - - @property - def is_reverse(self) -> "bool": - """Gets the is_reverse of this GsaUpdateStaticRecordLinkGroupMapping. - - Returns - ------- - bool - The is_reverse of this GsaUpdateStaticRecordLinkGroupMapping. - """ - return self._is_reverse - - @is_reverse.setter - def is_reverse(self, is_reverse: "bool") -> None: - """Sets the is_reverse of this GsaUpdateStaticRecordLinkGroupMapping. - - Parameters - ---------- - is_reverse: bool - The is_reverse of this GsaUpdateStaticRecordLinkGroupMapping. - """ - # Field is not nullable - if is_reverse is None: - raise ValueError("Invalid value for 'is_reverse', must not be 'None'") - # Field is required - if is_reverse is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_reverse', must not be 'Unset'") - self._is_reverse = is_reverse - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateStaticRecordLinkGroupMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_table.py index 356fd158..f6519023 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_table.py @@ -61,33 +61,21 @@ class GsaUpdateTable(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "datasheet_footer": "str", - "datasheet_header": "str", "default_layout_guid": "str", "default_subset_guid": "str", "guid": "str", "is_hidden_from_browse": "bool", "is_hidden_from_search": "bool", - "legal_disclaimer": "str", "name": "str", - "quality_system_guid": "str", - "should_show_version_control_signatures": "bool", - "table_types": "list[str]", } attribute_map: dict[str, str] = { - "datasheet_footer": "datasheetFooter", - "datasheet_header": "datasheetHeader", "default_layout_guid": "defaultLayoutGuid", "default_subset_guid": "defaultSubsetGuid", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", "is_hidden_from_search": "isHiddenFromSearch", - "legal_disclaimer": "legalDisclaimer", "name": "name", - "quality_system_guid": "qualitySystemGuid", - "should_show_version_control_signatures": "shouldShowVersionControlSignatures", - "table_types": "tableTypes", } subtype_mapping: dict[str, str] = {} @@ -97,46 +85,28 @@ class GsaUpdateTable(ModelBase): def __init__( self, *, - datasheet_footer: "str | None | Unset_Type" = Unset, - datasheet_header: "str | None | Unset_Type" = Unset, default_layout_guid: "str | None | Unset_Type" = Unset, default_subset_guid: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, is_hidden_from_browse: "bool | Unset_Type" = Unset, is_hidden_from_search: "bool | Unset_Type" = Unset, - legal_disclaimer: "str | None | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, - quality_system_guid: "str | None | Unset_Type" = Unset, - should_show_version_control_signatures: "bool | Unset_Type" = Unset, - table_types: "list[str] | None | Unset_Type" = Unset, ) -> None: """GsaUpdateTable - a model defined in Swagger Parameters ---------- - datasheet_footer: str | None, optional - datasheet_header: str | None, optional default_layout_guid: str | None, optional default_subset_guid: str | None, optional guid: str, optional is_hidden_from_browse: bool, optional is_hidden_from_search: bool, optional - legal_disclaimer: str | None, optional name: str, optional - quality_system_guid: str | None, optional - should_show_version_control_signatures: bool, optional - table_types: list[str] | None, optional """ self._is_hidden_from_browse: bool | Unset_Type = Unset self._is_hidden_from_search: bool | Unset_Type = Unset self._default_subset_guid: str | None | Unset_Type = Unset self._default_layout_guid: str | None | Unset_Type = Unset - self._quality_system_guid: str | None | Unset_Type = Unset - self._legal_disclaimer: str | None | Unset_Type = Unset - self._datasheet_header: str | None | Unset_Type = Unset - self._datasheet_footer: str | None | Unset_Type = Unset - self._table_types: list[str] | None | Unset_Type = Unset - self._should_show_version_control_signatures: bool | Unset_Type = Unset self._name: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset @@ -148,18 +118,6 @@ def __init__( self.default_subset_guid = default_subset_guid if default_layout_guid is not Unset: self.default_layout_guid = default_layout_guid - if quality_system_guid is not Unset: - self.quality_system_guid = quality_system_guid - if legal_disclaimer is not Unset: - self.legal_disclaimer = legal_disclaimer - if datasheet_header is not Unset: - self.datasheet_header = datasheet_header - if datasheet_footer is not Unset: - self.datasheet_footer = datasheet_footer - if table_types is not Unset: - self.table_types = table_types - if should_show_version_control_signatures is not Unset: - self.should_show_version_control_signatures = should_show_version_control_signatures if name is not Unset: self.name = name if guid is not Unset: @@ -259,147 +217,6 @@ def default_layout_guid(self, default_layout_guid: "str | None | Unset_Type") -> """ self._default_layout_guid = default_layout_guid - @property - def quality_system_guid(self) -> "str | None | Unset_Type": - """Gets the quality_system_guid of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The quality_system_guid of this GsaUpdateTable. - """ - return self._quality_system_guid - - @quality_system_guid.setter - def quality_system_guid(self, quality_system_guid: "str | None | Unset_Type") -> None: - """Sets the quality_system_guid of this GsaUpdateTable. - - Parameters - ---------- - quality_system_guid: str | None | Unset_Type - The quality_system_guid of this GsaUpdateTable. - """ - self._quality_system_guid = quality_system_guid - - @property - def legal_disclaimer(self) -> "str | None | Unset_Type": - """Gets the legal_disclaimer of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The legal_disclaimer of this GsaUpdateTable. - """ - return self._legal_disclaimer - - @legal_disclaimer.setter - def legal_disclaimer(self, legal_disclaimer: "str | None | Unset_Type") -> None: - """Sets the legal_disclaimer of this GsaUpdateTable. - - Parameters - ---------- - legal_disclaimer: str | None | Unset_Type - The legal_disclaimer of this GsaUpdateTable. - """ - self._legal_disclaimer = legal_disclaimer - - @property - def datasheet_header(self) -> "str | None | Unset_Type": - """Gets the datasheet_header of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_header of this GsaUpdateTable. - """ - return self._datasheet_header - - @datasheet_header.setter - def datasheet_header(self, datasheet_header: "str | None | Unset_Type") -> None: - """Sets the datasheet_header of this GsaUpdateTable. - - Parameters - ---------- - datasheet_header: str | None | Unset_Type - The datasheet_header of this GsaUpdateTable. - """ - self._datasheet_header = datasheet_header - - @property - def datasheet_footer(self) -> "str | None | Unset_Type": - """Gets the datasheet_footer of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_footer of this GsaUpdateTable. - """ - return self._datasheet_footer - - @datasheet_footer.setter - def datasheet_footer(self, datasheet_footer: "str | None | Unset_Type") -> None: - """Sets the datasheet_footer of this GsaUpdateTable. - - Parameters - ---------- - datasheet_footer: str | None | Unset_Type - The datasheet_footer of this GsaUpdateTable. - """ - self._datasheet_footer = datasheet_footer - - @property - def table_types(self) -> "list[str] | None | Unset_Type": - """Gets the table_types of this GsaUpdateTable. - If specified any existing table types are replaced. - - Returns - ------- - list[str] | None | Unset_Type - The table_types of this GsaUpdateTable. - """ - return self._table_types - - @table_types.setter - def table_types(self, table_types: "list[str] | None | Unset_Type") -> None: - """Sets the table_types of this GsaUpdateTable. - If specified any existing table types are replaced. - - Parameters - ---------- - table_types: list[str] | None | Unset_Type - The table_types of this GsaUpdateTable. - """ - self._table_types = table_types - - @property - def should_show_version_control_signatures(self) -> "bool | Unset_Type": - """Gets the should_show_version_control_signatures of this GsaUpdateTable. - - Returns - ------- - bool | Unset_Type - The should_show_version_control_signatures of this GsaUpdateTable. - """ - return self._should_show_version_control_signatures - - @should_show_version_control_signatures.setter - def should_show_version_control_signatures( - self, should_show_version_control_signatures: "bool | Unset_Type" - ) -> None: - """Sets the should_show_version_control_signatures of this GsaUpdateTable. - - Parameters - ---------- - should_show_version_control_signatures: bool | Unset_Type - The should_show_version_control_signatures of this GsaUpdateTable. - """ - # Field is not nullable - if should_show_version_control_signatures is None: - raise ValueError( - "Invalid value for 'should_show_version_control_signatures', must not be 'None'" - ) - self._should_show_version_control_signatures = should_show_version_control_signatures - @property def name(self) -> "str | Unset_Type": """Gets the name of this GsaUpdateTable. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_attribute.py index a4178acd..94dbd251 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_attribute.py @@ -68,9 +68,9 @@ class GsaUpdateTabularAttribute(GsaUpdateAttribute): swagger_types: dict[str, str] = { "type": "GsaAttributeType", "about_attribute": "GsaSlimEntity", + "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", "display_full_table": "bool", - "display_names": "dict(str, str)", "display_summary_row_inline": "bool", "guid": "str", "help_path": "str", @@ -84,9 +84,9 @@ class GsaUpdateTabularAttribute(GsaUpdateAttribute): attribute_map: dict[str, str] = { "type": "type", "about_attribute": "aboutAttribute", + "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", "display_full_table": "displayFullTable", - "display_names": "displayNames", "display_summary_row_inline": "displaySummaryRowInline", "guid": "guid", "help_path": "helpPath", @@ -109,9 +109,9 @@ def __init__( *, type: "GsaAttributeType" = GsaAttributeType.LINK, about_attribute: "GsaSlimEntity | Unset_Type" = Unset, + axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, display_full_table: "bool | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, display_summary_row_inline: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, @@ -127,9 +127,9 @@ def __init__( ---------- type: GsaAttributeType about_attribute: GsaSlimEntity, optional + axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional display_full_table: bool, optional - display_names: dict[str, str] | None, optional display_summary_row_inline: bool, optional guid: str, optional help_path: str | None, optional @@ -142,8 +142,8 @@ def __init__( super().__init__( type=type, about_attribute=about_attribute, + axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_property_not_provided_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_property_not_provided_attribute_error_detail.py deleted file mode 100644 index e50930b0..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_property_not_provided_attribute_error_detail.py +++ /dev/null @@ -1,192 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "column_type": "GsaTabularColumnDtoType", - "missing_property_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "column_type": "columnType", - "missing_property_name": "missingPropertyName", - } - - subtype_mapping: dict[str, str] = { - "columnType": "GsaTabularColumnDtoType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.UPDATETABULARCOLUMNPROPERTYNOTPROVIDED, - column_type: "GsaTabularColumnDtoType | Unset_Type" = Unset, - missing_property_name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - column_type: GsaTabularColumnDtoType, optional - missing_property_name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._missing_property_name: str | None | Unset_Type = Unset - self._column_type: GsaTabularColumnDtoType | Unset_Type = Unset - - if missing_property_name is not Unset: - self.missing_property_name = missing_property_name - if column_type is not Unset: - self.column_type = column_type - - @property - def missing_property_name(self) -> "str | None | Unset_Type": - """Gets the missing_property_name of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - - Returns - ------- - str | None | Unset_Type - The missing_property_name of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - """ - return self._missing_property_name - - @missing_property_name.setter - def missing_property_name(self, missing_property_name: "str | None | Unset_Type") -> None: - """Sets the missing_property_name of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - - Parameters - ---------- - missing_property_name: str | None | Unset_Type - The missing_property_name of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - """ - self._missing_property_name = missing_property_name - - @property - def column_type(self) -> "GsaTabularColumnDtoType | Unset_Type": - """Gets the column_type of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - - Returns - ------- - GsaTabularColumnDtoType | Unset_Type - The column_type of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - """ - return self._column_type - - @column_type.setter - def column_type(self, column_type: "GsaTabularColumnDtoType | Unset_Type") -> None: - """Sets the column_type of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - - Parameters - ---------- - column_type: GsaTabularColumnDtoType | Unset_Type - The column_type of this GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail. - """ - # Field is not nullable - if column_type is None: - raise ValueError("Invalid value for 'column_type', must not be 'None'") - self._column_type = column_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateTabularColumnPropertyNotProvidedAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_type_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_type_attribute_error_detail.py deleted file mode 100644 index e0043a7a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_update_tabular_column_type_attribute_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateTabularColumnTypeAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - "column_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "column_guid": "columnGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.UPDATETABULARCOLUMNTYPE, - column_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaUpdateTabularColumnTypeAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - column_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._column_guid: str | Unset_Type = Unset - - if column_guid is not Unset: - self.column_guid = column_guid - - @property - def column_guid(self) -> "str | Unset_Type": - """Gets the column_guid of this GsaUpdateTabularColumnTypeAttributeErrorDetail. - - Returns - ------- - str | Unset_Type - The column_guid of this GsaUpdateTabularColumnTypeAttributeErrorDetail. - """ - return self._column_guid - - @column_guid.setter - def column_guid(self, column_guid: "str | Unset_Type") -> None: - """Sets the column_guid of this GsaUpdateTabularColumnTypeAttributeErrorDetail. - - Parameters - ---------- - column_guid: str | Unset_Type - The column_guid of this GsaUpdateTabularColumnTypeAttributeErrorDetail. - """ - # Field is not nullable - if column_guid is None: - raise ValueError("Invalid value for 'column_guid', must not be 'None'") - self._column_guid = column_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateTabularColumnTypeAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_exception.py deleted file mode 100644 index e52da18b..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_exception.py +++ /dev/null @@ -1,311 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpgradeDatabaseException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "upgrade_database_failure_reason": "GsaUpgradeDatabaseFailureReason", - "additional_information": "str", - "code": "GsaErrorCode", - "errors": "list[GsaErrorDetailOfUpgradeDatabaseFailureReason]", - "message": "str", - "status_code": "SystemNetHttpStatusCode", - } - - attribute_map: dict[str, str] = { - "upgrade_database_failure_reason": "upgradeDatabaseFailureReason", - "additional_information": "additionalInformation", - "code": "code", - "errors": "errors", - "message": "message", - "status_code": "statusCode", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "upgradeDatabaseFailureReason": "GsaUpgradeDatabaseFailureReason", - "statusCode": "SystemNetHttpStatusCode", - "errors": "GsaErrorDetailOfUpgradeDatabaseFailureReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - upgrade_database_failure_reason: "GsaUpgradeDatabaseFailureReason", - additional_information: "str | None | Unset_Type" = Unset, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaErrorDetailOfUpgradeDatabaseFailureReason] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - status_code: "SystemNetHttpStatusCode | Unset_Type" = Unset, - ) -> None: - """GsaUpgradeDatabaseException - a model defined in Swagger - - Parameters - ---------- - upgrade_database_failure_reason: GsaUpgradeDatabaseFailureReason - additional_information: str | None, optional - code: GsaErrorCode, optional - errors: list[GsaErrorDetailOfUpgradeDatabaseFailureReason] | None, optional - message: str | None, optional - status_code: SystemNetHttpStatusCode, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._upgrade_database_failure_reason: GsaUpgradeDatabaseFailureReason - self._additional_information: str | None | Unset_Type = Unset - self._status_code: SystemNetHttpStatusCode | Unset_Type = Unset - self._errors: list[GsaErrorDetailOfUpgradeDatabaseFailureReason] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.upgrade_database_failure_reason = upgrade_database_failure_reason - if additional_information is not Unset: - self.additional_information = additional_information - if status_code is not Unset: - self.status_code = status_code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaUpgradeDatabaseException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaUpgradeDatabaseException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaUpgradeDatabaseException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaUpgradeDatabaseException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaUpgradeDatabaseException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaUpgradeDatabaseException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaUpgradeDatabaseException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaUpgradeDatabaseException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def upgrade_database_failure_reason(self) -> "GsaUpgradeDatabaseFailureReason": - """Gets the upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - - Returns - ------- - GsaUpgradeDatabaseFailureReason - The upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - """ - return self._upgrade_database_failure_reason - - @upgrade_database_failure_reason.setter - def upgrade_database_failure_reason( - self, upgrade_database_failure_reason: "GsaUpgradeDatabaseFailureReason" - ) -> None: - """Sets the upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - - Parameters - ---------- - upgrade_database_failure_reason: GsaUpgradeDatabaseFailureReason - The upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - """ - # Field is not nullable - if upgrade_database_failure_reason is None: - raise ValueError( - "Invalid value for 'upgrade_database_failure_reason', must not be 'None'" - ) - # Field is required - if upgrade_database_failure_reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'upgrade_database_failure_reason', must not be 'Unset'" - ) - self._upgrade_database_failure_reason = upgrade_database_failure_reason - - @property - def additional_information(self) -> "str | None | Unset_Type": - """Gets the additional_information of this GsaUpgradeDatabaseException. - - Returns - ------- - str | None | Unset_Type - The additional_information of this GsaUpgradeDatabaseException. - """ - return self._additional_information - - @additional_information.setter - def additional_information(self, additional_information: "str | None | Unset_Type") -> None: - """Sets the additional_information of this GsaUpgradeDatabaseException. - - Parameters - ---------- - additional_information: str | None | Unset_Type - The additional_information of this GsaUpgradeDatabaseException. - """ - self._additional_information = additional_information - - @property - def status_code(self) -> "SystemNetHttpStatusCode | Unset_Type": - """Gets the status_code of this GsaUpgradeDatabaseException. - - Returns - ------- - SystemNetHttpStatusCode | Unset_Type - The status_code of this GsaUpgradeDatabaseException. - """ - return self._status_code - - @status_code.setter - def status_code(self, status_code: "SystemNetHttpStatusCode | Unset_Type") -> None: - """Sets the status_code of this GsaUpgradeDatabaseException. - - Parameters - ---------- - status_code: SystemNetHttpStatusCode | Unset_Type - The status_code of this GsaUpgradeDatabaseException. - """ - # Field is not nullable - if status_code is None: - raise ValueError("Invalid value for 'status_code', must not be 'None'") - self._status_code = status_code - - @property - def errors(self) -> "list[GsaErrorDetailOfUpgradeDatabaseFailureReason] | None | Unset_Type": - """Gets the errors of this GsaUpgradeDatabaseException. - - Returns - ------- - list[GsaErrorDetailOfUpgradeDatabaseFailureReason] | None | Unset_Type - The errors of this GsaUpgradeDatabaseException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaErrorDetailOfUpgradeDatabaseFailureReason] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaUpgradeDatabaseException. - - Parameters - ---------- - errors: list[GsaErrorDetailOfUpgradeDatabaseFailureReason] | None | Unset_Type - The errors of this GsaUpgradeDatabaseException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpgradeDatabaseException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_failure_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_failure_reason.py deleted file mode 100644 index 0bbc3f15..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_upgrade_database_failure_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUpgradeDatabaseFailureReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNABLETOCONNECT = "unableToConnect" - INSUFFICIENTPERMISSIONS = "insufficientPermissions" - UNKNOWNERROR = "unknownError" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_usage_data_modification_error_detail.py index 230f5332..a0efd0fb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_usage_data_modification_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_usage_data_modification_error_detail.py @@ -88,7 +88,7 @@ class GsaUsageDataModificationErrorDetail(GsaDataModificationErrorDetail): discriminator_value_class_map = { "expression".lower(): "#/components/schemas/GsaExpressionUsageDataModificationErrorDetail", "versionControlledData".lower(): "#/components/schemas/GsaVersionControlledDataUsageDataModificationErrorDetail", - "smartLinkGroup".lower(): "#/components/schemas/GsaSmartLinkGroupUsageDataModificationErrorDetail", + "dynamicLinkGroup".lower(): "#/components/schemas/GsaDynamicLinkGroupUsageDataModificationErrorDetail", "tabularAttribute".lower(): "#/components/schemas/GsaTabularAttributeUsageDataModificationErrorDetail", "xyChartTemplate".lower(): "#/components/schemas/GsaXYChartTemplateUsageDataModificationErrorDetail", "searchMask".lower(): "#/components/schemas/GsaSearchMaskUsageDataModificationErrorDetail", @@ -96,14 +96,6 @@ class GsaUsageDataModificationErrorDetail(GsaDataModificationErrorDetail): "attribute".lower(): "#/components/schemas/GsaAttributeUsageDataModificationErrorDetail", "data".lower(): "#/components/schemas/GsaDataUsageDataModificationErrorDetail", "defaultParameterValue".lower(): "#/components/schemas/GsaDefaultParameterValueUsageDataModificationErrorDetail", - "functionalDataDefault".lower(): "#/components/schemas/GsaFunctionalDataDefaultUsageDataModificationErrorDetail", - "multiValuedPointData".lower(): "#/components/schemas/GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "tabularColumn".lower(): "#/components/schemas/GsaTabularColumnUsageDataModificationErrorDetail", - "databaseCurrencyUnit".lower(): "#/components/schemas/GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "unit".lower(): "#/components/schemas/GsaUnitUsageDataModificationErrorDetail", - "parameter".lower(): "#/components/schemas/GsaParameterUsageDataModificationErrorDetail", - "constant".lower(): "#/components/schemas/GsaConstantUsageDataModificationErrorDetail", - "table".lower(): "#/components/schemas/GsaTableUsageDataModificationErrorDetail", } discriminator: Optional[str] = "referenced_by_type" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_user_capabilities.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_user_capabilities.py deleted file mode 100644 index 4b87125f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_user_capabilities.py +++ /dev/null @@ -1,185 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUserCapabilities(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "can_read": "bool", - "can_write": "bool", - } - - attribute_map: dict[str, str] = { - "can_read": "canRead", - "can_write": "canWrite", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - can_read: "bool", - can_write: "bool", - ) -> None: - """GsaUserCapabilities - a model defined in Swagger - - Parameters - ---------- - can_read: bool - can_write: bool - """ - self._can_read: bool - self._can_write: bool - - self.can_read = can_read - self.can_write = can_write - - @property - def can_read(self) -> "bool": - """Gets the can_read of this GsaUserCapabilities. - Specifies whether the current user can read. - - Returns - ------- - bool - The can_read of this GsaUserCapabilities. - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read: "bool") -> None: - """Sets the can_read of this GsaUserCapabilities. - Specifies whether the current user can read. - - Parameters - ---------- - can_read: bool - The can_read of this GsaUserCapabilities. - """ - # Field is not nullable - if can_read is None: - raise ValueError("Invalid value for 'can_read', must not be 'None'") - # Field is required - if can_read is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_read', must not be 'Unset'") - self._can_read = can_read - - @property - def can_write(self) -> "bool": - """Gets the can_write of this GsaUserCapabilities. - Specifies whether the current user can write. - - Returns - ------- - bool - The can_write of this GsaUserCapabilities. - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write: "bool") -> None: - """Sets the can_write of this GsaUserCapabilities. - Specifies whether the current user can write. - - Parameters - ---------- - can_write: bool - The can_write of this GsaUserCapabilities. - """ - # Field is not nullable - if can_write is None: - raise ValueError("Invalid value for 'can_write', must not be 'None'") - # Field is required - if can_write is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_write', must not be 'Unset'") - self._can_write = can_write - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUserCapabilities): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_user_or_group.py similarity index 65% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_chart_data.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_user_or_group.py index a3745f3f..c11cf7bf 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_discrete_chart_data.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_user_or_group.py @@ -33,11 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_chart_data_type import GsaChartDataType - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -47,7 +42,7 @@ from . import * -class GsaDiscreteChartData(GsaChartData): +class GsaUserOrGroup(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -66,19 +61,15 @@ class GsaDiscreteChartData(GsaChartData): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", + "display_name": "str", + "identifier": "str", "name": "str", - "order": "int", - "record_version_guid": "str", } attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", + "display_name": "displayName", + "identifier": "identifier", "name": "name", - "order": "order", - "record_version_guid": "recordVersionGuid", } subtype_mapping: dict[str, str] = {} @@ -88,77 +79,95 @@ class GsaDiscreteChartData(GsaChartData): def __init__( self, *, - type: "GsaChartDataType" = GsaChartDataType.DISCRETE, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, + display_name: "str | None | Unset_Type" = Unset, + identifier: "str | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - order: "int | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, ) -> None: - """GsaDiscreteChartData - a model defined in Swagger + """GsaUserOrGroup - a model defined in Swagger Parameters ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional + display_name: str | None, optional + identifier: str, optional name: str | None, optional - order: int, optional - record_version_guid: str, optional """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._order: int | Unset_Type = Unset + self._identifier: str | Unset_Type = Unset + self._display_name: str | None | Unset_Type = Unset self._name: str | None | Unset_Type = Unset - if order is not Unset: - self.order = order + if identifier is not Unset: + self.identifier = identifier + if display_name is not Unset: + self.display_name = display_name if name is not Unset: self.name = name @property - def order(self) -> "int | Unset_Type": - """Gets the order of this GsaDiscreteChartData. + def identifier(self) -> "str | Unset_Type": + """Gets the identifier of this GsaUserOrGroup. Returns ------- - int | Unset_Type - The order of this GsaDiscreteChartData. + str | Unset_Type + The identifier of this GsaUserOrGroup. """ - return self._order + return self._identifier - @order.setter - def order(self, order: "int | Unset_Type") -> None: - """Sets the order of this GsaDiscreteChartData. + @identifier.setter + def identifier(self, identifier: "str | Unset_Type") -> None: + """Sets the identifier of this GsaUserOrGroup. Parameters ---------- - order: int | Unset_Type - The order of this GsaDiscreteChartData. + identifier: str | Unset_Type + The identifier of this GsaUserOrGroup. """ # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - self._order = order + if identifier is None: + raise ValueError("Invalid value for 'identifier', must not be 'None'") + self._identifier = identifier + + @property + def display_name(self) -> "str | None | Unset_Type": + """Gets the display_name of this GsaUserOrGroup. + + Returns + ------- + str | None | Unset_Type + The display_name of this GsaUserOrGroup. + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name: "str | None | Unset_Type") -> None: + """Sets the display_name of this GsaUserOrGroup. + + Parameters + ---------- + display_name: str | None | Unset_Type + The display_name of this GsaUserOrGroup. + """ + self._display_name = display_name @property def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaDiscreteChartData. + """Gets the name of this GsaUserOrGroup. Returns ------- str | None | Unset_Type - The name of this GsaDiscreteChartData. + The name of this GsaUserOrGroup. """ return self._name @name.setter def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaDiscreteChartData. + """Sets the name of this GsaUserOrGroup. Parameters ---------- name: str | None | Unset_Type - The name of this GsaDiscreteChartData. + The name of this GsaUserOrGroup. """ self._name = name @@ -184,7 +193,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteChartData): + if not isinstance(other, GsaUserOrGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_request.py deleted file mode 100644 index b1010fe7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaValidateUnitEquationRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "equation": "str", - } - - attribute_map: dict[str, str] = { - "equation": "equation", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - equation: "str", - ) -> None: - """GsaValidateUnitEquationRequest - a model defined in Swagger - - Parameters - ---------- - equation: str - """ - self._equation: str - - self.equation = equation - - @property - def equation(self) -> "str": - """Gets the equation of this GsaValidateUnitEquationRequest. - The equation to check - - Returns - ------- - str - The equation of this GsaValidateUnitEquationRequest. - """ - return self._equation - - @equation.setter - def equation(self, equation: "str") -> None: - """Sets the equation of this GsaValidateUnitEquationRequest. - The equation to check - - Parameters - ---------- - equation: str - The equation of this GsaValidateUnitEquationRequest. - """ - # Field is not nullable - if equation is None: - raise ValueError("Invalid value for 'equation', must not be 'None'") - # Field is required - if equation is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'equation', must not be 'Unset'") - self._equation = equation - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaValidateUnitEquationRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_response.py deleted file mode 100644 index 82c19c6a..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_validate_unit_equation_response.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaValidateUnitEquationResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaUnitEquationErrorDetail]", - "is_valid": "bool", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "is_valid": "isValid", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaUnitEquationErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaUnitEquationErrorDetail]", - is_valid: "bool | Unset_Type" = Unset, - ) -> None: - """GsaValidateUnitEquationResponse - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaUnitEquationErrorDetail] - is_valid: bool, optional - """ - self._is_valid: bool | Unset_Type = Unset - self._errors: list[GsaUnitEquationErrorDetail] - - if is_valid is not Unset: - self.is_valid = is_valid - self.errors = errors - - @property - def is_valid(self) -> "bool | Unset_Type": - """Gets the is_valid of this GsaValidateUnitEquationResponse. - - Returns - ------- - bool | Unset_Type - The is_valid of this GsaValidateUnitEquationResponse. - """ - return self._is_valid - - @is_valid.setter - def is_valid(self, is_valid: "bool | Unset_Type") -> None: - """Sets the is_valid of this GsaValidateUnitEquationResponse. - - Parameters - ---------- - is_valid: bool | Unset_Type - The is_valid of this GsaValidateUnitEquationResponse. - """ - # Field is not nullable - if is_valid is None: - raise ValueError("Invalid value for 'is_valid', must not be 'None'") - self._is_valid = is_valid - - @property - def errors(self) -> "list[GsaUnitEquationErrorDetail]": - """Gets the errors of this GsaValidateUnitEquationResponse. - Details of any errors found in the equation. - - Returns - ------- - list[GsaUnitEquationErrorDetail] - The errors of this GsaValidateUnitEquationResponse. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquationErrorDetail]") -> None: - """Sets the errors of this GsaValidateUnitEquationResponse. - Details of any errors found in the equation. - - Parameters - ---------- - errors: list[GsaUnitEquationErrorDetail] - The errors of this GsaValidateUnitEquationResponse. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaValidateUnitEquationResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_value_not_provided_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_value_not_provided_parameter_value_error_detail.py deleted file mode 100644 index 2dcb2f3e..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_value_not_provided_parameter_value_error_detail.py +++ /dev/null @@ -1,187 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2027r1.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaValueNotProvidedParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.VALUENOTPROVIDED, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaValueNotProvidedParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - guid: str | None, optional - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaValueNotProvidedParameterValueErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaValueNotProvidedParameterValueErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaValueNotProvidedParameterValueErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaValueNotProvidedParameterValueErrorDetail. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaValueNotProvidedParameterValueErrorDetail. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaValueNotProvidedParameterValueErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaValueNotProvidedParameterValueErrorDetail. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaValueNotProvidedParameterValueErrorDetail. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaValueNotProvidedParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_detail.py index 82db3737..8d7f08fb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_detail.py @@ -64,7 +64,7 @@ class GsaVersionControlErrorDetail(ModelBase): """ swagger_types: dict[str, str] = { "message": "str", - "reason": "GsaVersionControlErrorReason", + "reason": "str", } attribute_map: dict[str, str] = { @@ -72,9 +72,7 @@ class GsaVersionControlErrorDetail(ModelBase): "reason": "reason", } - subtype_mapping: dict[str, str] = { - "reason": "GsaVersionControlErrorReason", - } + subtype_mapping: dict[str, str] = {} discriminator_value_class_map = { "invalidVersionState".lower(): "#/components/schemas/GsaInvalidVersionStateErrorDetail", @@ -89,17 +87,17 @@ def __init__( self, *, message: "str", - reason: "GsaVersionControlErrorReason", + reason: "str", ) -> None: """GsaVersionControlErrorDetail - a model defined in Swagger Parameters ---------- message: str - reason: GsaVersionControlErrorReason + reason: str """ self._message: str - self._reason: GsaVersionControlErrorReason + self._reason: str self.message = message self.reason = reason @@ -133,23 +131,23 @@ def message(self, message: "str") -> None: self._message = message @property - def reason(self) -> "GsaVersionControlErrorReason": + def reason(self) -> "str": """Gets the reason of this GsaVersionControlErrorDetail. Returns ------- - GsaVersionControlErrorReason + str The reason of this GsaVersionControlErrorDetail. """ return self._reason @reason.setter - def reason(self, reason: "GsaVersionControlErrorReason") -> None: + def reason(self, reason: "str") -> None: """Sets the reason of this GsaVersionControlErrorDetail. Parameters ---------- - reason: GsaVersionControlErrorReason + reason: str The reason of this GsaVersionControlErrorDetail. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_reason.py deleted file mode 100644 index 20b51ab7..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_error_reason.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaVersionControlErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - INVALIDVERSIONSTATE = "invalidVersionState" - NOTVERSIONED = "notVersioned" - INVALIDPARENTSTATE = "invalidParentState" - NOTTHELATESTVERSION = "notTheLatestVersion" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_mode.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_mode.py deleted file mode 100644 index 65d9506f..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_version_control_mode.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaVersionControlMode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - READ = "read" - WRITE = "write" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_weighting_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_weighting_type.py deleted file mode 100644 index f0aec038..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_weighting_type.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaWeightingType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - POS_0 = 0 - POS_1 = 1 - POS_2 = 2 diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_withdraw_record_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_withdraw_record_version_control_exception.py index c78c350d..cbb91faa 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_withdraw_record_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_withdraw_record_version_control_exception.py @@ -61,21 +61,19 @@ class GsaWithdrawRecordVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", - "record_version_guid": "str", } attribute_map: dict[str, str] = { "code": "code", "errors": "errors", "message": "message", - "record_version_guid": "recordVersionGuid", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -84,31 +82,26 @@ class GsaWithdrawRecordVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, ) -> None: """GsaWithdrawRecordVersionControlException - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional - record_version_guid: str, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._record_version_guid: str | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - if record_version_guid is not Unset: - self.record_version_guid = record_version_guid if errors is not Unset: self.errors = errors @@ -135,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaWithdrawRecordVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaWithdrawRecordVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaWithdrawRecordVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaWithdrawRecordVersionControlException. """ # Field is not nullable @@ -159,31 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def record_version_guid(self) -> "str | Unset_Type": - """Gets the record_version_guid of this GsaWithdrawRecordVersionControlException. - - Returns - ------- - str | Unset_Type - The record_version_guid of this GsaWithdrawRecordVersionControlException. - """ - return self._record_version_guid - - @record_version_guid.setter - def record_version_guid(self, record_version_guid: "str | Unset_Type") -> None: - """Sets the record_version_guid of this GsaWithdrawRecordVersionControlException. - - Parameters - ---------- - record_version_guid: str | Unset_Type - The record_version_guid of this GsaWithdrawRecordVersionControlException. - """ - # Field is not nullable - if record_version_guid is None: - raise ValueError("Invalid value for 'record_version_guid', must not be 'None'") - self._record_version_guid = record_version_guid - @property def errors(self) -> "list[GsaVersionControlErrorDetail] | None | Unset_Type": """Gets the errors of this GsaWithdrawRecordVersionControlException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_template.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_template.py deleted file mode 100644 index ca09f070..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_template.py +++ /dev/null @@ -1,438 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaXYChartTemplate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "chart_title": "str", - "description": "str", - "parameter_values": "list[GsaParameterValue]", - "table_guid": "str", - "use_template_parameters": "bool", - "x_axis": "GsaXYTemplateAxis", - "y_axis": "GsaXYTemplateAxis", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "chart_title": "chartTitle", - "description": "description", - "parameter_values": "parameterValues", - "table_guid": "tableGuid", - "use_template_parameters": "useTemplateParameters", - "x_axis": "xAxis", - "y_axis": "yAxis", - } - - subtype_mapping: dict[str, str] = { - "xAxis": "GsaXYTemplateAxis", - "yAxis": "GsaXYTemplateAxis", - "parameterValues": "GsaParameterValue", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - name: "str", - chart_title: "str | None | Unset_Type" = Unset, - description: "str | None | Unset_Type" = Unset, - parameter_values: "list[GsaParameterValue] | None | Unset_Type" = Unset, - table_guid: "str | Unset_Type" = Unset, - use_template_parameters: "bool | Unset_Type" = Unset, - x_axis: "GsaXYTemplateAxis | Unset_Type" = Unset, - y_axis: "GsaXYTemplateAxis | Unset_Type" = Unset, - ) -> None: - """GsaXYChartTemplate - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - name: str - chart_title: str | None, optional - description: str | None, optional - parameter_values: list[GsaParameterValue] | None, optional - table_guid: str, optional - use_template_parameters: bool, optional - x_axis: GsaXYTemplateAxis, optional - y_axis: GsaXYTemplateAxis, optional - """ - self._chart_title: str | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._table_guid: str | Unset_Type = Unset - self._x_axis: GsaXYTemplateAxis | Unset_Type = Unset - self._y_axis: GsaXYTemplateAxis | Unset_Type = Unset - self._use_template_parameters: bool | Unset_Type = Unset - self._parameter_values: list[GsaParameterValue] | None | Unset_Type = Unset - self._display_names: dict[str, str] - self._name: str - self._guid: str - - if chart_title is not Unset: - self.chart_title = chart_title - if description is not Unset: - self.description = description - if table_guid is not Unset: - self.table_guid = table_guid - if x_axis is not Unset: - self.x_axis = x_axis - if y_axis is not Unset: - self.y_axis = y_axis - if use_template_parameters is not Unset: - self.use_template_parameters = use_template_parameters - if parameter_values is not Unset: - self.parameter_values = parameter_values - self.display_names = display_names - self.name = name - self.guid = guid - - @property - def chart_title(self) -> "str | None | Unset_Type": - """Gets the chart_title of this GsaXYChartTemplate. - - Returns - ------- - str | None | Unset_Type - The chart_title of this GsaXYChartTemplate. - """ - return self._chart_title - - @chart_title.setter - def chart_title(self, chart_title: "str | None | Unset_Type") -> None: - """Sets the chart_title of this GsaXYChartTemplate. - - Parameters - ---------- - chart_title: str | None | Unset_Type - The chart_title of this GsaXYChartTemplate. - """ - self._chart_title = chart_title - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaXYChartTemplate. - - Returns - ------- - str | None | Unset_Type - The description of this GsaXYChartTemplate. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaXYChartTemplate. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaXYChartTemplate. - """ - self._description = description - - @property - def table_guid(self) -> "str | Unset_Type": - """Gets the table_guid of this GsaXYChartTemplate. - - Returns - ------- - str | Unset_Type - The table_guid of this GsaXYChartTemplate. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | Unset_Type") -> None: - """Sets the table_guid of this GsaXYChartTemplate. - - Parameters - ---------- - table_guid: str | Unset_Type - The table_guid of this GsaXYChartTemplate. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - self._table_guid = table_guid - - @property - def x_axis(self) -> "GsaXYTemplateAxis | Unset_Type": - """Gets the x_axis of this GsaXYChartTemplate. - - Returns - ------- - GsaXYTemplateAxis | Unset_Type - The x_axis of this GsaXYChartTemplate. - """ - return self._x_axis - - @x_axis.setter - def x_axis(self, x_axis: "GsaXYTemplateAxis | Unset_Type") -> None: - """Sets the x_axis of this GsaXYChartTemplate. - - Parameters - ---------- - x_axis: GsaXYTemplateAxis | Unset_Type - The x_axis of this GsaXYChartTemplate. - """ - # Field is not nullable - if x_axis is None: - raise ValueError("Invalid value for 'x_axis', must not be 'None'") - self._x_axis = x_axis - - @property - def y_axis(self) -> "GsaXYTemplateAxis | Unset_Type": - """Gets the y_axis of this GsaXYChartTemplate. - - Returns - ------- - GsaXYTemplateAxis | Unset_Type - The y_axis of this GsaXYChartTemplate. - """ - return self._y_axis - - @y_axis.setter - def y_axis(self, y_axis: "GsaXYTemplateAxis | Unset_Type") -> None: - """Sets the y_axis of this GsaXYChartTemplate. - - Parameters - ---------- - y_axis: GsaXYTemplateAxis | Unset_Type - The y_axis of this GsaXYChartTemplate. - """ - # Field is not nullable - if y_axis is None: - raise ValueError("Invalid value for 'y_axis', must not be 'None'") - self._y_axis = y_axis - - @property - def use_template_parameters(self) -> "bool | Unset_Type": - """Gets the use_template_parameters of this GsaXYChartTemplate. - - Returns - ------- - bool | Unset_Type - The use_template_parameters of this GsaXYChartTemplate. - """ - return self._use_template_parameters - - @use_template_parameters.setter - def use_template_parameters(self, use_template_parameters: "bool | Unset_Type") -> None: - """Sets the use_template_parameters of this GsaXYChartTemplate. - - Parameters - ---------- - use_template_parameters: bool | Unset_Type - The use_template_parameters of this GsaXYChartTemplate. - """ - # Field is not nullable - if use_template_parameters is None: - raise ValueError("Invalid value for 'use_template_parameters', must not be 'None'") - self._use_template_parameters = use_template_parameters - - @property - def parameter_values(self) -> "list[GsaParameterValue] | None | Unset_Type": - """Gets the parameter_values of this GsaXYChartTemplate. - - Returns - ------- - list[GsaParameterValue] | None | Unset_Type - The parameter_values of this GsaXYChartTemplate. - """ - return self._parameter_values - - @parameter_values.setter - def parameter_values( - self, parameter_values: "list[GsaParameterValue] | None | Unset_Type" - ) -> None: - """Sets the parameter_values of this GsaXYChartTemplate. - - Parameters - ---------- - parameter_values: list[GsaParameterValue] | None | Unset_Type - The parameter_values of this GsaXYChartTemplate. - """ - self._parameter_values = parameter_values - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaXYChartTemplate. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaXYChartTemplate. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaXYChartTemplate. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaXYChartTemplate. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def name(self) -> "str": - """Gets the name of this GsaXYChartTemplate. - - Returns - ------- - str - The name of this GsaXYChartTemplate. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaXYChartTemplate. - - Parameters - ---------- - name: str - The name of this GsaXYChartTemplate. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaXYChartTemplate. - - Returns - ------- - str - The guid of this GsaXYChartTemplate. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaXYChartTemplate. - - Parameters - ---------- - guid: str - The guid of this GsaXYChartTemplate. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaXYChartTemplate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_templates_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_templates_info.py deleted file mode 100644 index 8a685ff6..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_chart_templates_info.py +++ /dev/null @@ -1,219 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaXYChartTemplatesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entries": "list[GsaXYChartTemplate]", - "item_type": "GsaPaginatedItemType", - "links": "GsaPaginationLinks", - } - - attribute_map: dict[str, str] = { - "entries": "entries", - "item_type": "itemType", - "links": "links", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaPaginatedItemType", - "entries": "GsaXYChartTemplate", - "links": "GsaPaginationLinks", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entries: "list[GsaXYChartTemplate]", - item_type: "GsaPaginatedItemType", - links: "GsaPaginationLinks", - ) -> None: - """GsaXYChartTemplatesInfo - a model defined in Swagger - - Parameters - ---------- - entries: list[GsaXYChartTemplate] - item_type: GsaPaginatedItemType - links: GsaPaginationLinks - """ - self._item_type: GsaPaginatedItemType - self._entries: list[GsaXYChartTemplate] - self._links: GsaPaginationLinks - - self.item_type = item_type - self.entries = entries - self.links = links - - @property - def item_type(self) -> "GsaPaginatedItemType": - """Gets the item_type of this GsaXYChartTemplatesInfo. - - Returns - ------- - GsaPaginatedItemType - The item_type of this GsaXYChartTemplatesInfo. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaPaginatedItemType") -> None: - """Sets the item_type of this GsaXYChartTemplatesInfo. - - Parameters - ---------- - item_type: GsaPaginatedItemType - The item_type of this GsaXYChartTemplatesInfo. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def entries(self) -> "list[GsaXYChartTemplate]": - """Gets the entries of this GsaXYChartTemplatesInfo. - - Returns - ------- - list[GsaXYChartTemplate] - The entries of this GsaXYChartTemplatesInfo. - """ - return self._entries - - @entries.setter - def entries(self, entries: "list[GsaXYChartTemplate]") -> None: - """Sets the entries of this GsaXYChartTemplatesInfo. - - Parameters - ---------- - entries: list[GsaXYChartTemplate] - The entries of this GsaXYChartTemplatesInfo. - """ - # Field is not nullable - if entries is None: - raise ValueError("Invalid value for 'entries', must not be 'None'") - # Field is required - if entries is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entries', must not be 'Unset'") - self._entries = entries - - @property - def links(self) -> "GsaPaginationLinks": - """Gets the links of this GsaXYChartTemplatesInfo. - - Returns - ------- - GsaPaginationLinks - The links of this GsaXYChartTemplatesInfo. - """ - return self._links - - @links.setter - def links(self, links: "GsaPaginationLinks") -> None: - """Sets the links of this GsaXYChartTemplatesInfo. - - Parameters - ---------- - links: GsaPaginationLinks - The links of this GsaXYChartTemplatesInfo. - """ - # Field is not nullable - if links is None: - raise ValueError("Invalid value for 'links', must not be 'None'") - # Field is required - if links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'links', must not be 'Unset'") - self._links = links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaXYChartTemplatesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_template_axis.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_template_axis.py deleted file mode 100644 index 6a3b7261..00000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2027r1/models/gsa_xy_template_axis.py +++ /dev/null @@ -1,344 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaXYTemplateAxis(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "attribute_guid": "str", - "attribute_unit": "GsaUnit", - "auto_scale": "bool", - "bounds": "GsaDataExportRange", - "logarithmic": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "attribute_guid": "attributeGuid", - "attribute_unit": "attributeUnit", - "auto_scale": "autoScale", - "bounds": "bounds", - "logarithmic": "logarithmic", - } - - subtype_mapping: dict[str, str] = { - "bounds": "GsaDataExportRange", - "attributeUnit": "GsaUnit", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - attribute_guid: "str | Unset_Type" = Unset, - attribute_unit: "GsaUnit | Unset_Type" = Unset, - auto_scale: "bool | Unset_Type" = Unset, - bounds: "GsaDataExportRange | Unset_Type" = Unset, - logarithmic: "bool | Unset_Type" = Unset, - ) -> None: - """GsaXYTemplateAxis - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - attribute_guid: str, optional - attribute_unit: GsaUnit, optional - auto_scale: bool, optional - bounds: GsaDataExportRange, optional - logarithmic: bool, optional - """ - self._attribute_guid: str | Unset_Type = Unset - self._logarithmic: bool | Unset_Type = Unset - self._bounds: GsaDataExportRange | Unset_Type = Unset - self._attribute_unit: GsaUnit | Unset_Type = Unset - self._auto_scale: bool | Unset_Type = Unset - self._name: str - self._guid: str - - if attribute_guid is not Unset: - self.attribute_guid = attribute_guid - if logarithmic is not Unset: - self.logarithmic = logarithmic - if bounds is not Unset: - self.bounds = bounds - if attribute_unit is not Unset: - self.attribute_unit = attribute_unit - if auto_scale is not Unset: - self.auto_scale = auto_scale - self.name = name - self.guid = guid - - @property - def attribute_guid(self) -> "str | Unset_Type": - """Gets the attribute_guid of this GsaXYTemplateAxis. - - Returns - ------- - str | Unset_Type - The attribute_guid of this GsaXYTemplateAxis. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str | Unset_Type") -> None: - """Sets the attribute_guid of this GsaXYTemplateAxis. - - Parameters - ---------- - attribute_guid: str | Unset_Type - The attribute_guid of this GsaXYTemplateAxis. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - self._attribute_guid = attribute_guid - - @property - def logarithmic(self) -> "bool | Unset_Type": - """Gets the logarithmic of this GsaXYTemplateAxis. - - Returns - ------- - bool | Unset_Type - The logarithmic of this GsaXYTemplateAxis. - """ - return self._logarithmic - - @logarithmic.setter - def logarithmic(self, logarithmic: "bool | Unset_Type") -> None: - """Sets the logarithmic of this GsaXYTemplateAxis. - - Parameters - ---------- - logarithmic: bool | Unset_Type - The logarithmic of this GsaXYTemplateAxis. - """ - # Field is not nullable - if logarithmic is None: - raise ValueError("Invalid value for 'logarithmic', must not be 'None'") - self._logarithmic = logarithmic - - @property - def bounds(self) -> "GsaDataExportRange | Unset_Type": - """Gets the bounds of this GsaXYTemplateAxis. - - Returns - ------- - GsaDataExportRange | Unset_Type - The bounds of this GsaXYTemplateAxis. - """ - return self._bounds - - @bounds.setter - def bounds(self, bounds: "GsaDataExportRange | Unset_Type") -> None: - """Sets the bounds of this GsaXYTemplateAxis. - - Parameters - ---------- - bounds: GsaDataExportRange | Unset_Type - The bounds of this GsaXYTemplateAxis. - """ - # Field is not nullable - if bounds is None: - raise ValueError("Invalid value for 'bounds', must not be 'None'") - self._bounds = bounds - - @property - def attribute_unit(self) -> "GsaUnit | Unset_Type": - """Gets the attribute_unit of this GsaXYTemplateAxis. - - Returns - ------- - GsaUnit | Unset_Type - The attribute_unit of this GsaXYTemplateAxis. - """ - return self._attribute_unit - - @attribute_unit.setter - def attribute_unit(self, attribute_unit: "GsaUnit | Unset_Type") -> None: - """Sets the attribute_unit of this GsaXYTemplateAxis. - - Parameters - ---------- - attribute_unit: GsaUnit | Unset_Type - The attribute_unit of this GsaXYTemplateAxis. - """ - # Field is not nullable - if attribute_unit is None: - raise ValueError("Invalid value for 'attribute_unit', must not be 'None'") - self._attribute_unit = attribute_unit - - @property - def auto_scale(self) -> "bool | Unset_Type": - """Gets the auto_scale of this GsaXYTemplateAxis. - - Returns - ------- - bool | Unset_Type - The auto_scale of this GsaXYTemplateAxis. - """ - return self._auto_scale - - @auto_scale.setter - def auto_scale(self, auto_scale: "bool | Unset_Type") -> None: - """Sets the auto_scale of this GsaXYTemplateAxis. - - Parameters - ---------- - auto_scale: bool | Unset_Type - The auto_scale of this GsaXYTemplateAxis. - """ - # Field is not nullable - if auto_scale is None: - raise ValueError("Invalid value for 'auto_scale', must not be 'None'") - self._auto_scale = auto_scale - - @property - def name(self) -> "str": - """Gets the name of this GsaXYTemplateAxis. - - Returns - ------- - str - The name of this GsaXYTemplateAxis. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaXYTemplateAxis. - - Parameters - ---------- - name: str - The name of this GsaXYTemplateAxis. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaXYTemplateAxis. - - Returns - ------- - str - The guid of this GsaXYTemplateAxis. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaXYTemplateAxis. - - Parameters - ---------- - guid: str - The guid of this GsaXYTemplateAxis. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaXYTemplateAxis): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/uv.lock b/ansys-grantami-serverapi-openapi/uv.lock index 685144f1..247ac8ad 100644 --- a/ansys-grantami-serverapi-openapi/uv.lock +++ b/ansys-grantami-serverapi-openapi/uv.lock @@ -8,7 +8,7 @@ resolution-markers = [ [[package]] name = "ansys-grantami-serverapi-openapi" -version = "6.0.0.dev1333" +version = "6.0.0.dev1338" source = { editable = "." } dependencies = [ { name = "ansys-openapi-common" },